Skip to content

vue-router / RouteLocationNormalizedTyped

RouteLocationNormalizedTyped<RouteMap, Name> ​

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

Extends ​

Type Parameters ​

RouteMap ​

RouteMap extends { [K in keyof RouteMap]: RouteRecordInfoGeneric } = RouteMapGeneric

Name ​

Name extends keyof RouteMap = keyof RouteMap

Properties ​

fullPath ​

ts
fullPath: string;

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

Inherited from ​

RouteLocationNormalizedGeneric.fullPath


hash ​

ts
hash: string;

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

Inherited from ​

RouteLocationNormalizedGeneric.hash


matched ​

ts
matched: RouteRecordNormalized[];

Array of RouteRecordNormalized

Overrides ​

RouteLocationNormalizedGeneric.matched


meta ​

ts
meta: RouteMeta;

Merged meta properties from all the matched route records.

Inherited from ​

MatcherLocation.meta


name ​

ts
name: Extract<Name, string | symbol>;

Name of the matched record

Overrides ​

RouteLocationNormalizedGeneric.name


params ​

ts
params: RouteMap[Name]["params"];

Object of decoded params extracted from the path.

Overrides ​

MatcherLocation.params


path ​

ts
path: string;

Percentage encoded pathname section of the URL.

Inherited from ​

MatcherLocation.path


query ​

ts
query: LocationQuery;

Object representation of the search property of the current location.

Inherited from ​

RouteLocationNormalizedGeneric.query


redirectedFrom ​

ts
redirectedFrom: RouteLocationGeneric | undefined;

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

Inherited from ​

_RouteLocationBase.redirectedFrom

Released under the MIT License.