Interface INavigator

interface INavigator {
    get location(): Location;
    go(offset: number): void;
    push(path: string | ConstPath): void;
    push<P extends Path<string, any>>(path: P, params: DataOfPath<P>): void;
    replace(path: string | ConstPath): void;
    replace<P extends Path<string, any>>(path: P, params: DataOfPath<P>): void;
    start(): void;
    stop(): void;
}

Implemented by

Navigator

Index

Accessors

Methods

go push replace start stop

Accessors

location

get location(): Location
Returns Location
- Defined in navigator.ts:22

Methods

go

go(offset: number): void
Parameters
- offset: number
Returns void
- Defined in navigator.ts:24

push

push(path: string | ConstPath): void
Parameters
- path: string | ConstPath
Returns void
- Defined in navigator.ts:26
push<P extends Path<string, any>>(path: P, params: DataOfPath<P>): void
Type Parameters
- P extends Path<string, any>
Parameters
- path: P
- params: DataOfPath<P>
Returns void
- Defined in navigator.ts:27

replace

replace(path: string | ConstPath): void
Parameters
- path: string | ConstPath
Returns void
- Defined in navigator.ts:29
replace<P extends Path<string, any>>(path: P, params: DataOfPath<P>): void
Type Parameters
- P extends Path<string, any>
Parameters
- path: P
- params: DataOfPath<P>
Returns void
- Defined in navigator.ts:30

start

start(): void
Start listening and responding to history events. <NavigatorProvider> will call this automatically.

Returns void
- Defined in navigator.ts:14

stop

stop(): void
Stop listening to history events. <NavigatorProvider> will call this automatically when it is unmounted.

Returns void
- Defined in navigator.ts:20