# RouterState

Source: /tuil/docs/reference/packages/router/api/router-state
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 RouterState {
  readonly location?: NavigationEntry;
  readonly history: readonly NavigationEntry[];
  readonly index: number;
  readonly pending?: NavigationTarget;
  readonly error?: unknown;
}
```

## Members [#members]

| Member     | Type                                             | Required | Description                                                                              | Related types                                                               |
| ---------- | ------------------------------------------------ | -------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `location` | `NavigationEntry \| undefined`                   | No       | The `location` member uses the `NavigationEntry \| undefined` contract.                  | [`NavigationEntry`](/tuil/docs/reference/packages/router/api/navigation-entry)   |
| `history`  | `readonly NavigationEntry[]`                     | Yes      | The `history` member uses the `readonly NavigationEntry[]` contract.                     | [`NavigationEntry`](/tuil/docs/reference/packages/router/api/navigation-entry)   |
| `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`](/tuil/docs/reference/packages/router/api/navigation-target) |
| `error`    | `unknown`                                        | No       | The `error` member uses the `unknown` 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)

## 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)