Skip to content

API Documentation / RouteLocationNormalizedLoadedTyped

Interface: RouteLocationNormalizedLoadedTyped<RouteMap, Name>

Helper to generate a type safe version of the RouteLocationNormalizedLoaded type.

Type parameters

NameType
RouteMapextends RouteMapGeneric = RouteMapGeneric
Nameextends keyof RouteMap = keyof RouteMap

Hierarchy

Properties

fullPath

fullPath: string

The whole location including the search and hash. This string is percentage encoded.

Inherited from

RouteLocationNormalizedLoadedGeneric.fullPath


hash

hash: string

Hash of the current location. If present, starts with a #.

Inherited from

RouteLocationNormalizedLoadedGeneric.hash


matched

matched: RouteLocationMatched[]

Array of RouteLocationMatched containing only plain components (any lazy-loaded components have been loaded and were replaced inside the components object) so it can be directly used to display routes. It cannot contain redirect records either. This property is non-enumerable.

Inherited from

RouteLocationNormalizedLoadedGeneric.matched


meta

meta: RouteMeta

Merged meta properties from all the matched route records.

Inherited from

RouteLocationNormalizedLoadedGeneric.meta


name

name: Extract<Name, string | symbol>

Name of the matched record

Overrides

RouteLocationNormalizedLoadedGeneric.name


params

params: RouteMap[Name]["params"]

Object of decoded params extracted from the path.

Overrides

RouteLocationNormalizedLoadedGeneric.params


path

path: string

Percentage encoded pathname section of the URL.

Inherited from

RouteLocationNormalizedLoadedGeneric.path


query

query: LocationQuery

Object representation of the search property of the current location.

Inherited from

RouteLocationNormalizedLoadedGeneric.query


redirectedFrom

redirectedFrom: undefined | RouteLocationGeneric

Contains the location we were initially trying to access before ending up on the current location.

Inherited from

RouteLocationNormalizedLoadedGeneric.redirectedFrom

Released under the MIT License.