RouteLocation

Resolved route location information.

Type Definition

interface RouteLocation {
  path: string
  name?: string
  meta: RouteMeta
  query: Record<string, string>
  fullPath: string
}

Properties

path

• Type: string
• Description: Normalized path (starts with /)

name

• Type: string | undefined
• Description: Route name, undefined for routes without a name configured

meta

• Type: RouteMeta
• Description: Route meta information, empty object {} when not configured

query

• Type: Record<string, string>
• Description: Query parameter key-value pairs, empty object {} when no parameters

fullPath

• Type: string
• Description: Full path (including query parameters), e.g. /pages/about/about?id=1

Related Types

RouteLocationRaw

Raw route location, the parameter type accepted by navigation methods:

type RouteLocationRaw = string | RouteLocationPathRaw | RouteLocationNamedRaw

RouteLocationPathRaw

Path-based raw route location:

interface RouteLocationPathRaw {
  path: string
  query?: Record<string, string>
}

RouteLocationNamedRaw

Name-based raw route location:

interface RouteLocationNamedRaw {
  name: string
  query?: Record<string, string>
}

Example

const location = router.resolve({ name: 'about', query: { id: '1' } })
// {
//   path: '/pages/about/about',
//   name: 'about',
//   meta: { requireAuth: true },
//   query: { id: '1' },
//   fullPath: '/pages/about/about?id=1'
// }