Types: Router<TRoutes, TOptions, TPlugin>

type Router<TRoutes, TOptions, TPlugin> = object;

Type Parameters

Type Parameter	Default type
TRoutes extends Routes	any
TOptions extends RouterOptions	any
TPlugin extends RouterPlugin	any

Type declaration

back()

back: () => void;

Navigates to the previous entry in the browser's history stack.

Returns

void

find()

find: (url, options?) => ResolvedRoute | undefined;

Creates a ResolvedRoute record for a given URL.

Parameters

Parameter	Type
url	string
options?	RouterResolveOptions

Returns

ResolvedRoute | undefined

forward()

forward: () => void;

Navigates to the next entry in the browser's history stack.

Returns

void

go()

go: (delta) => void;

Moves the current history entry to a specific point in the history stack.

Parameters

Parameter	Type
delta	number

Returns

void

install()

install: (app) => void;

Installs the router into a Vue application instance.

Parameters

Parameter	Type	Description
app	App	The Vue application instance to install the router into

Returns

void

isExternal()

isExternal: (url) => boolean;

Given a URL, returns true if host does not match host stored on router instance

Parameters

Parameter	Type
url	string

Returns

boolean

onAfterRouteEnter

onAfterRouteEnter: AddAfterRouteHook;

Registers a hook to be called after a route is entered.

onAfterRouteLeave

onAfterRouteLeave: AddAfterRouteHook;

Registers a hook to be called after a route is left.

onAfterRouteUpdate

onAfterRouteUpdate: AddAfterRouteHook;

Registers a hook to be called after a route is updated.

onBeforeRouteEnter

onBeforeRouteEnter: AddBeforeRouteHook;

Registers a hook to be called before a route is entered.

onBeforeRouteLeave

onBeforeRouteLeave: AddBeforeRouteHook;

Registers a hook to be called before a route is left.

onBeforeRouteUpdate

onBeforeRouteUpdate: AddBeforeRouteHook;

Registers a hook to be called before a route is updated.

prefetch?

optional prefetch: PrefetchConfig;

Determines what assets are prefetched.

push

push: RouterPush<TRoutes | TPlugin["routes"]>;

Navigates to a specified path or route object in the history stack, adding a new entry.

refresh()

refresh: () => void;

Forces the router to re-evaluate the current route.

Returns

void

reject

reject: RouterReject<
  | keyof TOptions["rejections"]
| KeysOfUnion<TPlugin["rejections"]>>;

Handles route rejection based on a specified rejection type.

replace

replace: RouterReplace<TRoutes | TPlugin["routes"]>;

Replaces the current entry in the history stack with a new one.

resolve

resolve: RouterResolve<TRoutes | TPlugin["routes"]>;

Creates a ResolvedRoute record for a given route name and params.

route

route: 
  | RouterRoutes<TRoutes>
| RouterRoutes<TPlugin["routes"]>;

Manages the current route state.

start()

start: () => Promise<void>;

Initializes the router based on the initial route. Automatically called when the router is installed. Calling this more than once has no effect.

Returns

Promise<void>

stop()

stop: () => void;

Stops the router and teardown any listeners.

Returns

void