Become a sponsor
API Documentation / RouteRecordRedirect
Interface: RouteRecordRedirect
Route Record that defines a redirect. Cannot have component or components as it is never rendered.
Hierarchy
↳
RouteRecordRedirect
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
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
children
• Optional children: RouteRecordRaw[]
Array of nested routes.
Inherited from
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
meta
• Optional meta: RouteMeta
Arbitrary data attached to the record.
Inherited from
name
• Optional name: RouteRecordNameGeneric
Name for the route record. Must be unique.
Inherited from
path
• path: string
Path of the record. Should start with / unless the record is the child of another record.
Example
ts
`/users/:id` matches `/users/1` as well as `/users/posva`.Inherited from
props
• Optional props: undefined
Allow passing down params as props to the component rendered by router-view.
Overrides
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
sensitive
• Optional sensitive: boolean
Makes the RegExp case-sensitive.
Default Value
false
Inherited from
strict
• Optional strict: boolean
Whether to disallow a trailing slash or not.
Default Value
false