```js // @noErrors import { Server, VERSION, error, fail, isActionFailure, isHttpError, isRedirect, json, redirect, text } from '@sveltejs/kit'; ``` ## Server

```dts class Server {/*…*/} ```

```dts constructor(manifest: SSRManifest); ```

```dts init(options: ServerInitOptions): Promise; ```

```dts respond(request: Request, options: RequestOptions): Promise; ```

## VERSION

```dts const VERSION: string; ```

## error 抛出一个带有 HTTP 状态码和可选消息的错误。在请求处理期间调用时，这将导致 SvelteKit 返回一个错误响应而不会调用 `handleError`。确保您没有捕获抛出的错误，否则会阻止 SvelteKit 处理它。

```dts function error(status: number, body: App.Error): never; ```

```dts function error( status: number, body?: { message: string; } extends App.Error ? App.Error | string | undefined : never ): never; ```

## fail 创建一个 `ActionFailure` 对象。

```dts function fail(status: number): ActionFailure; ```

```dts function fail< T extends Record | undefined = undefined >(status: number, data: T): ActionFailure; ```

## isActionFailure 检查这是否是由 `fail` 抛出的 action 失败。

```dts function isActionFailure(e: unknown): e is ActionFailure; ```

## isHttpError 检查这是否是由 `error` 抛出的错误。

```dts function isHttpError( e: unknown, status?: T | undefined ): e is HttpError_1 & { status: T extends undefined ? never : T; }; ```

## isRedirect 检查这是否是由 `redirect` 抛出的重定向。

```dts function isRedirect(e: unknown): e is Redirect_1; ```

## json 从提供的数据创建一个 JSON `Response` 对象。

```dts function json( data: any, init?: ResponseInit | undefined ): Response; ```

## redirect 重定向一个请求。在请求处理期间调用时，SvelteKit 将返回一个重定向响应。确保您没有捕获抛出的重定向，否则会阻止 SvelteKit 处理它。

```dts function redirect( status: | 300 | 301 | 302 | 303 | 304 | 305 | 306 | 307 | 308 | ({} & number), location: string | URL ): never; ```

## text 从提供的正文创建一个 `Response` 对象。

```dts function text( body: string, init?: ResponseInit | undefined ): Response; ```

## Action 位于 `+page.server.js` 的 `export const actions = {..}` 中的表单 action 方法的形状。更多信息请参见 [表单 action ](/docs/kit/form-actions)。

```dts type Action< Params extends Partial> = Partial< Record >, OutputData extends Record | void = Record< string, any > | void, RouteId extends string | null = string | null > = ( event: RequestEvent ) => MaybePromise; ```

## ActionFailure

```dts interface ActionFailure< T extends Record | undefined = undefined > {/*…*/} ```

```dts status: number; ```

```dts data: T; ```

```dts [uniqueSymbol]: true; ```

## ActionResult 通过 `fetch` 调用表单 action 时，响应将具有以下形状之一。 ```svelte

{ return ({ result }) => { // result is of type ActionResult }; }} ```

```dts type ActionResult< Success extends | Record | undefined = Record, Failure extends | Record | undefined = Record > = | { type: 'success'; status: number; data?: Success } | { type: 'failure'; status: number; data?: Failure } | { type: 'redirect'; status: number; location: string } | { type: 'error'; status?: number; error: any }; ```

## Actions 位于 `+page.server.js` 的 `export const actions = {..}` 中的表单 action 方法的形状。更多信息请参见 [表单 action ](/docs/kit/form-actions)。

```dts type Actions< Params extends Partial> = Partial< Record >, OutputData extends Record | void = Record< string, any > | void, RouteId extends string | null = string | null > = Record>; ```

## Adapter [适配器](/docs/kit/adapters) 负责将生产构建转换为可以部署到您选择的平台的形式。

```dts interface Adapter {/*…*/} ```

```dts name: string; ```

适配器的名称，用于记录。通常对应于包名称。

```dts adapt(builder: Builder): MaybePromise; ```

- `builder` 由 SvelteKit 提供的对象，包含适配应用的各种方法

此函数在 SvelteKit 构建您的应用之后调用。

```dts supports?: {/*…*/} ```

在开发和构建期间调用的检查，以确定此适配器的特定功能是否将在生产中工作。

```dts read?: (details: { config: any; route: { id: string } }) => boolean; ```

- `config` 合并后的路由配置

测试 `read` 是否支持来自 `$app/server` 的内容

```dts emulate?(): MaybePromise; ```

创建一个 `Emulator`，允许适配器在开发、构建和预渲染期间影响环境。

## AfterNavigate 传递给 [`afterNavigate`](/docs/kit/$app-navigation#afterNavigate) 回调的参数。

```dts interface AfterNavigate extends Omit {/*…*/} ```

```dts type: Exclude; ```

导航的类型： - `enter`：应用已水合 - `form`：用户提交了一个 `` - `link`：导航由链接点击触发 - `goto`：导航由 `goto(...)` 调用或重定向触发 - `popstate`：导航由后退/前进导航触发

```dts willUnload: false; ```

由于 `afterNavigate` 回调在导航完成后调用，因此它们永远不会与卸载页面的导航一起调用。

## AwaitedActions

```dts type AwaitedActions< T extends Record any> > = OptionalUnion< { [Key in keyof T]: UnpackValidationError< Awaited> >; }[keyof T] >; ```

## BeforeNavigate 传递给 [`beforeNavigate`](/docs/kit/$app-navigation#beforeNavigate) 回调的参数。

```dts interface BeforeNavigate extends Navigation {/*…*/} ```

```dts cancel(): void; ```

调用此方法以阻止导航的开始。

## Builder 此对象传递给适配器的 `adapt` 函数。它包含各种用于适配应用的方法和属性。

```dts interface Builder {/*…*/} ```

```dts log: Logger; ```

将消息打印到控制台。除非 Vite 的 `logLevel` 为 `info`，否则 `log.info` 和 `log.minor` 是静默的。

```dts rimraf(dir: string): void; ```

移除 `dir` 及其所有内容。

```dts mkdirp(dir: string): void; ```

创建 `dir` 及其任何所需的父目录。

```dts config: ValidatedConfig; ```

完全解析的 `svelte.config.js`。

```dts prerendered: Prerendered; ```

预渲染页面和资产的信息（如果有的话）。

```dts routes: RouteDefinition[]; ```

所有路由的数组（包括预渲染的）

```dts createEntries(fn: (route: RouteDefinition) => AdapterEntry): Promise; ```

- `fn` 将一组路由分组为一个入口点的函数 - 已弃用使用 `builder.routes` 代替

创建映射到应用一个或多个路由的独立函数。

```dts findServerAssets(routes: RouteDefinition[]): string[]; ```

查找属于 `routes` 的服务器文件导入的所有资产

```dts generateFallback(dest: string): Promise; ```

为静态网页服务器生成一个回退页面，以在没有匹配路由时使用。适用于单页应用。

```dts generateEnvModule(): void; ```

生成一个模块，将构建时的环境变量暴露为 `$env/dynamic/public`。

```dts generateManifest(opts: { relativePath: string; routes?: RouteDefinition[] }): string; ```

- `opts` 应用的基目录的相对路径，并可选择指定（esm 或 cjs）生成清单的格式

生成一个服务器端清单，用于初始化 SvelteKit 的 [服务器](/docs/kit/@sveltejs-kit#Server)。

```dts getBuildDirectory(name: string): string; ```

- `name` 文件的路径，相对于构建目录

解析 `outDir` 内 `name` 目录的路径，例如 `/path/to/.svelte-kit/my-adapter`。

```dts getClientDirectory(): string; ```

获取包含客户端资产的目录的完全解析路径，包括您的 `static` 目录的内容。

```dts getServerDirectory(): string; ```

获取包含服务器端代码的目录的完全解析路径。

```dts getAppPath(): string; ```

获取包括任何配置的 `base` 路径的应用路径，例如 `my-base-path/_app`。

```dts writeClient(dest: string): string[]; ```

- `dest` 目标文件夹 - 返回写入 `dest` 的文件数组

将客户端资产写入 `dest`。

```dts writePrerendered(dest: string): string[]; ```

- `dest` 目标文件夹 - 返回写入 `dest` 的文件数组

将预渲染的文件写入 `dest`。

```dts writeServer(dest: string): string[]; ```

- `dest` 目标文件夹 - 返回写入 `dest` 的文件数组

将服务器端代码写入 `dest`。

```dts copy( from: string, to: string, opts?: { filter?(basename: string): boolean; replace?: Record; } ): string[]; ```

- `from` 源文件或目录 - `to` 目标文件或目录 - `opts.filter` 一个函数，用于确定是否应该复制文件或目录 - `opts.replace` 一个字符串替换映射 - 返回被复制的文件数组

复制一个文件或目录。

```dts compress(directory: string): Promise; ```

- `directory` 包含要压缩文件的目录

使用 gzip 和 brotli 压缩 `directory` 中的文件（在适当情况下）。在原始文件旁边生成 `.gz` 和 `.br` 文件。

## ClientInit

自 2.10.0 起可用

[`init`](/docs/kit/hooks#Shared-hooks-init) 将在应用在浏览器中启动后调用一次。

```dts type ClientInit = () => MaybePromise; ```

## Config 有关详细信息，请参见[配置参考](/docs/kit/configuration)。 ## Cookies

```dts interface Cookies {/*…*/} ```

```dts get(name: string, opts?: import('cookie').CookieParseOptions): string | undefined; ```

- `name` cookie 的名称 - `opts` 选项，直接传递给 `cookie.parse`。请参阅 [文档](https://github.com/jshttp/cookie#cookieparsestr-options)

获取以前用 `cookies.set` 设置的 cookie，或来自请求头的 cookie。

```dts getAll(opts?: import('cookie').CookieParseOptions): Array<{ name: string; value: string }>; ```

- `opts` 选项，直接传递给 `cookie.parse`。请参阅 [文档](https://github.com/jshttp/cookie#cookieparsestr-options)

获取以前用 `cookies.set` 设置的所有 cookie，或来自请求头的 cookie。

```dts set( name: string, value: string, opts: import('cookie').CookieSerializeOptions & { path: string } ): void; ```

- `name` cookie 的名称 - `value` cookie 的值 - `opts` 选项，直接传递给 `cookie.serialize`。请参阅 [文档](https://github.com/jshttp/cookie#cookieserializename-value-options)

设置一个 cookie。这将向响应添加一个 `set-cookie` 头，但也会使 cookie 在当前请求期间通过 `cookies.get` 或 `cookies.getAll` 可用。 `httpOnly` 和 `secure` 选项默认值为 `true`（除非在 http://localhost 上，`secure` 为 `false`），如果您希望 cookie 可以被客户端 JavaScript 读取和/或通过 HTTP 传输，必须显式禁用它们。`sameSite` 选项默认为 `lax`。您必须为 cookie 指定一个 `path`。在大多数情况下，您应该明确设置 `path: '/'` 以使 cookie 在整个应用中可用。您可以使用相对路径，或者设置 `path: ''` 仅使 cookie 在当前路径及其子路径中可用。

```dts delete(name: string, opts: import('cookie').CookieSerializeOptions & { path: string }): void; ```

- `name` cookie 的名称 - `opts` 选项，直接传递给 `cookie.serialize`。`path` 必须匹配您想要删除的 cookie 的路径。请参阅 [文档](https://github.com/jshttp/cookie#cookieserializename-value-options)

通过将其值设为空字符串并将过期日期设为过去，删除一个 cookie。您必须为 cookie 指定一个 `path`。在大多数情况下，您应该明确设置 `path: '/'` 以使 cookie 在整个应用中可用。您可以使用相对路径，或者设置 `path: ''` 仅使 cookie 在当前路径及其子路径中可用。

```dts serialize( name: string, value: string, opts: import('cookie').CookieSerializeOptions & { path: string } ): string; ```

- `name` cookie 的名称 - `value` cookie 的值 - `opts` 选项，直接传递给 `cookie.serialize`。请参阅 [文档](https://github.com/jshttp/cookie#cookieserializename-value-options)

将 cookie 名称-值对序列化为 `Set-Cookie` 头字符串，但不应用于响应。 `httpOnly` 和 `secure` 选项默认值为 `true`（除非在 http://localhost 上，`secure` 为 `false`），如果您希望 cookie 可以被客户端 JavaScript 读取和/或通过 HTTP 传输，必须显式禁用它们。`sameSite` 选项默认为 `lax`。您必须为 cookie 指定一个 `path`。在大多数情况下，您应该明确设置 `path: '/'` 以使 cookie 在整个应用中可用。您可以使用相对路径，或者设置 `path: ''` 仅使 cookie 在当前路径及其子路径中可用。

## Emulator 一组在开发、构建和预渲染期间影响环境的函数集合。

```dts interface Emulator {/*…*/} ```

```dts platform?(details: { config: any; prerender: PrerenderOption }): MaybePromise; ```

一个函数，接收当前路由的 `config` 和 `prerender` 选项，并返回一个 `App.Platform` 对象。

## Handle [`handle`](/docs/kit/hooks#Server-hooks-handle) 钩子在 SvelteKit 服务器每次接收到一个 [请求](/docs/kit/web-standards#Fetch-APIs-Request) 时运行，并确定 [响应](/docs/kit/web-standards#Fetch-APIs-Response)。它接收一个表示请求的 `event` 对象和一个名为 `resolve` 的函数，该函数渲染路由并生成一个 `Response`。这允许您修改响应头或主体，或完全绕过 SvelteKit（例如，用于以编程方式实现路由）。

```dts type Handle = (input: { event: RequestEvent; resolve( event: RequestEvent, opts?: ResolveOptions ): MaybePromise; }) => MaybePromise; ```

## HandleClientError 客户端 [`handleError`](/docs/kit/hooks#Shared-hooks-handleError) 钩子在导航过程中抛出意外错误时运行。如果在加载或随后的渲染过程中抛出意外错误，此函数将使用错误和事件调用。确保此函数 _永远_ 不会抛出错误。

```dts type HandleClientError = (input: { error: unknown; event: NavigationEvent; status: number; message: string; }) => MaybePromise; ```

## HandleFetch [`handleFetch`](/docs/kit/hooks#Server-hooks-handleFetch) 钩子允许您修改（或替换）在服务器上运行的 `load` 函数中发生的 `fetch` 请求（或在预渲染期间）。

```dts type HandleFetch = (input: { event: RequestEvent; request: Request; fetch: typeof fetch; }) => MaybePromise; ```

## HandleServerError 服务器端 [`handleError`](/docs/kit/hooks#Shared-hooks-handleError) 钩子在响应请求时抛出意外错误时运行。如果在加载或渲染过程中抛出意外错误，此函数将使用错误和事件调用。确保此函数 _永远_ 不会抛出错误。

```dts type HandleServerError = (input: { error: unknown; event: RequestEvent; status: number; message: string; }) => MaybePromise; ```

## HttpError [`error`](/docs/kit/@sveltejs-kit#error) 函数返回的对象。

```dts interface HttpError {/*…*/} ```

```dts status: number; ```

[HTTP 状态码](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#client_error_responses)，范围在 400-599 之间。

```dts body: App.Error; ```

错误的内容。

## KitConfig 有关详细信息，请参见[配置参考](/docs/kit/configuration)。 ## LessThan

```dts type LessThan< TNumber extends number, TArray extends any[] = [] > = TNumber extends TArray['length'] ? TArray[number] : LessThan; ```

## Load `PageLoad` 和 `LayoutLoad` 的通用形式。您应该从 `./$types` 导入它们（参见[生成的类型](/docs/kit/types#Generated-types)），而不是直接使用 `Load`。

```dts type Load< Params extends Partial> = Partial< Record >, InputData extends Record | null = Record< string, any > | null, ParentData extends Record = Record< string, any >, OutputData extends Record< string, unknown > | void = Record | void, RouteId extends string | null = string | null > = ( event: LoadEvent ) => MaybePromise; ```

## LoadEvent `PageLoadEvent` 和 `LayoutLoadEvent` 的通用形式。您应该从 `./$types` 导入它们（参见[生成的类型](/docs/kit/types#Generated-types)），而不是直接使用 `LoadEvent`。

```dts interface LoadEvent< Params extends Partial> = Partial< Record >, Data extends Record | null = Record< string, any > | null, ParentData extends Record = Record< string, any >, RouteId extends string | null = string | null > extends NavigationEvent {/*…*/} ```

```dts fetch: typeof fetch; ```

`fetch` 等同于 [原生 `fetch` Web API](https://developer.mozilla.org/en-US/docs/Web/API/fetch)，具有一些附加功能： - 它可以在服务器上用于进行带凭证的请求，因为它继承了页面请求的 `cookie` 和 `authorization` 头。 - 它可以在服务器上进行相对请求（通常，`fetch` 在服务器上下文中使用时需要带有源的 URL）。 - 内部请求（例如，用于 `+server.js` 路由）在服务器上运行时直接进入处理函数，而无需 HTTP 调用的开销。 - 在服务器端渲染期间，通过钩入 `Response` 对象的 `text` 和 `json` 方法，响应将被捕获并内联到渲染的 HTML 中。注意，除非通过 [`filterSerializedResponseHeaders`](/docs/kit/hooks#Server-hooks-handle) 显式包含，否则头部将 _不会_ 被序列化。 - 在水合过程中，响应将从 HTML 中读取，确保一致性并防止额外的网络请求。您可以在[这里](/docs/kit/load#Cookies)了解更多关于使用 cookies 进行带凭证请求的信息。

```dts data: Data; ```

包含路由的服务器 `load` 函数（在 `+layout.server.js` 或 `+page.server.js` 中）返回的数据（如果有）。

```dts setHeaders(headers: Record): void; ```

如果您需要为响应设置头，可以使用此方法。这在您希望页面被缓存时特别有用，例如： ```js // @errors: 7031 /// file: src/routes/blog/+page.js export async function load({ fetch, setHeaders }) { const url = `https://cms.example.com/articles.json`; const response = await fetch(url); setHeaders({ age: response.headers.get('age'), 'cache-control': response.headers.get('cache-control') }); return response.json(); } ``` 在多个 `load` 函数中多次设置相同的头（即使在不同的 `load` 函数中）也是错误的——您只能设置每个头一次。您不能使用 `setHeaders` 添加 `set-cookie` 头——请改用服务器端 `load` 函数中的 [`cookies`](/docs/kit/@sveltejs-kit#Cookies) API。当 `load` 函数在浏览器中运行时，`setHeaders` 无效。

```dts parent(): Promise; ```

`await parent()` 返回来自父级 `+layout.js` `load` 函数的数据。隐式地，缺失 `+layout.js` 被视为一个 `({ data }) => data` 函数，这意味着它将返回并转发来自父级 `+layout.server.js` 文件的数据。当使用 `await parent()` 时，请注意不要引入意外的瀑布。如果例如，您只想将父级数据合并到返回的输出中，请在获取其他数据后调用它。

```dts depends(...deps: Array<`${string}:${string}`>): void; ```

此函数声明 `load` 函数对一个或多个 URL 或自定义标识符有 _依赖_，这些依赖随后可以与 [`invalidate()`](/docs/kit/$app-navigation#invalidate) 一起使用，导致 `load` 函数重新运行。大多数情况下您不需要这样做，因为 `fetch` 会代表您调用 `depends`——只有在您使用绕过 `fetch` 的自定义 API 客户端时才需要。 URL 可以是绝对的或相对于正在加载的页面，并且必须是[编码的](https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding)。自定义标识符必须以一个或多个小写字母后跟冒号作为前缀，以符合 [URI 规范](https://www.rfc-editor.org/rfc/rfc3986.html)。以下示例展示了如何使用 `depends` 注册对一个自定义标识符的依赖，该标识符在按钮点击后被 `invalidate`，使得 `load` 函数重新运行。 ```js // @errors: 7031 /// file: src/routes/+page.js let count = 0; export async function load({ depends }) { depends('increase:count'); return { count: count++ }; } ``` ```html /// file: src/routes/+page.svelte

{data.count}

```

```dts untrack(fn: () => T): T; ```

使用此函数可选择退出依赖跟踪，针对在回调中同步调用的所有内容。例如： ```js // @errors: 7031 /// file: src/routes/+page.server.js export async function load({ untrack, url }) { // 取消跟踪 url.pathname，以便路径更改不会触发重新运行 if (untrack(() => url.pathname === '/')) { return { message: 'Welcome!' }; } } ```

## LoadProperties

```dts type LoadProperties< input extends Record | void > = input extends void ? undefined // needs to be undefined, because void will break intellisense : input extends Record ? input : unknown; ```

## Navigation

```dts interface Navigation {/*…*/} ```

```dts from: NavigationTarget | null; ```

导航的来源

```dts to: NavigationTarget | null; ```

导航的目标/已导航到的地方

```dts type: Exclude; ```

导航的类型： - `form`：用户提交了一个 `` - `leave`：应用正在离开，因为标签页正在关闭或导航到不同的文档 - `link`：导航由链接点击触发 - `goto`：导航由 `goto(...)` 调用或重定向触发 - `popstate`：导航由后退/前进导航触发

```dts willUnload: boolean; ```

导航是否会导致页面卸载（即不是客户端导航）

```dts delta?: number; ```

在历史记录后退/前进导航的情况下，后退/前进的步骤数

```dts complete: Promise; ```

一个在导航完成后解析的 promise，如果导航失败或被中止则拒绝。在 `willUnload` 导航的情况下，promise 将永远不会解析。

## NavigationEvent

```dts interface NavigationEvent< Params extends Partial> = Partial< Record >, RouteId extends string | null = string | null > {/*…*/} ```

```dts params: Params; ```

当前页面的参数，例如对于 `/blog/[slug]` 路由，一个 `{ slug: string }` 对象

```dts route: {/*…*/} ```

关于当前路由的信息

```dts id: RouteId; ```

当前路由的 ID，例如对于 `src/routes/blog/[slug]`，它将是 `/blog/[slug]`

```dts url: URL; ```

当前页面的 URL

## NavigationTarget 关于特定导航目标的信息。

```dts interface NavigationTarget {/*…*/} ```

```dts params: Record | null; ```

目标页面的参数，例如对于 `/blog/[slug]` 路由，一个 `{ slug: string }` 对象。如果目标不是 SvelteKit 应用的一部分（无法解析为路由），则为 `null`。

```dts route: { id: string | null }; ```

目标路由的信息

```dts url: URL; ```

要导航到的 URL

## NavigationType - `enter`：应用已水合 - `form`：用户提交了一个带有 GET 方法的 `` - `leave`：用户通过关闭标签页或使用后退/前进按钮导航到不同的文档而离开应用 - `link`：导航由链接点击触发 - `goto`：导航由 `goto(...)` 调用或重定向触发 - `popstate`：导航由后退/前进导航触发

## NumericRange

```dts type NumericRange< TStart extends number, TEnd extends number > = Exclude, LessThan>; ```

## OnNavigate 传递给 [`onNavigate`](/docs/kit/$app-navigation#onNavigate) 回调的参数。

```dts interface OnNavigate extends Navigation {/*…*/} ```

```dts type: Exclude; ```

导航的类型： - `form`：用户提交了一个 `` - `link`：导航由链接点击触发 - `goto`：导航由 `goto(...)` 调用或重定向触发 - `popstate`：导航由后退/前进导航触发

```dts willUnload: false; ```

由于 `onNavigate` 回调立即在客户端导航之前调用，它们永远不会与卸载页面的导航一起调用。

## Page `$page` store 的形状

```dts interface Page< Params extends Record = Record< string, string >, RouteId extends string | null = string | null > {/*…*/} ```

```dts url: URL; ```

当前页面的 URL

```dts params: Params; ```

当前页面的参数，例如对于 `/blog/[slug]` 路由，一个 `{ slug: string }` 对象

```dts route: {/*…*/} ```

关于当前路由的信息

```dts id: RouteId; ```

当前路由的 ID，例如对于 `src/routes/blog/[slug]`，它将是 `/blog/[slug]`

```dts status: number; ```

当前页面的 HTTP 状态码

```dts error: App.Error | null; ```

当前页面的错误对象（如果有的话）。来自 `handleError` 钩子填充。

```dts data: App.PageData & Record; ```

当前页面所有 `load` 函数的数据的合并结果。您可以通过 `App.PageData` 类型一个共同的分母。

```dts state: App.PageState; ```

页面状态，可以通过 `$app/navigation` 的 [`pushState`](/docs/kit/$app-navigation#pushState) 和 [`replaceState`](/docs/kit/$app-navigation#replaceState) 函数进行操作。

```dts form: any; ```

仅在表单提交后填充。更多信息请参见 [表单 action ](/docs/kit/form-actions)。

## ParamMatcher 参数匹配器的形状。更多信息请参见 [匹配](/docs/kit/advanced-routing#Matching)。

```dts type ParamMatcher = (param: string) => boolean; ```

## PrerenderOption

```dts type PrerenderOption = boolean | 'auto'; ```

## Redirect [`redirect`](/docs/kit/@sveltejs-kit#redirect) 函数返回的对象

```dts interface Redirect {/*…*/} ```

```dts status: 300 | 301 | 302 | 303 | 304 | 305 | 306 | 307 | 308; ```

[HTTP 状态码](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#redirection_messages)，范围在 300-308 之间。

```dts location: string; ```

要重定向到的位置。

## RequestEvent

```dts interface RequestEvent< Params extends Partial> = Partial< Record >, RouteId extends string | null = string | null > {/*…*/} ```

```dts cookies: Cookies; ```

获取或设置与当前请求相关的 cookie

```dts fetch: typeof fetch; ```

```dts getClientAddress(): string; ```

客户端的 IP 地址，由适配器设置。

```dts locals: App.Locals; ```

包含在 [`server handle hook`](/docs/kit/hooks#Server-hooks-handle) 中向请求添加的自定义数据。

```dts params: Params; ```

当前路由的参数，例如对于 `/blog/[slug]` 路由，一个 `{ slug: string }` 对象

```dts platform: Readonly | undefined; ```

通过适配器提供的额外数据。

```dts request: Request; ```

原始请求对象

```dts route: {/*…*/} ```

关于当前路由的信息

```dts id: RouteId; ```

当前路由的 ID，例如对于 `src/routes/blog/[slug]`，它将是 `/blog/[slug]`

```dts setHeaders(headers: Record): void; ```

```dts url: URL; ```

请求的 URL。

```dts isDataRequest: boolean; ```

如果请求来自客户端询问 `+page/layout.server.js` 数据，则为 `true`。在这种情况下，`url` 属性将被移除与数据请求相关的内部信息。如果这种区别对您很重要，请使用此属性。

```dts isSubRequest: boolean; ```

如果请求是来自 SvelteKit 的 `+server.js` 调用，则为 `true`，无需实际进行 HTTP 请求。这发生在服务器上进行同源 `fetch` 请求时。

## RequestHandler 一个从 `+server.js` 文件导出的 `(event: RequestEvent) => Response` 函数，它对应于一个 HTTP 动词 (`GET`, `PUT`, `PATCH` 等)，并处理具有该方法的请求。它接收 `Params` 作为第一个泛型参数，您可以通过使用 [生成的类型](/docs/kit/types#Generated-types) 来跳过它。

```dts type RequestHandler< Params extends Partial> = Partial< Record >, RouteId extends string | null = string | null > = ( event: RequestEvent ) => MaybePromise; ```

## Reroute

自 2.3.0 起可用

[`reroute`](/docs/kit/hooks#Universal-hooks-reroute) 钩子允许您在用于确定要渲染哪个路由之前修改 URL。

```dts type Reroute = (event: { url: URL }) => void | string; ```

## ResolveOptions

```dts interface ResolveOptions {/*…*/} ```

```dts transformPageChunk?(input: { html: string; done: boolean }): MaybePromise; ```

- `input` html 块和是否是最后一个块的信息

对 HTML 进行自定义转换。如果 `done` 为 true，则是最后一个块。块不保证是完整的 HTML（例如，它们可能包含一个元素的开始标签但不包含结束标签），但它们总是会在诸如 `%sveltekit.head%` 或布局/页面组件等合理的边界处拆分。

```dts filterSerializedResponseHeaders?(name: string, value: string): boolean; ```

- `name` 头名称 - `value` 头值

确定在 `load` 函数使用 `fetch` 加载资源时，哪些头应包含在序列化的响应中。默认情况下，不会包含任何头。

```dts preload?(input: { type: 'font' | 'css' | 'js' | 'asset'; path: string }): boolean; ```

- `input` 文件的类型和路径

确定应添加到 `` 标签以预加载的内容。默认情况下，`js` 和 `css` 文件将被预加载。

## RouteDefinition

```dts interface RouteDefinition {/*…*/} ```

```dts id: string; ```

```dts api: { methods: Array; }; ```

```dts page: { methods: Array>; }; ```

```dts pattern: RegExp; ```

```dts prerender: PrerenderOption; ```

```dts segments: RouteSegment[]; ```

```dts methods: Array; ```

```dts config: Config; ```

## SSRManifest

```dts interface SSRManifest {/*…*/} ```

```dts appDir: string; ```

```dts appPath: string; ```

```dts assets: Set; ```

```dts mimeTypes: Record; ```

```dts _: {/*…*/} ```

私有字段

```dts client: NonNullable; ```

```dts nodes: SSRNodeLoader[]; ```

```dts routes: SSRRoute[]; ```

```dts matchers(): Promise>; ```

```dts server_assets: Record; ```

所有由服务器代码导入的资产的 `[file]: size` 映射

## ServerInit

自 2.10.0 起可用

[`init`](/docs/kit/hooks#Shared-hooks-init) 将在服务器响应其第一个请求之前调用。

```dts type ServerInit = () => MaybePromise; ```

## ServerInitOptions

```dts interface ServerInitOptions {/*…*/} ```

```dts env: Record; ```

环境变量的映射

```dts read?: (file: string) => ReadableStream; ```

一个将资产文件名转换为 `ReadableStream` 的函数。对于 `$app/server` 的 `read` 导出，这个是必需的。

## ServerLoad `PageServerLoad` 和 `LayoutServerLoad` 的通用形式。您应该从 `./$types` 导入它们（参见[生成的类型](/docs/kit/types#Generated-types)），而不是直接使用 `ServerLoad`。

```dts type ServerLoad< Params extends Partial> = Partial< Record >, ParentData extends Record = Record< string, any >, OutputData extends Record | void = Record< string, any > | void, RouteId extends string | null = string | null > = ( event: ServerLoadEvent ) => MaybePromise; ```

## ServerLoadEvent

```dts interface ServerLoadEvent< Params extends Partial> = Partial< Record >, ParentData extends Record = Record< string, any >, RouteId extends string | null = string | null > extends RequestEvent {/*…*/} ```

```dts parent(): Promise; ```

`await parent()` 返回来自父级 `+layout.server.js` `load` 函数的数据。当使用 `await parent()` 时，请注意不要引入意外的瀑布。如果例如，您只想将父级数据合并到返回的输出中，请在获取其他数据后调用它。

```dts depends(...deps: string[]): void; ```

{data.count}

```

```dts untrack(fn: () => T): T; ```

使用此函数可选择退出依赖跟踪，针对在回调中同步调用的所有内容。例如： ```js // @errors: 7031 /// file: src/routes/+page.js export async function load({ untrack, url }) { // 取消跟踪 url.pathname，以便路径更改不会触发重新运行 if (untrack(() => url.pathname === '/')) { return { message: 'Welcome!' }; } } ```

## Snapshot 导出自页面或布局组件的 `export const snapshot` 的类型。

```dts interface Snapshot {/*…*/} ```

```dts capture: () => T; ```

```dts restore: (snapshot: T) => void; ```

## SubmitFunction

```dts type SubmitFunction< Success extends | Record | undefined = Record, Failure extends | Record | undefined = Record > = (input: { action: URL; formData: FormData; formElement: HTMLFormElement; controller: AbortController; submitter: HTMLElement | null; cancel(): void; }) => MaybePromise< | void | ((opts: { formData: FormData; formElement: HTMLFormElement; action: URL; result: ActionResult; /** * 调用此方法以获取表单提交响应的默认行为。 * @param options 如果不希望在成功提交后重置 `` 的值，请设置 `reset: false`。 * @param invalidateAll 如果不希望在提交后调用 `invalidateAll`，请设置 `invalidateAll: false`。 */ update(options?: { reset?: boolean; invalidateAll?: boolean; }): Promise; }) => void) >; ```

## Transport

自 2.11.0 起可用

[`transport`](/docs/kit/hooks#Universal-hooks-transport) 钩子允许您在服务器/客户端边界上传输自定义类型。每个传输器都有一对 `encode` 和 `decode` 函数。在服务器端，`encode` 决定一个值是否是自定义类型的实例，如果是，则返回该值的非假编码（可以是对象或数组，否则返回 `false`）。在浏览器端，`decode` 将编码转换回自定义类型的实例。 ```ts import type { Transport } from '@sveltejs/kit'; declare class MyCustomType { data: any; } // hooks.js export const transport: Transport = { MyCustomType: { encode: (value) => value instanceof MyCustomType && [value.data], decode: ([data]) => new MyCustomType(data) } }; ```

```dts type Transport = Record; ```

## Transporter [`transport`](/docs/kit/hooks#Universal-hooks-transport) 钩子的成员。

```dts interface Transporter< T = any, U = Exclude< any, false | 0 | '' | null | undefined | typeof NaN > > {/*…*/} ```

```dts encode: (value: T) => false | U; ```

```dts decode: (data: U) => T; ```

## Private types 以下类型由上面文档的公共类型引用，但不能直接导入： ## AdapterEntry

```dts interface AdapterEntry {/*…*/} ```

```dts id: string; ```

一个唯一标识 HTTP 服务（例如无服务器函数）的字符串，用于去重。例如，`/foo/a-[b]` 和 `/foo/[c]` 是不同的路由，但在 Netlify `_redirects` 文件中都会表示为 `/foo/:param`，因此它们共享一个 ID

```dts filter(route: RouteDefinition): boolean; ```

一个函数，用于比较候选路由与当前路由，以确定是否应与当前路由分组。用例： - 回退页面：`/foo/[c]` 是 `/foo/a-[b]` 的回退，`/[...catchall]` 是所有路由的回退 - 分组共享通用 `config` 的路由：`/foo` 应部署到边缘，`/bar` 和 `/baz` 应部署到无服务器函数

```dts complete(entry: { generateManifest(opts: { relativePath: string }): string }): MaybePromise; ```

一个在创建入口点后调用的函数。这是您应该将函数写入文件系统并生成重定向清单的地方。

## Csp

```dts namespace Csp { type ActionSource = 'strict-dynamic' | 'report-sample'; type BaseSource = | 'self' | 'unsafe-eval' | 'unsafe-hashes' | 'unsafe-inline' | 'wasm-unsafe-eval' | 'none'; type CryptoSource = `${'nonce' | 'sha256' | 'sha384' | 'sha512'}-${string}`; type FrameSource = | HostSource | SchemeSource | 'self' | 'none'; type HostNameScheme = `${string}.${string}` | 'localhost'; type HostSource = `${HostProtocolSchemes}${HostNameScheme}${PortScheme}`; type HostProtocolSchemes = `${string}://` | ''; type HttpDelineator = '/' | '?' | '#' | '\\'; type PortScheme = `:${number}` | '' | ':*'; type SchemeSource = | 'http:' | 'https:' | 'data:' | 'mediastream:' | 'blob:' | 'filesystem:'; type Source = | HostSource | SchemeSource | CryptoSource | BaseSource; type Sources = Source[]; } ```

## CspDirectives

```dts interface CspDirectives {/*…*/} ```

```dts 'child-src'?: Csp.Sources; ```

```dts 'default-src'?: Array; ```

```dts 'frame-src'?: Csp.Sources; ```

```dts 'worker-src'?: Csp.Sources; ```

```dts 'connect-src'?: Csp.Sources; ```

```dts 'font-src'?: Csp.Sources; ```

```dts 'img-src'?: Csp.Sources; ```

```dts 'manifest-src'?: Csp.Sources; ```

```dts 'media-src'?: Csp.Sources; ```

```dts 'object-src'?: Csp.Sources; ```

```dts 'prefetch-src'?: Csp.Sources; ```

```dts 'script-src'?: Array; ```

```dts 'script-src-elem'?: Csp.Sources; ```

```dts 'script-src-attr'?: Csp.Sources; ```

```dts 'style-src'?: Array; ```

```dts 'style-src-elem'?: Csp.Sources; ```

```dts 'style-src-attr'?: Csp.Sources; ```

```dts 'base-uri'?: Array; ```

```dts 'form-action'?: Array; ```

```dts 'frame-ancestors'?: Array; ```

```dts 'navigate-to'?: Array; ```

```dts 'report-uri'?: string[]; ```

```dts 'report-to'?: string[]; ```

```dts 'require-trusted-types-for'?: Array<'script'>; ```

- 已弃用

```dts 'trusted-types'?: Array<'none' | 'allow-duplicates' | '*' | string>; ```

- 已弃用

```dts 'upgrade-insecure-requests'?: boolean; ```

- 已弃用

```dts 'require-sri-for'?: Array<'script' | 'style' | 'script style'>; ```

- 已弃用

## HttpMethod

## Logger

```dts interface Logger {/*…*/} ```

```dts (msg: string): void; ```

```dts success(msg: string): void; ```

```dts error(msg: string): void; ```

```dts warn(msg: string): void; ```

```dts minor(msg: string): void; ```

```dts info(msg: string): void; ```

## MaybePromise

```dts type MaybePromise = T | Promise; ```

## PrerenderEntryGeneratorMismatchHandler

```dts interface PrerenderEntryGeneratorMismatchHandler {/*…*/} ```

```dts (details: { generatedFromId: string; entry: string; matchedId: string; message: string }): void; ```

## PrerenderEntryGeneratorMismatchHandlerValue

```dts type PrerenderEntryGeneratorMismatchHandlerValue = | 'fail' | 'warn' | 'ignore' | PrerenderEntryGeneratorMismatchHandler; ```

## PrerenderHttpErrorHandler

```dts interface PrerenderHttpErrorHandler {/*…*/} ```

```dts (details: { status: number; path: string; referrer: string | null; referenceType: 'linked' | 'fetched'; message: string; }): void; ```

## PrerenderHttpErrorHandlerValue

```dts type PrerenderHttpErrorHandlerValue = | 'fail' | 'warn' | 'ignore' | PrerenderHttpErrorHandler; ```

## PrerenderMap

```dts type PrerenderMap = Map; ```

## PrerenderMissingIdHandler

```dts interface PrerenderMissingIdHandler {/*…*/} ```

```dts (details: { path: string; id: string; referrers: string[]; message: string }): void; ```

## PrerenderMissingIdHandlerValue

```dts type PrerenderMissingIdHandlerValue = | 'fail' | 'warn' | 'ignore' | PrerenderMissingIdHandler; ```

## PrerenderOption

```dts type PrerenderOption = boolean | 'auto'; ```

## Prerendered

```dts interface Prerendered {/*…*/} ```

```dts pages: Map< string, { /** 甲骨文文件在输出目录中的位置 */ file: string; } >; ```

一个 `path` 到 `{ file }` 对象的映射，例如 `/foo` 对应 `foo.html`，而 `/bar/` 对应 `bar/index.html`。

```dts assets: Map< string, { type: string; } >; ```

一个 `path` 到 `{ type }` 对象的映射。

```dts redirects: Map< string, { status: number; location: string; } >; ```

预渲染期间遇到的重定向的映射。

```dts paths: string[]; ```

预渲染的路径数组（不带尾部斜杠，无论 `trailingSlash` 配置如何）

## RequestOptions

```dts interface RequestOptions {/*…*/} ```

```dts getClientAddress(): string; ```

```dts platform?: App.Platform; ```

## RouteSegment

```dts interface RouteSegment {/*…*/} ```

```dts content: string; ```

```dts dynamic: boolean; ```

```dts rest: boolean; ```

## TrailingSlash

```dts type TrailingSlash = 'never' | 'always' | 'ignore'; ```