Skip to content

Complete guide to

Mastering Pinia

written by its creator

API Documentation / RouteLocation

Interface: RouteLocation

RouteLocationRaw resolved using the matcher

Hierarchy

  • _RouteLocationBase

    RouteLocation

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


meta

meta: RouteMeta

Merged meta properties from all the matched route records.

Inherited from

_RouteLocationBase.meta


name

name: undefined | null | RouteRecordName

Name of the matched record

Inherited from

_RouteLocationBase.name


params

params: RouteParams

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 | RouteLocation

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.