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

# Interface: RouteSnapshot

Defined in: [shared/route-snapshot/src/route-snapshot.ts:19](https://github.com/simshanith/lit-ui-router/blob/740888c2b2ba358c4dfa52a122e927df6a604b12/packages/shared/route-snapshot/src/route-snapshot.ts#L19)

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`). | [shared/route-snapshot/src/route-snapshot.ts:21](https://github.com/simshanith/lit-ui-router/blob/740888c2b2ba358c4dfa52a122e927df6a604b12/packages/shared/route-snapshot/src/route-snapshot.ts#L21) |
|  `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. | [shared/route-snapshot/src/route-snapshot.ts:24](https://github.com/simshanith/lit-ui-router/blob/740888c2b2ba358c4dfa52a122e927df6a604b12/packages/shared/route-snapshot/src/route-snapshot.ts#L24) |
|  `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. | [shared/route-snapshot/src/route-snapshot.ts:27](https://github.com/simshanith/lit-ui-router/blob/740888c2b2ba358c4dfa52a122e927df6a604b12/packages/shared/route-snapshot/src/route-snapshot.ts#L27) |

## Methods

### includes()

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

Defined in: [shared/route-snapshot/src/route-snapshot.ts:34](https://github.com/simshanith/lit-ui-router/blob/740888c2b2ba358c4dfa52a122e927df6a604b12/packages/shared/route-snapshot/src/route-snapshot.ts#L34)

`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`