Types: RouterRoute<TRoute>

type RouterRoute<TRoute> = object;

Type Parameters

Type Parameter	Default type
TRoute extends ResolvedRoute	ResolvedRoute

Accessors

query

Get Signature

get query(): URLSearchParams;

Returns

URLSearchParams

Set Signature

set query(value): void;

Parameters

Parameter	Type
value	| string | URLSearchParams | string[][] | Record<string, string> | undefined

Returns

void

Properties

Property	Modifier	Type	Description
canonical	readonly	TRoute["canonical"]	String value of the route's own URL. The same as href unless the route was matched through an alias.
data	readonly	RouteDataOf<TRoute["matches"]>	What the route's loaders resolve to, keyed by loader name. A route whose only loader is unnamed exposes that loader's data here directly.
getTitle	readonly	TRoute["getTitle"]	Title of the route.
hash	readonly	string	Hash value of the route.
href	readonly	TRoute["href"]	String value of the resolved URL. When the route was matched through an alias this is the alias url.
id	readonly	TRoute["id"]	Unique identifier for the route, generated by router.
matched	readonly	TRoute["matched"]	The specific route properties that were matched in the current route.
matches	readonly	TRoute["matches"]	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.
name	readonly	TRoute["name"]	Identifier for the route as defined by user. Name must be unique among named routes. Name is used for routing and for matching.
params	public	TRoute["params"]	-
state	public	TRoute["state"]	-
update	readonly	RouteUpdate<TRoute>	Update the route.