ResolvedRoute

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

Type parameters

Type parameter	Description
TName extends Route	Represents the unique name identifying the route.

Type declaration

name

name: TName;

Unique identifier for the route. Name is used for routing and for matching.

matched

matched: CreateRouteOptions;

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

matches

matches: CreateRouteOptions[];

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. CreateRouteOptions

query

query: ResolvedRouteQuery;

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

hash

hash?: string;

Accessor for hash string value (or undefined) from user in the current browser location.

params

params: ExtractRouteParamTypes<TRoute>;

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