Interface ParamsAdapter<Params>

An adapter that can validate and transform route params.

interface ParamsAdapter<Params> {
    parse(params: Dict): Params;
    toPathnameParams?(params: Params): Dict;
    toSearchParams?(params: Params): Dict;
}

Type Parameters

Params
Route params.

Index

Methods

parse toPathnameParams? toSearchParams?

Methods

parse

parse(params): Params
Validates and transforms params extracted from a Location.pathname and Location.searchParams.
Parameters
- params: Dict
  A dictionary that contains both pathname and search params.
Returns Params
Route params.

`Optional`toPathnameParams

toPathnameParams(params): Dict
Converts route params to Location.pathname params.
Parameters
- params: Params
  Route params.
Returns Dict
Params that should be substituted into a location pathname.

`Optional`toSearchParams

toSearchParams(params): Dict
Converts route params to Location.searchParams.
Parameters
- params: Params
  Route params.
Returns Dict
A dictionary that is used as Location.searchParams.