Skip to content

ResolvedRoute

Represents a route that the router has matched to current browser location.

Type parameters

Type parameterDescription
TKey extends RouteRepresents the unique key identifying the route, typically a string.

Type declaration

key

ts
key: TKey;

Unique identifier for the route, generated by joining route name by period. Key is used for routing and for matching.

matched

ts
matched: RouteProps;

The specific route properties that were matched in the current route. RouteProps

matches

ts
matches: RouteProps[];

The specific route properties that were matched in the current route, including any ancestors. Order of routes will be from greatest ancestor to narrowest matched. RouteProps

query

ts
query: ResolvedRouteQuery;

Accessor for query string values from user in the current browser location. ResolvedRouteQuery

params

ts
params: ExtractRouteParamTypes<TRoute>;

Key value pair for route params, values will be the user provided value from current browser location.