78 lines
3.7 KiB
TypeScript
78 lines
3.7 KiB
TypeScript
export declare const ASTRO_VERSION: string;
|
|
export declare const ASTRO_GENERATOR: string;
|
|
/**
|
|
* Set by internal handlers (e.g. PagesHandler) to signal that a
|
|
* response should be replaced with the corresponding error page.
|
|
*/
|
|
export declare const ASTRO_ERROR_HEADER = "X-Astro-Error";
|
|
/**
|
|
* The value of the `component` field of the default 404 page, which is used when there is no user-provided 404.astro page.
|
|
*/
|
|
export declare const DEFAULT_404_COMPONENT = "astro-default-404.astro";
|
|
/**
|
|
* A response with one of these status codes will create a redirect response.
|
|
*/
|
|
export declare const REDIRECT_STATUS_CODES: readonly [301, 302, 303, 307, 308, 300, 304];
|
|
/**
|
|
* A response with one of these status codes will be rewritten
|
|
* with the result of rendering the respective error page.
|
|
*/
|
|
export declare const REROUTABLE_STATUS_CODES: number[];
|
|
/**
|
|
* The symbol which is used as a field on the request object to store the client address.
|
|
* The clientAddress provided by the adapter (or the dev server) is stored on this field.
|
|
*/
|
|
export declare const clientAddressSymbol: unique symbol;
|
|
/**
|
|
* The symbol used as a field on the request object to store the object to be made available to Astro APIs as `locals`.
|
|
* Use judiciously, as locals are now stored within `FetchState` by default. Tacking it onto request is no longer necessary.
|
|
*/
|
|
export declare const clientLocalsSymbol: unique symbol;
|
|
/**
|
|
* Use this symbol to set and retrieve the original pathname of a request. This is useful when working with redirects and rewrites
|
|
*/
|
|
export declare const originPathnameSymbol: unique symbol;
|
|
/**
|
|
* Use this symbol to set and retrieve the pipeline.
|
|
*/
|
|
export declare const pipelineSymbol: unique symbol;
|
|
/**
|
|
* Use this symbol to stash the active `FetchState` on an `APIContext`
|
|
* (or `ActionAPIContext`). Consumed by internal shims that need access
|
|
* to per-request state without appearing in the public context shape
|
|
* — e.g. the manual-strategy i18n middleware wrapper in
|
|
* `src/i18n/middleware.ts`.
|
|
*/
|
|
export declare const fetchStateSymbol: unique symbol;
|
|
/**
|
|
* Use this symbol to stash the `BaseApp` on an incoming `Request` at the
|
|
* top of the pipeline. Fetch handlers loaded from `virtual:astro:fetchable`
|
|
* (including `DefaultFetchHandler`) read it to find the app associated
|
|
* with the current request without needing App passed to their constructor.
|
|
*/
|
|
export declare const appSymbol: unique symbol;
|
|
/**
|
|
* Use this symbol to opt into handling prerender routes in Astro core dev middleware.
|
|
*/
|
|
export declare const devPrerenderMiddlewareSymbol: unique symbol;
|
|
/**
|
|
* The symbol used as a field on the request object to store a cleanup callback associated with aborting the request when the underlying socket closes.
|
|
*/
|
|
export declare const nodeRequestAbortControllerCleanupSymbol: unique symbol;
|
|
/**
|
|
* The symbol used as a field on the response object to keep track of streaming.
|
|
*
|
|
* It is set when the `<head>` element has been completely generated, rendered, and the response object has been passed onto the adapter.
|
|
*
|
|
* Used to provide helpful errors and warnings when headers or cookies are added during streaming, after the response has already been sent.
|
|
*/
|
|
export declare const responseSentSymbol: unique symbol;
|
|
export declare const SUPPORTED_MARKDOWN_FILE_EXTENSIONS: readonly [".markdown", ".mdown", ".mkdn", ".mkd", ".mdwn", ".md"];
|
|
export declare const MIDDLEWARE_PATH_SEGMENT_NAME = "middleware";
|
|
export declare const ASTRO_VITE_ENVIRONMENT_NAMES: {
|
|
readonly ssr: "ssr";
|
|
readonly client: "client";
|
|
readonly astro: "astro";
|
|
readonly prerender: "prerender";
|
|
};
|
|
export type AstroEnvironmentNames = (typeof ASTRO_VITE_ENVIRONMENT_NAMES)[keyof typeof ASTRO_VITE_ENVIRONMENT_NAMES];
|