NavigationEntry

interface

Public interface exported by @mwillbanks/tuil-router.

export interface NavigationEntry {
  readonly id: string;
  readonly route: string;
  readonly params: Readonly<Record<string, unknown>>;
  readonly surface: NavigationSurface;
  readonly data?: unknown;
  readonly matches: readonly RouteMatch[];
  readonly focus?: FocusSnapshot;
  readonly createdAt: number;
}

Members

Member	Type	Required	Description	Related types
`id`	`string`	Yes	The `id` member uses the `string` contract.	—
`route`	`string`	Yes	The `route` member uses the `string` contract.	—
`params`	`Readonly<Record<string, unknown>>`	Yes	The `params` member uses the `Readonly<Record<string, unknown>>` contract.	—
`surface`	`NavigationSurface`	Yes	The `surface` member uses the `NavigationSurface` contract.	`NavigationSurface`
`data`	`unknown`	No	The `data` member uses the `unknown` contract.	—
`matches`	`readonly RouteMatch[]`	Yes	The `matches` member uses the `readonly RouteMatch[]` contract.	`RouteMatch`
`focus`	`FocusSnapshot \| undefined`	No	The `focus` member uses the `FocusSnapshot \| undefined` contract.	`FocusSnapshot`
`createdAt`	`number`	Yes	The `createdAt` 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.

Source

View the secondary source reference

Package

@mwillbanks/tuil-router

NavigationEntry

On this page