internal_.IRouter

runtime / <internal> / IRouter

Interface: IRouter<RouteRecord>

internal.IRouter

Type parameters

Name	Type
RouteRecord	extends Object = any

Table of contents

Properties

• action
• back
• block
• current
• go
• ready
• resolve

Methods

• afterEach
• beforeEach
• forward
• listen
• push
• replace
• replaceRoutes

Properties

action

• action: Action

---

back

• back: () => void

Type declaration

▸ (): void

Returns

void

---

block

• block: (blocker: Blocker<State>) => () => void

Type declaration

▸ (blocker): () => void

Parameters

Name	Type
blocker	Blocker<State>

Returns

fn

▸ (): void

Returns

void

---

current

• current: IRoute<RouteRecord>

---

go

• go: (delta: number) => void

Type declaration

▸ (delta): void

Jump to the specified route by number

Parameters

Name	Type
delta	number

Returns

void

---

ready

• ready: Promise<any>

---

resolve

• resolve: (to: any, from?: any) => ResolvedPath

Type declaration

▸ (to, from?): ResolvedPath

Parameters

Name	Type
to	any
from?	any

Returns

ResolvedPath

Methods

afterEach

▸ afterEach(listener): RemoveListenerCallback

Parameters

Name	Type
listener	NavigationResolvedHook<any>

Returns

RemoveListenerCallback

---

beforeEach

▸ beforeEach(listener): RemoveListenerCallback

Parameters

Name	Type
listener	NavigationGuardHook<any>

Returns

RemoveListenerCallback

---

forward

▸ forward(): void

Returns

void

---

listen

▸ listen(listener): RemoveListenerCallback

Parameters

Name	Type
listener	Listener<State>

Returns

RemoveListenerCallback

---

push

▸ push(to, state?): void

Parameters

Name	Type
to	PathRecord
state?	any

Returns

void

---

replace

▸ replace(to, state?): void

Parameters

Name	Type
to	PathRecord
state?	any

Returns

void

---

replaceRoutes

▸ replaceRoutes(routes): void

Parameters

Name	Type
routes	RouteRecord[]

Returns

void