RouterState
interface exported by @mwillbanks/tuil-router.
interface
Public interface exported by @mwillbanks/tuil-router.
export interface RouterState {
readonly location?: NavigationEntry;
readonly history: readonly NavigationEntry[];
readonly index: number;
readonly pending?: NavigationTarget;
readonly error?: unknown;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
location | NavigationEntry | undefined | No | The location member uses the NavigationEntry | undefined contract. | NavigationEntry |
history | readonly NavigationEntry[] | Yes | The history member uses the readonly NavigationEntry[] contract. | NavigationEntry |
index | number | Yes | The index member uses the number contract. | — |
pending | NavigationTarget<string, unknown> | undefined | No | The pending member uses the NavigationTarget<string, unknown> | undefined contract. | NavigationTarget |
error | unknown | No | The error member uses the unknown contract. | — |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference