michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[docs] deprecate build.split and build.excludeMiddleware in config ref (#8158)

Browse source
This commit is contained in:
Sarah Rainsberger 2023-08-21 10:33:32 -03:00 committed by GitHub
parent 1f54deff22
commit d44052141b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
packages/astro/src/@types/astro.ts
View file

@ -856,22 +856,12 @@ export interface AstroUserConfig {
* @name build.split
* @type {boolean}
* @default `false`
* @version 2.7.0
* @deprecated since version 3.0
* @description
* Defines how the SSR code should be bundled when built.
* The build config option `build.split` has been replaced by the adapter configuration option [`functionPerRoute`](/en/reference/adapter-reference/#functionperroute).
*
* When `split` is `true`, Astro will emit a file for each page.
* Each file emitted will render only one page. The pages will be emitted
* inside a `dist/pages/` directory, and the emitted files will keep the same file paths
* of the `src/pages` directory.
*
* ```js
* {
* build: {
* split: true
* }
* }
* ```
* Please see your [SSR adapter's documentation](/en/guides/integrations-guide/#official-integrations) for using `functionPerRoute` to define how your SSR code is bundled.
*
*/
split?: boolean;
@ -880,19 +870,11 @@ export interface AstroUserConfig {
* @name build.excludeMiddleware
* @type {boolean}
* @default `false`
* @version 2.8.0
* @deprecated since version 3.0
* @description
* Defines whether or not any SSR middleware code will be bundled when built.
* The build config option `build.excludeMiddleware` has been replaced by the adapter configuration option [`edgeMiddleware`](/en/reference/adapter-reference/#edgemiddleware).
*
* When enabled, middleware code is not bundled and imported by all pages during the build. To instead execute and import middleware code manually, set `build.excludeMiddleware: true`:
*
* ```js
* {
* build: {
* excludeMiddleware: true
* }
* }
* ```
* Please see your [SSR adapter's documentation](/en/guides/integrations-guide/#official-integrations) for using `edgeMiddleware` to define whether or not any SSR middleware code will be bundled when built.
*/
excludeMiddleware?: boolean;
};