Interface History

The History interface abstracts away all necessary interface with the browser. It is not meant to be use directly. Instead, use the navigator.

interface History {
    get location(): Location;
    go(idx: number): void;
    observe(handler: (location: Location) => void): () => void;
    push(pathOrLocation: string | Location): void;
    replace(pathOrLocation: string | Location): void;
}

Implemented by

Index

Accessors

Methods

go observe push replace

Accessors

location

get location(): Location
Returns Location
- Defined in types.ts:20

Methods

go

go(idx: number): void
Parameters
- idx: number
Returns void
- Defined in types.ts:24

observe

observe(handler: (location: Location) => void): () => void
Subscribe to location updates. Returns a cancel fn that can be invoked to stop observing.
Parameters
- handler: (location: Location) => void
Returns () => void
- Defined in types.ts:22

push

push(pathOrLocation: string | Location): void
Parameters
- pathOrLocation: string | Location
Returns void
- Defined in types.ts:26

replace

replace(pathOrLocation: string | Location): void
Parameters
- pathOrLocation: string | Location
Returns void
- Defined in types.ts:25