vue-router / RouteLocationTyped

RouteLocationTyped<RouteMap, Name>

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

Extends

• RouteLocationGeneric

Extended by

• RouteLocationResolvedTyped

Type Parameters

RouteMap

RouteMap extends RouteMapGeneric

Name

Name extends keyof RouteMap

Properties

force?

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

RouteLocationGeneric.force

---

fullPath

fullPath: string;

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

Inherited from

RouteLocationGeneric.fullPath

---

hash

hash: string;

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

Inherited from

RouteLocationGeneric.hash

---

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

RouteLocationGeneric.matched

---

meta

meta: RouteMeta;

Merged meta properties from all the matched route records.

Inherited from

MatcherLocation.meta

---

name

name: Extract<Name, string | symbol>;

Name of the matched record

Overrides

MatcherLocation.name

---

params

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

Object of decoded params extracted from the path.

Overrides

MatcherLocation.params

---

path

path: string;

Percentage encoded pathname section of the URL.

Inherited from

MatcherLocation.path

---

query

query: LocationQuery;

Object representation of the search property of the current location.

Inherited from

RouteLocationGeneric.query

---

redirectedFrom

redirectedFrom: undefined | RouteLocationGeneric;

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

Inherited from

_RouteLocationBase.redirectedFrom

---

replace?

optional replace: boolean;

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

Inherited from

RouteLocationGeneric.replace

---

state?

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

RouteLocationGeneric.state