Skip to content

vue-router / RouteLocationResolvedTyped

RouteLocationResolvedTyped<RouteMap, Name>

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

Extends

Type Parameters

RouteMap

RouteMap extends RouteMapGeneric

Name

Name extends keyof RouteMap

Properties

force?

ts
optional force: boolean;

Triggers the navigation even if the location is the same as the current one. Note this will also add a new entry to the history unless replace: true is passed.

Inherited from

RouteLocationTyped.force


fullPath

ts
fullPath: string;

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

Inherited from

RouteLocationTyped.fullPath


hash

ts
hash: string;

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

Inherited from

RouteLocationTyped.hash


href

ts
href: string;

Resolved href for the route location that will be set on the <a href="...">.


matched

ts
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

RouteLocationTyped.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

Inherited from

RouteLocationTyped.name


params

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

Object of decoded params extracted from the path.

Inherited from

RouteLocationTyped.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

RouteLocationTyped.query


redirectedFrom

ts
redirectedFrom: undefined | RouteLocationGeneric;

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

Inherited from

RouteLocationTyped.redirectedFrom


replace?

ts
optional replace: boolean;

Replace the entry in the history instead of pushing a new entry

Inherited from

RouteLocationTyped.replace


state?

ts
optional state: HistoryState;

State to save using the History API. This cannot contain any reactive values and some primitives like Symbols are forbidden. More info at https://developer.mozilla.org/en-US/docs/Web/API/History/state

Inherited from

RouteLocationTyped.state

Released under the MIT License.