Become a sponsor
API Documentation / RouteLocationNormalizedTyped
Interface: RouteLocationNormalizedTyped<RouteMap, Name>
Helper to generate a type safe version of the RouteLocationNormalized type.
Type parameters
| Name | Type |
|---|---|
RouteMap | extends RouteMapGeneric = RouteMapGeneric |
Name | extends keyof RouteMap = keyof RouteMap |
Hierarchy
RouteLocationNormalizedGeneric↳
RouteLocationNormalizedTyped
Properties
fullPath
• fullPath: string
The whole location including the search and hash. This string is percentage encoded.
Inherited from
RouteLocationNormalizedGeneric.fullPath
hash
• hash: string
Hash of the current location. If present, starts with a #.
Inherited from
RouteLocationNormalizedGeneric.hash
matched
• matched: RouteRecordNormalized[]
Array of RouteRecordNormalized
Overrides
RouteLocationNormalizedGeneric.matched
meta
• meta: RouteMeta
Merged meta properties from all the matched route records.
Inherited from
RouteLocationNormalizedGeneric.meta
name
• name: Extract<Name, string | symbol>
Name of the matched record
Overrides
RouteLocationNormalizedGeneric.name
params
• params: RouteMap[Name]["params"]
Object of decoded params extracted from the path.
Overrides
RouteLocationNormalizedGeneric.params
path
• path: string
Percentage encoded pathname section of the URL.
Inherited from
RouteLocationNormalizedGeneric.path
query
• query: LocationQuery
Object representation of the search property of the current location.
Inherited from
RouteLocationNormalizedGeneric.query
redirectedFrom
• redirectedFrom: undefined | RouteLocationGeneric
Contains the location we were initially trying to access before ending up on the current location.