vue-mvvm

Appearance

vue-mvvm / router / RouterService

RouterService ​

Represents an MVVM service wrapper around the vue-router functions.

Properties ​

params ​

ts
readonly params: RouterParams;

query ​

ts
readonly query: RouterQuery;

Methods ​

getNative() ​

ts
getNative(): Router;

Returns the native Vue Router instance

Returns ​

Router

ts
navigateBack(): void;

Go back in history if possible

Returns ​

void

ts
navigateTo<Route>(vm, ...params): Promise<void>;

Programmatically navigate to a new ViewModel by pushing an entry in the history stack.

Type Parameters ​

Route ​

Route extends RoutableViewModel

Parameters ​

vm ​

Route

A routable ViewModel

params ​

...RouteParamsParameter<Route>

Required path parameters

Returns ​

Promise<void>

replaceTo() ​

ts
replaceTo<Route>(vm, ...params): Promise<void>;

Programmatically navigate to a new ViewModel by replacing the current entry in the history stack.

Type Parameters ​

Route ​

Route extends RoutableViewModel

Parameters ​

vm ​

Route

A routable ViewModel

params ​

...RouteParamsParameter<Route>

Required path parameters

Returns ​

Promise<void>