API Documentation • Docs

---

API Documentation / RouteRecordRedirect

Interface: RouteRecordRedirect

Route Record that defines a redirect. Cannot have component or components as it is never rendered.

Extends

• _RouteRecordBase

Properties

alias?

optional alias: string | string[]

Aliases for the record. Allows defining extra paths that will behave like a copy of the record. Allows having paths shorthands like /users/:id and /u/:id. All alias and path values must share the same params.

Inherited from

_RouteRecordBase.alias

---

beforeEnter?

optional beforeEnter: NavigationGuardWithThis<undefined> | NavigationGuardWithThis<undefined>[]

Before Enter guard specific to this record. Note beforeEnter has no effect if the record has a redirect property.

Inherited from

_RouteRecordBase.beforeEnter

---

children?

optional children: RouteRecordRaw[]

Array of nested routes.

Inherited from

_RouteRecordBase.children

---

component?

optional component: undefined

---

components?

optional components: undefined

---

end?

optional end: boolean

Should the RegExp match until the end by appending a $ to it.

Default Value

true

Inherited from

_RouteRecordBase.end

---

meta?

optional meta: RouteMeta

Arbitrary data attached to the record.

Inherited from

_RouteRecordBase.meta

---

name?

optional name: RouteRecordNameGeneric

Name for the route record. Must be unique.

Inherited from

_RouteRecordBase.name

---

path

path: string

Path of the record. Should start with / unless the record is the child of another record.

Example

`/users/:id` matches `/users/1` as well as `/users/posva`.

Inherited from

_RouteRecordBase.path

---

props?

optional props: undefined

Allow passing down params as props to the component rendered by router-view.

Overrides

_RouteRecordBase.props

---

redirect

redirect: RouteRecordRedirectOption

Where to redirect if the route is directly matched. The redirection happens before any navigation guard and triggers a new navigation with the new target location.

Overrides

_RouteRecordBase.redirect

---

sensitive?

optional sensitive: boolean

Makes the RegExp case-sensitive.

Default Value

false

Inherited from

_RouteRecordBase.sensitive

---

strict?

optional strict: boolean

Whether to disallow a trailing slash or not.

Default Value

false

Inherited from

_RouteRecordBase.strict