type-alias / @typed/router/Path

QueryParams

Extracts decoded query-parameter fields from a route string.

Package version
1.0.0-beta.13
Category
Parameter inference
Since
1.0.0

Import

import type { QueryParams } from "@typed/router/Path";

Signatures

export type QueryParams<P extends string> = ParseAsts<P> extends infer Asts ? [
    Asts
] extends [
    never
] ? never : Asts extends ReadonlyArray<PathAst> ? ToReadonlyRecord<GetQueryParams<Asts>> : never : never;

Why

Declared query shapes remain visible independently of path parameters.

Ownership and lifetime

TypeScript computes QueryParams from the route literal or AST tuple supplied to it; the alias is erased and retains no runtime data.

Source