Skip to content

API DocumentationDocs


API Documentation / _RouteLocationBase

Interface: _RouteLocationBase

Internal

Base properties for a normalized route location.

Extends

Extended by

Properties

fullPath

fullPath: string

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


hash

hash: string

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


meta

meta: RouteMeta

Merged meta properties from all the matched route records.

Inherited from

Pick.meta


name

name: null | RouteRecordNameGeneric

Name of the matched record

Inherited from

Pick.name


params

params: RouteParamsGeneric

Object of decoded params extracted from the path.

Inherited from

Pick.params


path

path: string

Percentage encoded pathname section of the URL.

Inherited from

Pick.path


query

query: LocationQuery

Object representation of the search property of the current location.


redirectedFrom

redirectedFrom: undefined | RouteLocationGeneric

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

Released under the MIT License.