配置

是否使用哈希或随机数来限制 <script> 和 <style> 元素。'auto' 将对预渲染页面使用哈希，对动态渲染页面使用随机数。

¥Whether to use hashes or nonces to restrict <script> and <style> elements. 'auto' will use hashes for prerendered pages, and nonces for dynamically rendered pages.

将添加到 Content-Security-Policy 标头的指令。

¥Directives that will be added to Content-Security-Policy headers.

将添加到 Content-Security-Policy-Report-Only 标头的指令。

¥Directives that will be added to Content-Security-Policy-Report-Only headers.

是否检查传入的 origin 标头中是否存在 POST、PUT、PATCH 或 DELETE 表单提交，并验证其是否与服务器的来源匹配。

¥Whether to check the incoming origin header for POST, PUT, PATCH, or DELETE form submissions and verify that it matches the server’s origin.

要允许人们从其他来源向你的应用发出 POST、PUT、PATCH 或 DELETE 请求，其中 Content-Type 为 application/x-www-form-urlencoded、multipart/form-data 或 text/plain，你需要禁用此选项。小心！

¥To allow people to make POST, PUT, PATCH, or DELETE requests with a Content-Type of application/x-www-form-urlencoded, multipart/form-data, or text/plain to your app from other origins, you will need to disable this option. Be careful!

搜索 .env 文件的目录。

¥The directory to search for .env files.

表示环境变量可以安全地暴露给客户端代码的前缀。参见 $env/static/public 和 $env/dynamic/public。请注意，如果你使用 Vite 的环境变量处理，则必须单独设置 Vite 的 envPrefix - 尽管通常不需要使用该功能。

¥A prefix that signals that an environment variable is safe to expose to client-side code. See $env/static/public and $env/dynamic/public. Note that Vite’s envPrefix must be set separately if you are using Vite’s environment variable handling - though use of that feature should generally be unnecessary.

表示环境变量不安全地暴露给客户端代码的前缀。既不匹配公共前缀也不匹配私有前缀的环境变量将被完全丢弃。参见 $env/static/private 和 $env/dynamic/private。

¥A prefix that signals that an environment variable is unsafe to expose to client-side code. Environment variables matching neither the public nor the private prefix will be discarded completely. See $env/static/private and $env/dynamic/private.

放置静态文件的位置，这些文件应具有稳定的 URL 并且不进行任何处理，例如 favicon.ico 或 manifest.json

¥a place to put static files that should have stable URLs and undergo no processing, such as favicon.ico or manifest.json

你的应用的内部库，可在整个代码库中作为 $lib 访问

¥your app’s internal library, accessible throughout the codebase as $lib

包含 参数匹配器 的目录

¥a directory containing parameter matchers

定义应用结构的文件（请参阅 路由）

¥the files that define the structure of your app (see Routing)

服务工作者入口点的位置（请参阅 服务工作者）

¥the location of your service worker’s entry point (see Service workers)

HTML 响应模板的位置

¥the location of the template for HTML responses

后备错误响应模板的位置

¥the location of the template for fallback error responses

SvelteKit 将预加载初始页面所需的 JavaScript 模块以避免导入 ‘waterfalls’，从而加快应用启动速度。有三种策略，各有优缺点：

¥SvelteKit will preload the JavaScript modules needed for the initial page to avoid import ‘waterfalls’, resulting in faster application startup. There are three strategies with different trade-offs:

• modulepreload - 使用 <link rel="modulepreload">。这在基于 Chromium 的浏览器、Firefox 115+ 和 Safari 17+ 中提供最佳效果。它在旧版浏览器中被忽略。

  ¥modulepreload - uses <link rel="modulepreload">. This delivers the best results in Chromium-based browsers, in Firefox 115+, and Safari 17+. It is ignored in older browsers.

• preload-js - 使用 <link rel="preload">。防止 Chromium 和 Safari 中的瀑布，但 Chromium 会对每个模块进行两次解析（一次作为脚本，一次作为模块）。导致在 Firefox 中两次请求模块。如果你想以 Chromium 用户的轻微性能下降为代价最大限度地提高 iOS 设备用户的性能，这是一个很好的设置。

  ¥preload-js - uses <link rel="preload">. Prevents waterfalls in Chromium and Safari, but Chromium will parse each module twice (once as a script, once as a module). Causes modules to be requested twice in Firefox. This is a good setting if you want to maximise performance for users on iOS devices at the cost of a very slight degradation for Chromium users.

• preload-mjs - 使用 <link rel="preload">，但使用 .mjs 扩展，可防止 Chromium 中的双重解析。一些静态 Web 服务器无法提供带有 Content-Type: application/javascript 标头的 .mjs 文件，这将导致你的应用崩溃。如果这不适用于你，那么这是为最多用户提供最佳性能的选项，直到 modulepreload 得到更广泛的支持。

  ¥preload-mjs - uses <link rel="preload"> but with the .mjs extension which prevents double-parsing in Chromium. Some static webservers will fail to serve .mjs files with a Content-Type: application/javascript header, which will cause your application to break. If that doesn’t apply to you, this is the option that will deliver the best performance for the largest number of users, until modulepreload is more widely supported.

打包策略选项会影响应用的 JavaScript 和 CSS 文件的加载方式。

¥The bundle strategy option affects how your app’s JavaScript and CSS files are loaded.

• 如果是 'split'，则将应用拆分为多个 .js/.css 文件，以便在用户浏览应用时延迟加载它们。这是默认设置，推荐用于大多数场景。

  ¥If 'split', splits the app up into multiple .js/.css files so that they are loaded lazily as the user navigates around the app. This is the default, and is recommended for most scenarios.

• 如果是 'single'，则只创建一个 .js 包和一个包含整个应用代码的 .css 文件。

  ¥If 'single', creates just one .js bundle and one .css file containing code for the entire app.

• 如果是 'inline'，则将整个应用的所有 JavaScript 和 CSS 内联到 HTML 中。结果无需服务器即可使用（即你只需在浏览器中打开文件即可）。

  ¥If 'inline', inlines all JavaScript and CSS of the entire app into the HTML. The result is usable without a server (i.e. you can just open the file in your browser).

使用 'split' 时，你还可以通过在 Vite 配置的 build.rollupOptions 中设置 output.experimentalMinChunkSize 和 output.manualChunks 来调整打包行为。

¥When using 'split', you can also adjust the bundling behaviour by setting output.experimentalMinChunkSize and output.manualChunks inside your Vite config’s build.rollupOptions.

如果你想内联你的资源，你需要将 Vite 的 build.assetsInlineLimit 选项设置为适当的大小，然后通过 Vite 导入你的资源。

¥If you want to inline your assets, you’ll need to set Vite’s build.assetsInlineLimit option to an appropriate size then import your assets through Vite.

import { function sveltekit(): Promise<Plugin<any>[]>
Returns the SvelteKit Vite plugins.
sveltekit } from '@sveltejs/kit/vite';
import { function defineConfig(config: UserConfig): UserConfig (+3 overloads)
Type helper to make it easier to use vite.config.ts
accepts a direct 
{@link 
UserConfig
}
 object, or a function that returns it.
The function receives a 
{@link 
ConfigEnv
}
 object.
defineConfig } from 'vite';

export default function defineConfig(config: UserConfig): UserConfig (+3 overloads)
Type helper to make it easier to use vite.config.ts
accepts a direct 
{@link 
UserConfig
}
 object, or a function that returns it.
The function receives a 
{@link 
ConfigEnv
}
 object.
defineConfig({
	UserConfig.plugins?: PluginOption[] | undefined
Array of vite plugins to use.
plugins: [function sveltekit(): Promise<Plugin<any>[]>
Returns the SvelteKit Vite plugins.
sveltekit()],
	UserConfig.build?: BuildOptions | undefined
Build specific options
build: {
		// inline all imported assets
		BuildOptions.assetsInlineLimit?: number | ((filePath: string, content: Buffer) => boolean | undefined) | undefined
Static asset files smaller than this number (in bytes) will be inlined as
base64 strings. Default limit is 4096 (4 KiB). Set to 0 to disable.
@default4096assetsInlineLimit: var Infinity: numberInfinity
	}
});

<script>
	// import the asset through Vite
	import favicon from './favicon.png';
</script>

<svelte:head>
	<!-- this asset will be inlined as a base64 URL -->
	<link rel="icon" href={favicon} />
</svelte:head>

<script lang="ts">
	// import the asset through Vite
	import favicon from './favicon.png';
</script>

<svelte:head>
	<!-- this asset will be inlined as a base64 URL -->
	<link rel="icon" href={favicon} />
</svelte:head>

你的应用文件的绝对路径。如果你的文件由某种存储桶提供，这将非常有用。

¥An absolute path that your app’s files are served from. This is useful if your files are served from a storage bucket of some kind.

必须以 /（例如 /base-path）开头但不能以 / 结尾的根相对路径，除非它是空字符串。这指定了你的应用的提供服务位置，并允许应用存在于非根路径上。请注意，你需要在所有根相关链接前面添加基值，否则它们将指向你的域的根目录，而不是你的 base（这是浏览器的工作方式）。你可以将 $app/paths 中的 base 用于此目的：<a href="{base}/your-page">Link</a>。如果你发现自己经常写这个，那么将其提取到可重用的组件中可能很有意义。

¥A root-relative path that must start, but not end with / (e.g. /base-path), unless it is the empty string. This specifies where your app is served from and allows the app to live on a non-root path. Note that you need to prepend all your root-relative links with the base value or they will point to the root of your domain, not your base (this is how the browser works). You can use base from $app/paths for that: <a href="{base}/your-page">Link</a>. If you find yourself writing this often, it may make sense to extract this into a reusable component.

是否使用相对资源路径。

¥Whether to use relative asset paths.

如果是 true，从 $app/paths 导入的 base 和 assets 将在服务器端渲染期间被替换为相对资源路径，从而产生更易于移植的 HTML。如果是 false，%sveltekit.assets% 和对构建工件的引用将始终是根相对路径，除非 paths.assets 是外部 URL

¥If true, base and assets imported from $app/paths will be replaced with relative asset paths during server-side rendering, resulting in more portable HTML. If false, %sveltekit.assets% and references to build artifacts will always be root-relative paths, unless paths.assets is an external URL

单页应用 后备页面将始终使用绝对路径，无论此设置如何。

¥Single-page app fallback pages will always use absolute paths, regardless of this setting.

如果你的应用使用 <base> 元素，你应该将其设置为 false，否则资源 URL 将错误地根据 <base> URL 而不是当前页面进行解析。

¥If your app uses a <base> element, you should set this to false, otherwise asset URLs will incorrectly be resolved against the <base> URL rather than the current page.

在 1.0 中，undefined 是一个有效值，默认情况下设置。在这种情况下，如果 paths.assets 不是外部的，SvelteKit 会用相对路径替换 %sveltekit.assets%，并使用相对路径引用构建工件，但从 $app/paths 导入的 base 和 assets 将按照你的配置中指定的方式进行。

¥In 1.0, undefined was a valid value, which was set by default. In that case, if paths.assets was not external, SvelteKit would replace %sveltekit.assets% with a relative path and use relative paths to reference build artifacts, but base and assets imported from $app/paths would be as specified in your config.

可以同时预渲染多少个页面。JS 是单线程的，但在预渲染性能受网络限制的情况下（例如从远程 CMS 加载内容），这可以通过在等待网络响应时处理其他任务来加快速度。

¥How many pages can be prerendered simultaneously. JS is single-threaded, but in cases where prerendering performance is network-bound (for example loading content from a remote CMS) this can speed things up by processing other tasks while waiting on the network response.

SvelteKit 是否应通过跟踪 entries 中的链接来查找要预渲染的页面。

¥Whether SvelteKit should find pages to prerender by following links from entries.

要预渲染或开始抓取的页面数组（如果是 crawl: true）。* 字符串包括所有不包含必需 [parameters] 的路由，其中​​包含的可选参数为空（因为 SvelteKit 不知道任何参数应该具有什么值）。

¥An array of pages to prerender, or start crawling from (if crawl: true). The * string includes all routes containing no required [parameters] with optional parameters included as being empty (since SvelteKit doesn’t know what value any parameters should have).

如何响应预渲染应用时遇到的 HTTP 错误。

¥How to respond to HTTP errors encountered while prerendering the app.

• 'fail' — 构建失败

  ¥'fail' — fail the build

• 'ignore' - 默默忽略失败并继续

  ¥'ignore' - silently ignore the failure and continue

• 'warn' — 继续，但打印警告

  ¥'warn' — continue, but print a warning

• (details) => void — 自定义错误处理程序，采用具有 status、path、referrer、referenceType 和 message 属性的 details 对象。如果你从此功能 throw，则构建将失败

  ¥(details) => void — a custom error handler that takes a details object with status, path, referrer, referenceType and message properties. If you throw from this function, the build will fail

/** @type {import('@sveltejs/kit').Config} */
const 
const config: {
    kit: {
        prerender: {
 handleHttpError: ({ path, referrer, message }: {
   path: any;
   referrer: any;
     message: any;
 }) => void;
        };
    };
}
@type{import('@sveltejs/kit').Config}config = {
	
kit: {
    prerender: {
        handleHttpError: ({ path, referrer, message }: {
 path: any;
 referrer: any;
 message: any;
        }) => void;
    };
}kit: {
		
prerender: {
    handleHttpError: ({ path, referrer, message }: {
        path: any;
        referrer: any;
        message: any;
    }) => void;
}prerender: {
			
handleHttpError: ({ path, referrer, message }: {
    path: any;
    referrer: any;
    message: any;
}) => voidhandleHttpError: ({ path: anypath, referrer: anyreferrer, message: anymessage }) => {
				// ignore deliberate link to shiny 404 page
				if (path: anypath === '/not-found' && referrer: anyreferrer === '/blog/how-we-built-our-404-page') {
					return;
				}

				// otherwise fail the build
				throw new 
var Error: ErrorConstructor
new (message?: string, options?: ErrorOptions) => Error (+1 overload)Error(message: anymessage);
			}
		}
	}
};

当从一个预渲染页面到另一个预渲染页面的哈希链接与目标页面上的 id 不对应时，如何响应。

¥How to respond when hash links from one prerendered page to another don’t correspond to an id on the destination page.

• 'fail' — 构建失败

  ¥'fail' — fail the build

• 'ignore' - 默默忽略失败并继续

  ¥'ignore' - silently ignore the failure and continue

• 'warn' — 继续，但打印警告

  ¥'warn' — continue, but print a warning

• (details) => void — 自定义错误处理程序，采用具有 path、id、referrers 和 message 属性的 details 对象。如果你从此功能 throw，则构建将失败

  ¥(details) => void — a custom error handler that takes a details object with path, id, referrers and message properties. If you throw from this function, the build will fail

当 entries 导出生成的条目与其生成的路由不匹配时如何响应。

¥How to respond when an entry generated by the entries export doesn’t match the route it was generated from.

• 'fail' — 构建失败

  ¥'fail' — fail the build

• 'ignore' - 默默忽略失败并继续

  ¥'ignore' - silently ignore the failure and continue

• 'warn' — 继续，但打印警告

  ¥'warn' — continue, but print a warning

• (details) => void — 自定义错误处理程序，采用具有 generatedFromId、entry、matchedId 和 message 属性的 details 对象。如果你从此功能 throw，则构建将失败

  ¥(details) => void — a custom error handler that takes a details object with generatedFromId, entry, matchedId and message properties. If you throw from this function, the build will fail

预渲染期间 url.origin 的值；如果它包含在渲染的内容中，则很有用。

¥The value of url.origin during prerendering; useful if it is included in rendered content.

使用哪种类型的客户端路由。

¥What type of client-side router to use.

• 'pathname' 是默认值，表示当前 URL 路径名决定路由

  ¥'pathname' is the default and means the current URL pathname determines the route

• 'hash' 表示路由由 location.hash 确定。在这种情况下，SSR 和预渲染被禁用。仅当 pathname 不是一种选择时才建议这样做，例如因为你无法控制部署应用的 Web 服务器。它有一些注意事项：你不能使用服务器端渲染（或任何服务器逻辑），并且你必须确保应用中的链接都以 #/ 开头，否则它们将不起作用。除此之外，一切都与普通的 SvelteKit 应用完全一样。

  ¥'hash' means the route is determined by location.hash. In this case, SSR and prerendering are disabled. This is only recommended if pathname is not an option, for example because you don’t control the webserver where your app is deployed. It comes with some caveats: you can’t use server-side rendering (or indeed any server logic), and you have to make sure that the links in your app all start with #/, or they won’t work. Beyond that, everything works exactly like a normal SvelteKit app.

如何确定导航到新页面时要加载哪个路由。

¥How to determine which route to load when navigating to a new page.

默认情况下，SvelteKit 将向浏览器提供路由清单。导航时，此清单用于（如果存在，则与 reroute 钩子一起使用）确定要加载哪些组件以及要运行哪些 load 函数。因为一切都发生在客户端，所以这个决定可以立即做出。缺点是，在第一次导航之前需要加载和解析清单，如果你的应用包含许多路由，这可能会产生影响。

¥By default, SvelteKit will serve a route manifest to the browser. When navigating, this manifest is used (along with the reroute hook, if it exists) to determine which components to load and which load functions to run. Because everything happens on the client, this decision can be made immediately. The drawback is that the manifest needs to be loaded and parsed before the first navigation can happen, which may have an impact if your app contains many routes.

或者，SvelteKit 可以确定服务器上的路由。这意味着对于每个尚未访问过的路径的导航，都会要求服务器确定路由。这有几个优点：

¥Alternatively, SvelteKit can determine the route on the server. This means that for every navigation to a path that has not yet been visited, the server will be asked to determine the route. This has several advantages:

• 客户端不需要预先加载路由清单，这可以加快初始页面加载速度

  ¥The client does not need to load the routing manifest upfront, which can lead to faster initial page loads

• 路由列表对公众隐藏

  ¥The list of routes is hidden from public view

• 服务器有机会拦截每个导航（例如通过中间件），从而启用（例如）对 SvelteKit 不透明的 A/B 测试

  ¥The server has an opportunity to intercept each navigation (for example through a middleware), enabling (for example) A/B testing opaque to SvelteKit

缺点是对于未访问的路径，解析将花费更长的时间（尽管 preloading 可以缓解这种情况）。

¥The drawback is that for unvisited paths, resolution will take slightly longer (though this is mitigated by preloading).

使用服务器端路由解析和预渲染时，解析将与路由本身一起预渲染。

¥[!NOTE] When using server-side route resolution and prerendering, the resolution is prerendered along with the route itself.

是否自动注册服务工作者（如果存在）。

¥Whether to automatically register the service worker, if it exists.

确定 static 目录中的哪些文件将在 $service-worker.files 中可用。

¥Determine which files in your static directory will be available in $service-worker.files.

允许你编辑生成的 tsconfig.json 的函数。你可以改变配置（推荐）或返回新配置。例如，这对于在 monorepo 根中扩展共享 tsconfig.json 很有用。

¥A function that allows you to edit the generated tsconfig.json. You can mutate the config (recommended) or return a new one. This is useful for extending a shared tsconfig.json in a monorepo root, for example.

当前应用版本字符串。如果指定，这必须是确定性的（例如提交引用而不是 Math.random() 或 Date.now().toString()），否则默认为构建的时间戳。

¥The current app version string. If specified, this must be deterministic (e.g. a commit ref rather than Math.random() or Date.now().toString()), otherwise defaults to a timestamp of the build.

例如，要使用当前提交哈希，你可以使用 git rev-parse HEAD：

¥For example, to use the current commit hash, you could do use git rev-parse HEAD:

import * as module "node:child_process"child_process from 'node:child_process';

export default {
	
kit: {
    version: {
        name: string;
    };
}kit: {
		
version: {
    name: string;
}version: {
			name: stringname: module "node:child_process"child_process.function execSync(command: string): Buffer (+3 overloads)
The child_process.execSync() method is generally identical to 
{@link 
exec
}
 with the exception that the method will not return
until the child process has fully closed. When a timeout has been encountered
and killSignal is sent, the method won’t return until the process has
completely exited. If the child process intercepts and handles the SIGTERM signal and doesn’t exit, the parent process will wait until the child process
has exited.
If the process times out or has a non-zero exit code, this method will throw.
The Error object will contain the entire result from 
{@link 
spawnSync
}
.
Never pass unsanitized user input to this function. Any input containing shell
metacharacters may be used to trigger arbitrary command execution.
@sincev0.11.12
@paramcommand The command to run.
@returnThe stdout from the command.execSync('git rev-parse HEAD').Buffer.toString(encoding?: BufferEncoding, start?: number, end?: number): string
Decodes buf to a string according to the specified character encoding inencoding. start and end may be passed to decode only a subset of buf.
If encoding is 'utf8' and a byte sequence in the input is not valid UTF-8,
then each invalid byte is replaced with the replacement character U+FFFD.
The maximum length of a string instance (in UTF-16 code units) is available
as 
{@link 
constants.MAX_STRING_LENGTH
}
.
import { Buffer } from 'node:buffer';

const buf1 = Buffer.allocUnsafe(26);

for (let i = 0; i < 26; i++) {
  // 97 is the decimal ASCII value for 'a'.
  buf1[i] = i + 97;
}

console.log(buf1.toString('utf8'));
// Prints: abcdefghijklmnopqrstuvwxyz
console.log(buf1.toString('utf8', 0, 5));
// Prints: abcde

const buf2 = Buffer.from('tést');

console.log(buf2.toString('hex'));
// Prints: 74c3a97374
console.log(buf2.toString('utf8', 0, 3));
// Prints: té
console.log(buf2.toString(undefined, 0, 3));
// Prints: té
@sincev0.1.90
@paramencoding The character encoding to use.
@paramstart The byte offset to start decoding at.
@paramend The byte offset to stop decoding at (not inclusive).toString().String.trim(): string
Removes the leading and trailing white space and line terminator characters from a string.
trim()
		}
	}
};

轮询版本更改的间隔（以毫秒为单位）。如果这是 0，则不会发生轮询。

¥The interval in milliseconds to poll for version changes. If this is 0, no polling occurs.