RouterEvent
interface exported by @mwillbanks/tuil-router.
interface
Public interface exported by @mwillbanks/tuil-router.
export interface RouterEvent {
readonly type: RouterEventType;
readonly from?: NavigationEntry;
readonly to?: NavigationEntry | NavigationTarget;
readonly error?: unknown;
readonly at: number;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
type | RouterEventType | Yes | The type member uses the RouterEventType contract. | RouterEventType |
from | NavigationEntry | undefined | No | The from member uses the NavigationEntry | undefined contract. | NavigationEntry |
to | NavigationEntry | NavigationTarget<string, unknown> | undefined | No | The to member uses the NavigationEntry | NavigationTarget<string, unknown> | undefined contract. | NavigationEntry, NavigationTarget |
error | unknown | No | The error member uses the unknown contract. | — |
at | number | Yes | The at member uses the number 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