Namespace <internal>

Index

Enumerations

NavigationState

Classes

Interfaces

Type aliases

Type aliases

HistoryEvent

HistoryEvent: { path: string; state: State; type: HistoryEventType }

A history event. Passed to listeners

Type declaration

path: string
state: State
type: HistoryEventType

HistoryEventListener

HistoryEventListener: (event: HistoryEvent) => void

Type declaration

- (event: HistoryEvent): void
- A history event listener.
  
  Parameters
  - event: HistoryEvent
  Returns void

HistoryEventType

HistoryEventType: "push" | "replace" | "pop"

Strings representing the different types of history events.

ListenerMap

ListenerMap<Types>: { [ Key in Types]?: Set<HistoryEventListener> }

Type parameters

Types: string

UnsubscribeCallback

UnsubscribeCallback: { unsubscribe: UnsubscribeCallback }

Type declaration

- (): void
- A callback used to unsubscribe from history events returned by {@link History#subscribe}.
  
  Returns void
unsubscribe: UnsubscribeCallback

Generated using TypeDoc