Type Alias QueryParamDef

Declaration for a typed query param (?page=2 → useQueryParam('page')).

type QueryParamDef = {
    type?: ParamType | "array";
    default?: unknown;
    history?: "push" | "replace";
}

Properties

type?: ParamType | "array"

Value cast. 'array' collects repeated keys as string[]. Default: 'string'.

default?: unknown

Fallback when the key is absent or fails the cast. Values equal to the default are dropped from the URL on write.

history?: "push" | "replace"

How a write to this param lands in browser history. Unset → the convention: 'page' pushes, everything else replaces.