API Documentation • Docs

---

API Documentation / RouteLocationGeneric

Interface: RouteLocationGeneric

Generic version of RouteLocation. It is used when no RouteMap is provided.

Extends

• _RouteLocationBase

Extended by

• RouteLocationTyped
• RouteLocationResolvedGeneric

Properties

fullPath

fullPath: string

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

Inherited from

_RouteLocationBase.fullPath

---

hash

hash: string

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

Inherited from

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

---

meta

meta: RouteMeta

Merged meta properties from all the matched route records.

Inherited from

_RouteLocationBase.meta

---

name

name: null | RouteRecordNameGeneric

Name of the matched record

Inherited from

_RouteLocationBase.name

---

params

params: RouteParamsGeneric

Object of decoded params extracted from the path.

Inherited from

_RouteLocationBase.params

---

path

path: string

Percentage encoded pathname section of the URL.

Inherited from

_RouteLocationBase.path

---

query

query: LocationQuery

Object representation of the search property of the current location.

Inherited from

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