# RouterEvent

Source: /tuil/docs/reference/packages/router/api/router-event
Locale: en

interface exported by @mwillbanks/tuil-router.



{/* Generated by tooling/docs/generate-reference.ts. */}

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-router`.

```ts
export interface RouterEvent {
  readonly type: RouterEventType;
  readonly from?: NavigationEntry;
  readonly to?: NavigationEntry | NavigationTarget;
  readonly error?: unknown;
  readonly at: number;
}
```

## Members [#members]

| Member  | Type                                                                | Required | Description                                                                                            | Related types                                                                                                                                          |
| ------- | ------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type`  | `RouterEventType`                                                   | Yes      | The `type` member uses the `RouterEventType` contract.                                                 | [`RouterEventType`](/tuil/docs/reference/packages/router/api/router-event-type)                                                                             |
| `from`  | `NavigationEntry \| undefined`                                      | No       | The `from` member uses the `NavigationEntry \| undefined` contract.                                    | [`NavigationEntry`](/tuil/docs/reference/packages/router/api/navigation-entry)                                                                              |
| `to`    | `NavigationEntry \| NavigationTarget<string, unknown> \| undefined` | No       | The `to` member uses the `NavigationEntry \| NavigationTarget<string, unknown> \| undefined` contract. | [`NavigationEntry`](/tuil/docs/reference/packages/router/api/navigation-entry), [`NavigationTarget`](/tuil/docs/reference/packages/router/api/navigation-target) |
| `error` | `unknown`                                                           | No       | The `error` member uses the `unknown` contract.                                                        | —                                                                                                                                                      |
| `at`    | `number`                                                            | Yes      | The `at` member uses the `number` contract.                                                            | —                                                                                                                                                      |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`NavigationEntry`](/tuil/docs/reference/packages/router/api/navigation-entry)
* [`NavigationTarget`](/tuil/docs/reference/packages/router/api/navigation-target)
* [`RouterEventType`](/tuil/docs/reference/packages/router/api/router-event-type)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/router/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-router](/tuil/docs/reference/packages/router)