API Documentation • Docs
API Documentation / RouteLocationTyped
Interface: RouteLocationTyped<RouteMap, Name>
Helper to generate a type safe version of the RouteLocation type.
Extends
Extended by
Type Parameters
• RouteMap extends RouteMapGeneric
• Name extends keyof RouteMap
Properties
fullPath
fullPath:
string
The whole location including the search
and hash
. This string is percentage encoded.
Inherited from
hash
hash:
string
Hash of the current location. If present, starts with a #
.
Inherited from
matched
matched:
RouteRecordNormalized
[]
Array of RouteRecord containing components as they were passed when adding records. It can also contain redirect records. This can't be used directly. This property is non-enumerable.
Inherited from
meta
meta:
RouteMeta
Merged meta
properties from all the matched route records.
Inherited from
name
name:
Extract
<Name
,string
|symbol
>
Name of the matched record
Overrides
params
params:
RouteMap
[Name
]["params"
]
Object of decoded params extracted from the path
.
Overrides
path
path:
string
Percentage encoded pathname section of the URL.
Inherited from
query
query:
LocationQuery
Object representation of the search
property of the current location.
Inherited from
redirectedFrom
redirectedFrom:
undefined
|RouteLocationGeneric
Contains the location we were initially trying to access before ending up on the current location.