---
url: https://lit-ui-router.dev/api/lit-ui-router-effect/interfaces/RouteSnapshot.md
---
[lit-ui-router-effect](../index.md) / RouteSnapshot

# Interface: RouteSnapshot

Defined in: ui-router-effect/dist/shared/route-snapshot.d.ts:9

The router's current state as one immutable value, for a reactive cell to hold.

Taken once per successful transition; every field, `includes()` included,
answers for that moment. A selector asking during a later transition gets
the settled answer, not the in-flight one.

## Properties

| Property | Modifier | Type | Description | Defined in |
| ------ | ------ | ------ | ------ | ------ |
|  `current` | `readonly` | | [`StateDeclaration`](https://ui-router.github.io/core/docs/latest/interfaces/_state_interface_.statedeclaration.html) | `undefined` | The current state declaration (`globals.current`). | ui-router-effect/dist/shared/route-snapshot.d.ts:11 |
|  `params` | `readonly` | [`RawParams`](https://ui-router.github.io/core/docs/latest/interfaces/_params_interface_.rawparams.html) | The current parameter values (`globals.params`), replaced per transition. | ui-router-effect/dist/shared/route-snapshot.d.ts:13 |
|  `transition` | `readonly` | | [`Transition`](https://ui-router.github.io/core/docs/latest/classes/_transition_transition_.transition.html) | `undefined` | The transition that produced this snapshot; `undefined` before the first. | ui-router-effect/dist/shared/route-snapshot.d.ts:15 |

## Methods

### includes()

```ts
includes(stateOrName, params?): boolean;
```

Defined in: ui-router-effect/dist/shared/route-snapshot.d.ts:21

`StateService.includes` evaluated against this snapshot: is the state (or
glob pattern, e.g. `'admin.**'`) included in the snapshot's active state,
with these parameter values?

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `stateOrName` | [`StateOrName`](https://ui-router.github.io/core/docs/latest/modules/_state_interface_.html#stateorname) |
| `params?` | [`RawParams`](https://ui-router.github.io/core/docs/latest/interfaces/_params_interface_.rawparams.html) |

#### Returns

`boolean`