Skip to main content
SvelteKitReference

$app/types

This module contains generated types for the routes in your app.

Available since 2.26

import type { type RouteId = string
A union of all the route IDs in your app. Used for page.route.id and event.route.id.


reference
RouteId, type RouteParams<T extends RouteId> = T extends string ? Record<string, string> : Record<string, never>
A utility for getting the parameters associated with a given route.


reference
RouteParams, type LayoutParams<T extends RouteId> = T extends string ? Record<string, string> : Record<string, never>
A utility for getting the parameters associated with a given layout, which is similar to RouteParams but also includes optional parameters for any child route.


reference
LayoutParams } from '$app/types';

AssetPath

A union of all the filenames of assets contained in your static directory, relative to the base path.

type AssetPath = 'favicon.png' | 'robots.txt' | (string & {});

RouteId

A union of all the route IDs in your app. Used for page.route.id and event.route.id.

type RouteId = '/' | '/my-route' | '/my-other-route/[param]';

Path

A union of all valid paths in your app, relative to the base path.

type Path = '' | 'my-route' | `my-other-route/${string}` & {};

ResolvedPathname

Similar to Path, but prefixed with a base path. Used for page.url.pathname.

type ResolvedPathname = `${'' | `/${string}`}/` | `${'' | `/${string}`}/my-route` | `${'' | `/${string}`}/my-other-route/${string}` | {};

RouteParams

A utility for getting the parameters associated with a given route.

type type BlogParams = RouteParams<"/blog/[slug]">BlogParams = RouteParams<'/blog/[slug]'>; // { slug: string }

type RouteParams<T extends RouteId> = { /* generated */ } | Record<string, never>;

LayoutParams

A utility for getting the parameters associated with a given layout, which is similar to RouteParams but also includes optional parameters for any child route.

type RouteParams<T extends RouteId> = { /* generated */ } | Record<string, never>;

Edit this page on GitHub llms.txt

previous next
$app/stores