$app/types

Ce module contient les types générés pour les routes de votre application.

Disponible depuis la version 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.
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.
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.
LayoutParams } from '$app/types';

Asset

Une union de tous les chemins de fichiers des assets contenus dans votre dossier static, plus un joker string pour les chemins de fichiers générés depuis les déclarations d’import.

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

RouteId

Une union de tous les ID de route de votre application. Utilisée pour page.route.id et event.route.id.

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

Pathname

Une union de tous les chemins valides de votre application.

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

ResolvedPathname

Similaire à Pathname, mais possiblement préfixé avec un chemin de base. Utilisé pour page.url.pathname.

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

RouteParams

Un utilitaire pour récupérer les paramètres associés avec une route donnée.

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

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

LayoutParams

Un utilitaire pour récupérer les paramètres associés avec un layout donné, similaire à RouteParams mais inclut également des paramètres optionnels pour toute route enfant.

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