> For the complete documentation index, see [llms.txt](https://www.ngxs.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.ngxs.io/v3.2/api/_state_.md).

# State

[API](https://github.com/ngxs/store/tree/af0da5bab249b0cf937a1b3cc862faeeabdf145f/docs/api/README.md) > ["state"](/v3.2/api/_state_.md)

## External module: "state"

### Index

#### Variables

* [stateNameRegex](/v3.2/api/_state_.md#statenameregex)

#### Functions

* [State](/v3.2/api/_state_.md#state)
* [stateNameErrorMessage](/v3.2/api/_state_.md#statenameerrormessage)

### Variables

#### `<Const>` stateNameRegex <a href="#statenameregex" id="statenameregex"></a>

**● stateNameRegex**: `RegExp` = new RegExp('^\[a-zA-Z0-9]+$')

*Defined in* [*state.ts:4*](https://github.com/amcdnl/ngxs/blob/4ba1032/packages/store/src/state.ts#L4)

### Functions

#### State <a href="#state" id="state"></a>

▸ **State**T(options: [*StoreOptions*](https://github.com/ngxs/store/tree/af0da5bab249b0cf937a1b3cc862faeeabdf145f/docs/api/interfaces/_symbols_.storeoptions.md)*<*`T`*>*): `(Anonymous function)`

*Defined in* [*state.ts:16*](https://github.com/amcdnl/ngxs/blob/4ba1032/packages/store/src/state.ts#L16)

Decorates a class with ngxs state information.

**Type parameters:**

**T**

**Parameters:**

| Param   | Type                                                                                                                                           |
| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| options | [StoreOptions](https://github.com/ngxs/store/tree/af0da5bab249b0cf937a1b3cc862faeeabdf145f/docs/api/interfaces/_symbols_.storeoptions.md)<`T`> |

**Returns:** `(Anonymous function)`

#### `<Const>` stateNameErrorMessage <a href="#statenameerrormessage" id="statenameerrormessage"></a>

▸ **stateNameErrorMessage**(name: `any`): `string`

*Defined in* [*state.ts:10*](https://github.com/amcdnl/ngxs/blob/4ba1032/packages/store/src/state.ts#L10)

Error message

**Parameters:**

| Param | Type  |
| ----- | ----- |
| name  | `any` |

**Returns:** `string`