vue-router / _RouteRecordBase

_RouteRecordBase

Internal type for common properties among all kind of RouteRecordRaw.

Extends

• PathParserOptions

Extended by

• RouteRecordSingleView
• RouteRecordSingleViewWithChildren
• RouteRecordMultipleViews
• RouteRecordMultipleViewsWithChildren
• 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.

---

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.

---

children?

optional children: RouteRecordRaw[];

Array of nested routes.

---

end?

optional end: boolean;

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

Deprecated

this option will alsways be true in the future. Open a discussion in vuejs/router if you need this to be false

Default Value

true

Inherited from

_PathParserOptions.end

---

meta?

optional meta: RouteMeta;

Arbitrary data attached to the record.

---

name?

optional name: RouteRecordNameGeneric;

Name for the route record. Must be unique.

---

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`.

---

props?

optional props: 
  | _RouteRecordProps
| Record<string, _RouteRecordProps>;

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

---

redirect?

optional 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.

---

sensitive?

optional sensitive: boolean;

Makes the RegExp case-sensitive.

Default Value

false

Inherited from

_PathParserOptions.sensitive

---

strict?

optional strict: boolean;

Whether to disallow a trailing slash or not.

Default Value

false

Inherited from

_PathParserOptions.strict