Types

ts
import { enhance, applyAction } from '$app/forms';

ts
type SubmitFunction<
  Success extends Record<string, unknown> | undefined = Record<string, any>,
  Invalid extends Record<string, unknown> | undefined = Record<string, any>
> = (input: {
  action: URL;
  data: FormData;
  form: HTMLFormElement;
  controller: AbortController;
  cancel: () => void;
}) =>
  | void
  | ((opts: {
      form: HTMLFormElement;
      action: URL;
      result: ActionResult<Success, Invalid>;
      /**
       * Call this to get the default behavior of a form submission response.
       * @param options Set `reset: false` if you don't want the `<form>` values to be reset after a successful submission.
       */
      update: (options?: { reset: boolean }) => Promise<void>;
    }) => void);
 

ts
interface Action<
  Params extends Partial<Record<string, string>> = Partial<
    Record<string, string>
  >,
  OutputData extends Record<string, any> | void = Record<string, any> | void
> {
  (event: RequestEvent<Params>): MaybePromise<OutputData>;
}
 

ts
type ActionResult<
  Success extends Record<string, unknown> | undefined = Record<string, any>,
  Invalid extends Record<string, unknown> | undefined = Record<string, any>
> =
  | { type: 'success'; status: number; data?: Success }
  | { type: 'invalid'; status: number; data?: Invalid }
  | { type: 'redirect'; status: number; location: string }
  | { type: 'error'; error: any };
 

ts
type Actions<
  Params extends Partial<Record<string, string>> = Partial<
    Record<string, string>
  >,
  OutputData extends Record<string, any> | void = Record<string, any> | void
> = Record<string, Action<Params, OutputData>>;
 

ts
interface Adapter {
  name: string;
  adapt(builder: Builder): MaybePromise<void>;
}
 

ts
type AwaitedActions<T extends Record<string, (...args: any) => any>> = {
  [Key in keyof T]: OptionalUnion<
    UnpackValidationError<Awaited<ReturnType<T[Key]>>>
  >;
}[keyof T];
 

ts
type AwaitedProperties<input extends Record<string, any> | void> =
  AwaitedPropertiesUnion<input> extends Record<string, any>
    ? OptionalUnion<AwaitedPropertiesUnion<input>>
    : AwaitedPropertiesUnion<input>;
 

ts
interface Builder {
  log: Logger;
  rimraf(dir: string): void;
  mkdirp(dir: string): void;
 
  config: ValidatedConfig;
  prerendered: Prerendered;
 
  /**
   * Create entry points that map to individual functions
   * @param fn A function that groups a set of routes into an entry point
   */
  createEntries(fn: (route: RouteDefinition) => AdapterEntry): Promise<void>;
 
  generateManifest: (opts: {
    relativePath: string;
    format?: 'esm' | 'cjs';
  }) => string;
 
  getBuildDirectory(name: string): string;
  getClientDirectory(): string;
  getServerDirectory(): string;
  getStaticDirectory(): string;
  /** The application path including any configured base path */
  getAppPath(): string;
 
  /**
   * @param dest the destination folder to which files should be copied
   * @returns an array of paths corresponding to the files that have been created by the copy
   */
  writeClient(dest: string): string[];
  /**
   * @param dest
   */
  writePrerendered(
    dest: string,
    opts?: {
      fallback?: string;
    }
  ): string[];
  /**
   * @param dest the destination folder to which files should be copied
   * @returns an array of paths corresponding to the files that have been created by the copy
   */
  writeServer(dest: string): string[];
  /**
   * @param from the source file or folder
   * @param to the destination file or folder
   * @param opts.filter a function to determine whether a file or folder should be copied
   * @param opts.replace a map of strings to replace
   * @returns an array of paths corresponding to the files that have been created by the copy
   */
  copy(
    from: string,
    to: string,
    opts?: {
      filter?: (basename: string) => boolean;
      replace?: Record<string, string>;
    }
  ): string[];
 
  /**
   * @param {string} directory Path to the directory containing the files to be compressed
   */
  compress(directory: string): Promise<void>;
}
 

ts
interface Config {
  compilerOptions?: CompileOptions;
  extensions?: string[];
  kit?: KitConfig;
  package?: {
    source?: string;
    dir?: string;
    emitTypes?: boolean;
    exports?: (filepath: string) => boolean;
    files?: (filepath: string) => boolean;
  };
  preprocess?: any;
  [key: string]: any;
}
 

ts
interface Cookies {
  /**
   * Gets a cookie that was previously set with `cookies.set`, or from the request headers.
   */
  get(
    name: string,
    opts?: import('cookie').CookieParseOptions
  ): string | undefined;
 
  /**
   * Sets a cookie. This will add a `set-cookie` header to the response, but also make the cookie available via `cookies.get` during the current request.
   *
   * The `httpOnly` and `secure` options are `true` by default (except on http://localhost, where `secure` is `false`), and must be explicitly disabled if you want cookies to be readable by client-side JavaScript and/or transmitted over HTTP. The `sameSite` option defaults to `lax`.
   *
   * By default, the `path` of a cookie is the 'directory' of the current pathname. In most cases you should explicitly set `path: '/'` to make the cookie available throughout your app.
   */
  set(
    name: string,
    value: string,
    opts?: import('cookie').CookieSerializeOptions
  ): void;
 
  /**
   * Deletes a cookie by setting its value to an empty string and setting the expiry date in the past.
   */
  delete(name: string, opts?: import('cookie').CookieSerializeOptions): void;
 
  /**
   * Serialize a cookie name-value pair into a Set-Cookie header string.
   *
   * The `httpOnly` and `secure` options are `true` by default (except on http://localhost, where `secure` is `false`), and must be explicitly disabled if you want cookies to be readable by client-side JavaScript and/or transmitted over HTTP. The `sameSite` option defaults to `lax`.
   *
   * By default, the `path` of a cookie is the current pathname. In most cases you should explicitly set `path: '/'` to make the cookie available throughout your app.
   *
   * @param name the name for the cookie
   * @param value value to set the cookie to
   * @param options object containing serialization options
   */
  serialize(
    name: string,
    value: string,
    opts?: import('cookie').CookieSerializeOptions
  ): string;
}
 

ts
interface Handle {
  (input: {
    event: RequestEvent;
    resolve(event: RequestEvent, opts?: ResolveOptions): MaybePromise<Response>;
  }): MaybePromise<Response>;
}
 

ts
interface HandleClientError {
  (input: { error: unknown; event: NavigationEvent }): void | App.Error;
}
 

ts
interface HandleFetch {
  (input: {
    event: RequestEvent;
    request: Request;
    fetch: typeof fetch;
  }): MaybePromise<Response>;
}
 

ts
interface HandleServerError {
  (input: { error: unknown; event: RequestEvent }): void | App.Error;
}
 

ts
interface KitConfig {
  adapter?: Adapter;
  alias?: Record<string, string>;
  appDir?: string;
  csp?: {
    mode?: 'hash' | 'nonce' | 'auto';
    directives?: CspDirectives;
    reportOnly?: CspDirectives;
  };
  csrf?: {
    checkOrigin?: boolean;
  };
  env?: {
    dir?: string;
    publicPrefix?: string;
  };
  moduleExtensions?: string[];
  files?: {
    assets?: string;
    hooks?: {
      client?: string;
      server?: string;
    };
    lib?: string;
    params?: string;
    routes?: string;
    serviceWorker?: string;
    appTemplate?: string;
    errorTemplate?: string;
  };
  inlineStyleThreshold?: number;
  outDir?: string;
  paths?: {
    assets?: string;
    base?: string;
  };
  prerender?: {
    concurrency?: number;
    crawl?: boolean;
    default?: boolean;
    enabled?: boolean;
    entries?: Array<'*' | `/${string}`>;
    onError?: PrerenderOnErrorValue;
    origin?: string;
  };
  serviceWorker?: {
    register?: boolean;
    files?: (filepath: string) => boolean;
  };
  trailingSlash?: TrailingSlash;
  version?: {
    name?: string;
    pollInterval?: number;
  };
}
 

ts
interface Load<
  Params extends Partial<Record<string, string>> = Partial<
    Record<string, string>
  >,
  InputData extends Record<string, unknown> | null = Record<string, any> | null,
  ParentData extends Record<string, unknown> = Record<string, any>,
  OutputData extends Record<string, unknown> | void = Record<string, any> | void
> {
  (event: LoadEvent<Params, InputData, ParentData>): MaybePromise<OutputData>;
}
 

ts
interface LoadEvent<
  Params extends Partial<Record<string, string>> = Partial<
    Record<string, string>
  >,
  Data extends Record<string, unknown> | null = Record<string, any> | null,
  ParentData extends Record<string, unknown> = Record<string, any>
> extends NavigationEvent<Params> {
  /**
   * `fetch` is equivalent to the [native `fetch` web API](https://developer.mozilla.org/en-US/docs/Web/API/fetch), with a few additional features:
   *
   * - it can be used to make credentialed requests on the server, as it inherits the `cookie` and `authorization` headers for the page request
   * - it can make relative requests on the server (ordinarily, `fetch` requires a URL with an origin when used in a server context)
   * - internal requests (e.g. for `+server.js` routes) go directly to the handler function when running on the server, without the overhead of an HTTP call
   * - during server-side rendering, the response will be captured and inlined into the rendered HTML. Note that headers will _not_ be serialized, unless explicitly included via [`filterSerializedResponseHeaders`](https://kit.svelte.dev/docs/hooks#server-hooks-handle)
   * - during hydration, the response will be read from the HTML, guaranteeing consistency and preventing an additional network request
   *
   * > Cookies will only be passed through if the target host is the same as the SvelteKit application or a more specific subdomain of it.
   */
  fetch: typeof fetch;
  /**
   * Contains the data returned by the route's server `load` function (in `+layout.server.js` or `+page.server.js`), if any.
   */
  data: Data;
  /**
   * If you need to set headers for the response, you can do so using the this method. This is useful if you want the page to be cached, for example:
   *
   *	```js
   *	/// 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();
   *	}
   *	```
   *
   * Setting the same header multiple times (even in separate `load` functions) is an error — you can only set a given header once.
   *
   * You cannot add a `set-cookie` header with `setHeaders` — use the [`cookies`](https://kit.svelte.dev/docs/types#sveltejs-kit-cookies) API in a server-only `load` function instead.
   *
   * `setHeaders` has no effect when a `load` function runs in the browser.
   */
  setHeaders: (headers: Record<string, string>) => void;
  /**
   * `await parent()` returns data from parent `+layout.js` `load` functions.
   * Implicitly, a missing `+layout.js` is treated as a `({ data }) => data` function, meaning that it will return and forward data from parent `+layout.server.js` files.
   *
   * Be careful not to introduce accidental waterfalls when using `await parent()`. If for example you only want to merge parent data into the returned output, call it _after_ fetching your other data.
   */
  parent: () => Promise<ParentData>;
  /**
   * This function declares that the `load` function has a _dependency_ on one or more URLs or custom identifiers, which can subsequently be used with [`invalidate()`](/docs/modules#$app-navigation-invalidate) to cause `load` to rerun.
   *
   * Most of the time you won't need this, as `fetch` calls `depends` on your behalf — it's only necessary if you're using a custom API client that bypasses `fetch`.
   *
   * URLs can be absolute or relative to the page being loaded, and must be [encoded](https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding).
   *
   * Custom identifiers have to be prefixed with one or more lowercase letters followed by a colon to conform to the [URI specification](https://www.rfc-editor.org/rfc/rfc3986.html).
   *
   * The following example shows how to use `depends` to register a dependency on a custom identifier, which is `invalidate`d after a button click, making the `load` function rerun.
   *
   * ```js
   * /// 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
   * <script>
   * 	import { invalidate } from '$app/navigation';
   *
   * 	export let data;
   *
   * 	const increase = async () => {
   * 		await invalidate('increase:count');
   * 	}
   * </script>
   *
   * <p>{data.count}<p>
   * <button on:click={increase}>Increase Count</button>
   * ```
   */
  depends: (...deps: string[]) => void;
}
 

ts
interface Navigation {
  from: NavigationTarget | null;
  to: NavigationTarget | null;
  type: NavigationType;
  delta?: number;
}
 

ts
interface NavigationEvent<
  Params extends Partial<Record<string, string>> = Partial<
    Record<string, string>
  >
> {
  /**
   * The parameters of the current page - e.g. for a route like `/blog/[slug]`, the `slug` parameter
   */
  params: Params;
  /**
   * The route ID of the current page - e.g. for `src/routes/blog/[slug]`, it would be `blog/[slug]`
   */
  routeId: string | null;
  /**
   * The URL of the current page
   */
  url: URL;
}
 

ts
interface NavigationTarget {
  params: Record<string, string> | null;
  routeId: string | null;
  url: URL;
}
 

ts
type NavigationType = 'load' | 'unload' | 'link' | 'goto' | 'popstate';
 

ts
interface Page<Params extends Record<string, string> = Record<string, string>> {
  /**
   * The URL of the current page
   */
  url: URL;
  /**
   * The parameters of the current page - e.g. for a route like `/blog/[slug]`, the `slug` parameter
   */
  params: Params;
  /**
   * The route ID of the current page - e.g. for `src/routes/blog/[slug]`, it would be `blog/[slug]`
   */
  routeId: string | null;
  /**
   * Http status code of the current page
   */
  status: number;
  /**
   * The error object of the current page, if any. Filled from the `handleError` hooks.
   */
  error: App.Error | null;
  /**
   * The merged result of all data from all `load` functions on the current page. You can type a common denominator through `App.PageData`.
   */
  data: App.PageData & Record<string, any>;
  /**
   * Filled only after a form submission. See [form actions](https://kit.svelte.dev/docs/form-actions) for more info.
   */
  form: any;
}
 

ts
interface ParamMatcher {
  (param: string): boolean;
}
 

ts
interface RequestEvent<
  Params extends Partial<Record<string, string>> = Partial<
    Record<string, string>
  >
> {
  /**
   * Get or set cookies related to the current request
   */
  cookies: Cookies;
  /**
   * `fetch` is equivalent to the [native `fetch` web API](https://developer.mozilla.org/en-US/docs/Web/API/fetch), with a few additional features:
   *
   * - it can be used to make credentialed requests on the server, as it inherits the `cookie` and `authorization` headers for the page request
   * - it can make relative requests on the server (ordinarily, `fetch` requires a URL with an origin when used in a server context)
   * - internal requests (e.g. for `+server.js` routes) go directly to the handler function when running on the server, without the overhead of an HTTP call
   *
   * > Cookies will only be passed through if the target host is the same as the SvelteKit application or a more specific subdomain of it.
   */
  fetch: typeof fetch;
  /**
   * The client's IP address, set by the adapter.
   */
  getClientAddress: () => string;
  /**
   * Contains custom data that was added to the request within the [`handle hook`](https://kit.svelte.dev/docs/hooks#server-hooks-handle).
   */
  locals: App.Locals;
  /**
   * The parameters of the current page or endpoint - e.g. for a route like `/blog/[slug]`, the `slug` parameter
   */
  params: Params;
  /**
   * Additional data made available through the adapter.
   */
  platform: Readonly<App.Platform>;
  /**
   * The original request object
   */
  request: Request;
  /**
   * The route ID of the current page - e.g. for `src/routes/blog/[slug]`, it would be `blog/[slug]`
   */
  routeId: string | null;
  /**
   * If you need to set headers for the response, you can do so using the this method. This is useful if you want the page to be cached, for example:
   *
   *	```js
   *	/// 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();
   *	}
   *	```
   *
   * Setting the same header multiple times (even in separate `load` functions) is an error — you can only set a given header once.
   *
   * You cannot add a `set-cookie` header with `setHeaders` — use the [`cookies`](https://kit.svelte.dev/docs/types#sveltejs-kit-cookies) API instead.
   */
  setHeaders: (headers: Record<string, string>) => void;
  /**
   * The URL of the current page or endpoint
   */
  url: URL;
}
 

ts
interface RequestHandler<
  Params extends Partial<Record<string, string>> = Partial<
    Record<string, string>
  >
> {
  (event: RequestEvent<Params>): MaybePromise<Response>;
}
 

ts
interface ResolveOptions {
  transformPageChunk?: (input: {
    html: string;
    done: boolean;
  }) => MaybePromise<string | undefined>;
  filterSerializedResponseHeaders?: (name: string, value: string) => boolean;
}
 

ts
interface SSRManifest {
  appDir: string;
  appPath: string;
  assets: Set<string>;
  mimeTypes: Record<string, string>;
 
  /** private fields */
  _: {
    entry: {
      file: string;
      imports: string[];
      stylesheets: string[];
    };
    nodes: SSRNodeLoader[];
    routes: SSRRoute[];
    matchers: () => Promise<Record<string, ParamMatcher>>;
  };
}
 

ts
class Server {
  constructor(manifest: SSRManifest);
  init(options: ServerInitOptions): Promise<void>;
  respond(request: Request, options: RequestOptions): Promise<Response>;
}
 

ts
interface ServerInitOptions {
  env: Record<string, string>;
}
 

ts
interface ServerLoad<
  Params extends Partial<Record<string, string>> = Partial<
    Record<string, string>
  >,
  ParentData extends Record<string, any> = Record<string, any>,
  OutputData extends Record<string, any> | void = Record<string, any> | void
> {
  (event: ServerLoadEvent<Params, ParentData>): MaybePromise<OutputData>;
}
 

ts
interface ServerLoadEvent<
  Params extends Partial<Record<string, string>> = Partial<
    Record<string, string>
  >,
  ParentData extends Record<string, any> = Record<string, any>
> extends RequestEvent<Params> {
  /**
   * `await parent()` returns data from parent `+layout.server.js` `load` functions.
   *
   * Be careful not to introduce accidental waterfalls when using `await parent()`. If for example you only want to merge parent data into the returned output, call it _after_ fetching your other data.
   */
  parent: () => Promise<ParentData>;
  /**
   * This function declares that the `load` function has a _dependency_ on one or more URLs or custom identifiers, which can subsequently be used with [`invalidate()`](/docs/modules#$app-navigation-invalidate) to cause `load` to rerun.
   *
   * Most of the time you won't need this, as `fetch` calls `depends` on your behalf — it's only necessary if you're using a custom API client that bypasses `fetch`.
   *
   * URLs can be absolute or relative to the page being loaded, and must be [encoded](https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding).
   *
   * Custom identifiers have to be prefixed with one or more lowercase letters followed by a colon to conform to the [URI specification](https://www.rfc-editor.org/rfc/rfc3986.html).
   *
   * The following example shows how to use `depends` to register a dependency on a custom identifier, which is `invalidate`d after a button click, making the `load` function rerun.
   *
   * ```js
   * /// 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
   * <script>
   * 	import { invalidate } from '$app/navigation';
   *
   * 	export let data;
   *
   * 	const increase = async () => {
   * 		await invalidate('increase:count');
   * 	}
   * </script>
   *
   * <p>{data.count}<p>
   * <button on:click={increase}>Increase Count</button>
   * ```
   */
  depends: (...deps: string[]) => void;
}
 

ts
interface ValidationError<
  T extends Record<string, unknown> | undefined = undefined
> extends UniqueInterface {
  status: number;
  data: T;
}
 

ts
interface AdapterEntry {
  /**
   * A string that uniquely identifies an HTTP service (e.g. serverless function) and is used for deduplication.
   * For example, `/foo/a-[b]` and `/foo/[c]` are different routes, but would both
   * be represented in a Netlify _redirects file as `/foo/:param`, so they share an ID
   */
  id: string;
 
  /**
   * A function that compares the candidate route with the current route to determine
   * if it should be treated as a fallback for the current route. For example, `/foo/[c]`
   * is a fallback for `/foo/a-[b]`, and `/[...catchall]` is a fallback for all routes
   */
  filter: (route: RouteDefinition) => boolean;
 
  /**
   * A function that is invoked once the entry has been created. This is where you
   * should write the function to the filesystem and generate redirect manifests.
   */
  complete: (entry: {
    generateManifest: (opts: {
      relativePath: string;
      format?: 'esm' | 'cjs';
    }) => string;
  }) => MaybePromise<void>;
}
 

ts
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[];
  type UriPath = `${HttpDelineator}${string}`;
}
 

ts
interface CspDirectives {
  'child-src'?: Csp.Sources;
  'default-src'?: Array<Csp.Source | Csp.ActionSource>;
  'frame-src'?: Csp.Sources;
  'worker-src'?: Csp.Sources;
  'connect-src'?: Csp.Sources;
  'font-src'?: Csp.Sources;
  'img-src'?: Csp.Sources;
  'manifest-src'?: Csp.Sources;
  'media-src'?: Csp.Sources;
  'object-src'?: Csp.Sources;
  'prefetch-src'?: Csp.Sources;
  'script-src'?: Array<Csp.Source | Csp.ActionSource>;
  'script-src-elem'?: Csp.Sources;
  'script-src-attr'?: Csp.Sources;
  'style-src'?: Array<Csp.Source | Csp.ActionSource>;
  'style-src-elem'?: Csp.Sources;
  'style-src-attr'?: Csp.Sources;
  'base-uri'?: Array<Csp.Source | Csp.ActionSource>;
  sandbox?: Array<
    | 'allow-downloads-without-user-activation'
    | 'allow-forms'
    | 'allow-modals'
    | 'allow-orientation-lock'
    | 'allow-pointer-lock'
    | 'allow-popups'
    | 'allow-popups-to-escape-sandbox'
    | 'allow-presentation'
    | 'allow-same-origin'
    | 'allow-scripts'
    | 'allow-storage-access-by-user-activation'
    | 'allow-top-navigation'
    | 'allow-top-navigation-by-user-activation'
  >;
  'form-action'?: Array<Csp.Source | Csp.ActionSource>;
  'frame-ancestors'?: Array<
    Csp.HostSource | Csp.SchemeSource | Csp.FrameSource
  >;
  'navigate-to'?: Array<Csp.Source | Csp.ActionSource>;
  'report-uri'?: Csp.UriPath[];
  'report-to'?: string[];
 
  'require-trusted-types-for'?: Array<'script'>;
  'trusted-types'?: Array<'none' | 'allow-duplicates' | '*' | string>;
  'upgrade-insecure-requests'?: boolean;
 
  /** @deprecated */
  'require-sri-for'?: Array<'script' | 'style' | 'script style'>;
 
  /** @deprecated */
  'block-all-mixed-content'?: boolean;
 
  /** @deprecated */
  'plugin-types'?: Array<`${string}/${string}` | 'none'>;
 
  /** @deprecated */
  referrer?: Array<
    | 'no-referrer'
    | 'no-referrer-when-downgrade'
    | 'origin'
    | 'origin-when-cross-origin'
    | 'same-origin'
    | 'strict-origin'
    | 'strict-origin-when-cross-origin'
    | 'unsafe-url'
    | 'none'
  >;
}
 

ts
type HttpMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
 

ts
interface Logger {
  (msg: string): void;
  success(msg: string): void;
  error(msg: string): void;
  warn(msg: string): void;
  minor(msg: string): void;
  info(msg: string): void;
}
 

ts
type MaybePromise<T> = T | Promise<T>;
 

ts
interface PrerenderErrorHandler {
  (details: {
    status: number;
    path: string;
    referrer: string | null;
    referenceType: 'linked' | 'fetched';
  }): void;
}
 

ts
type PrerenderMap = Map<string, PrerenderOption>;
 

ts
type PrerenderOnErrorValue = 'fail' | 'continue' | PrerenderErrorHandler;
 

ts
type PrerenderOption = boolean | 'auto';
 

ts
interface Prerendered {
  pages: Map<
    string,
    {
      /** The location of the .html file relative to the output directory */
      file: string;
    }
  >;
  assets: Map<
    string,
    {
      /** The MIME type of the asset */
      type: string;
    }
  >;
  redirects: Map<
    string,
    {
      status: number;
      location: string;
    }
  >;
  /** An array of prerendered paths (without trailing slashes, regardless of the trailingSlash config) */
  paths: string[];
}
 

ts
interface RequestOptions {
  getClientAddress: () => string;
  platform?: App.Platform;
}
 

ts
interface RouteDefinition {
  id: string;
  pattern: RegExp;
  segments: RouteSegment[];
  methods: HttpMethod[];
}
 

ts
interface RouteSegment {
  content: string;
  dynamic: boolean;
  rest: boolean;
}
 

ts
type TrailingSlash = 'never' | 'always' | 'ignore';
 

ts
interface UniqueInterface {
  readonly [uniqueSymbol]: unknown;
}
 

ts
/// <reference types="@sveltejs/kit" />
 
declare namespace App {
  interface Locals {}
 
  interface PageData {}
 
  interface Platform {}
}

ts
interface Locals {
  user: import('$lib/types').User;
}

ts
import { User } from '$lib/types';
 
declare global {
  namespace App {
    interface Locals {
      user: User;
    }
    // ...
  }
}

ts
interface Error {
  message: string;
}
 

ts
interface Locals {}
 

ts
interface PageData {}
 

ts
interface Platform {}
 

.svelte-kit/types/src/routes/[foo]/[bar]/[baz]/$types.d.ts

ts
import type * as Kit from '@sveltejs/kit';
 
type RouteParams = {
  foo: string;
  bar: string;
  baz: string;
}
 
export type PageServerLoad = Kit.ServerLoad<RouteParams>;
export type PageLoad = Kit.Load<RouteParams>;

.svelte-kit/tsconfig.json

{
  "compilerOptions": {
    "baseUrl": "..",
    "paths": {
      "$lib": "src/lib",
      "$lib/*": "src/lib/*"
    },
    "rootDirs": ["..", "./types"]
  },
  "include": ["../src/**/*.js", "../src/**/*.ts", "../src/**/*.svelte"],
  "exclude": ["../node_modules/**", "./**"]
}

.svelte-kit/tsconfig.json

{
  "compilerOptions": {
    // this ensures that types are explicitly
    // imported with `import type`, which is
    // necessary as svelte-preprocess cannot
    // otherwise compile components correctly
    "importsNotUsedAsValues": "error",

    // Vite compiles one TypeScript module
    // at a time, rather than compiling
    // the entire module graph
    "isolatedModules": true,

    // TypeScript cannot 'see' when you
    // use an imported value in your
    // markup, so we need this
    "preserveValueImports": true,

    // This ensures both `vite build`
    // and `svelte-package` work correctly
    "lib": ["esnext", "DOM", "DOM.Iterable"],
    "moduleResolution": "node",
    "module": "esnext",
    "target": "esnext"
  }
}