$app/types

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

import type { import RouteIdRouteId, import RouteParamsRouteParams, import LayoutParamsLayoutParams } from '$app/types';

Asset

A union of all the filenames of assets contained in your static directory.

type Asset = '/favicon.png' | '/robots.txt';

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]';

Pathname

A union of all valid pathnames in your app.

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

ResolvedPathname

Pathname, but possibly prefixed with a base path. Used for page.url.pathname.

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

RouteParams

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

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>;