Interface ParamsAdapter<Params>

An adapter that can validate and transform route params.

interface ParamsAdapter<Params extends Dict> {
    fromRawParams?(searchParams: Dict, pathnameParams: Dict): null | Params;
    toPathnameParams?(params: Params): Dict;
    toSearchParams?(params: Params): Dict;
}

Type Parameters

Params extends Dict
Route params.

Index

Methods

fromRawParams? toPathnameParams? toSearchParams?

Methods

`Optional`fromRawParams

fromRawParams?(searchParams: Dict, pathnameParams: Dict): null | Params
Converts params extracted from a Location.pathname and Location.searchParams to route params.
Parameters
- searchParams: Dict
  Params from Location.searchParams.
- pathnameParams: Dict
  Params from a Location.pathname.
Returns null | Params
Route params, or null if params are invalid.

`Optional`toPathnameParams

toPathnameParams?(params: 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: Params): Dict
Converts route params to Location.searchParams.
Parameters
- params: Params
  Route params.
Returns Dict
A dictionary that is used as Location.searchParams.

Interface ParamsAdapter<Params>

Type Parameters

Index

Methods

Methods

`Optional`fromRawParams

Parameters

Returns null | Params

`Optional`toPathnameParams

Parameters

Returns Dict

`Optional`toSearchParams

Parameters

Returns Dict

Settings

On This Page

Interface ParamsAdapter<Params>

Type Parameters

Index

Methods

Methods

OptionalfromRawParams

Parameters

Returns null | Params

OptionaltoPathnameParams

Parameters

Returns Dict

OptionaltoSearchParams

Parameters

Returns Dict

Settings

On This Page

`Optional`fromRawParams

`Optional`toPathnameParams

`Optional`toSearchParams