# of-action

[API](https://github.com/ngxs/store/tree/af0da5bab249b0cf937a1b3cc862faeeabdf145f/docs/api/README.md) > ["of-action"](https://www.ngxs.io/v3.2/api/_of_action_)

## External module: "of-action"

### Index

#### Functions

* [createAllowedMap](#createallowedmap)
* [filterStatus](#filterstatus)
* [mapAction](#mapaction)
* [ofAction](#ofaction)
* [ofActionCanceled](#ofactioncanceled)
* [ofActionDispatched](#ofactiondispatched)
* [ofActionErrored](#ofactionerrored)
* [ofActionOperator](#ofactionoperator)
* [ofActionSuccessful](#ofactionsuccessful)

### Functions

#### createAllowedMap <a href="#createallowedmap" id="createallowedmap"></a>

▸ **createAllowedMap**(types: `any`*\[]*): `object`

*Defined in* [*of-action.ts:73*](https://github.com/amcdnl/ngxs/blob/4ba1032/packages/store/src/of-action.ts#L73)

**Parameters:**

| Param | Type     |
| ----- | -------- |
| types | `any`\[] |

**Returns:** `object`

#### filterStatus <a href="#filterstatus" id="filterstatus"></a>

▸ **filterStatus**(allowedTypes: `object`, status?: [*ActionStatus*](https://github.com/ngxs/store/tree/af0da5bab249b0cf937a1b3cc862faeeabdf145f/docs/api/enums/_actions_stream_.actionstatus.md)): `MonoTypeOperatorFunction`<[ActionContext](https://github.com/ngxs/store/tree/af0da5bab249b0cf937a1b3cc862faeeabdf145f/docs/api/interfaces/_actions_stream_.actioncontext.md)>

*Defined in* [*of-action.ts:61*](https://github.com/amcdnl/ngxs/blob/4ba1032/packages/store/src/of-action.ts#L61)

**Parameters:**

| Param             | Type                                                                                                                                        |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| allowedTypes      | `object`                                                                                                                                    |
| `Optional` status | [ActionStatus](https://github.com/ngxs/store/tree/af0da5bab249b0cf937a1b3cc862faeeabdf145f/docs/api/enums/_actions_stream_.actionstatus.md) |

**Returns:** `MonoTypeOperatorFunction`<[ActionContext](https://github.com/ngxs/store/tree/af0da5bab249b0cf937a1b3cc862faeeabdf145f/docs/api/interfaces/_actions_stream_.actioncontext.md)>

#### mapAction <a href="#mapaction" id="mapaction"></a>

▸ **mapAction**(): `OperatorFunction`<[ActionContext](https://github.com/ngxs/store/tree/af0da5bab249b0cf937a1b3cc862faeeabdf145f/docs/api/interfaces/_actions_stream_.actioncontext.md), `any`>

*Defined in* [*of-action.ts:69*](https://github.com/amcdnl/ngxs/blob/4ba1032/packages/store/src/of-action.ts#L69)

**Returns:** `OperatorFunction`<[ActionContext](https://github.com/ngxs/store/tree/af0da5bab249b0cf937a1b3cc862faeeabdf145f/docs/api/interfaces/_actions_stream_.actioncontext.md), `any`>

#### ofAction <a href="#ofaction" id="ofaction"></a>

▸ **ofAction**T(allowedType: `any`): `OperatorFunction`<`any`, `T`>

▸ **ofAction**T(...allowedTypes: `any`*\[]*): `OperatorFunction`<`any`, `T`>

*Defined in* [*of-action.ts:6*](https://github.com/amcdnl/ngxs/blob/4ba1032/packages/store/src/of-action.ts#L6)

RxJS operator for selecting out specific actions.

This will grab actions that have just been dispatched as well as actions that have completed

**Type parameters:**

**T**

**Parameters:**

| Param       | Type  |
| ----------- | ----- |
| allowedType | `any` |

**Returns:** `OperatorFunction`<`any`, `T`>

*Defined in* [*of-action.ts:7*](https://github.com/amcdnl/ngxs/blob/4ba1032/packages/store/src/of-action.ts#L7)

RxJS operator for selecting out specific actions.

This will grab actions that have just been dispatched as well as actions that have completed

**Type parameters:**

**T**

**Parameters:**

| Param               | Type     |
| ------------------- | -------- |
| `Rest` allowedTypes | `any`\[] |

**Returns:** `OperatorFunction`<`any`, `T`>

#### ofActionCanceled <a href="#ofactioncanceled" id="ofactioncanceled"></a>

▸ **ofActionCanceled**(...allowedTypes: `any`*\[]*): `(Anonymous function)`

*Defined in* [*of-action.ts:41*](https://github.com/amcdnl/ngxs/blob/4ba1032/packages/store/src/of-action.ts#L41)

RxJS operator for selecting out specific actions.

This will ONLY grab actions that have just been canceled

**Parameters:**

| Param               | Type     |
| ------------------- | -------- |
| `Rest` allowedTypes | `any`\[] |

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

#### ofActionDispatched <a href="#ofactiondispatched" id="ofactiondispatched"></a>

▸ **ofActionDispatched**(...allowedTypes: `any`*\[]*): `(Anonymous function)`

*Defined in* [*of-action.ts:23*](https://github.com/amcdnl/ngxs/blob/4ba1032/packages/store/src/of-action.ts#L23)

RxJS operator for selecting out specific actions.

This will ONLY grab actions that have just been dispatched

**Parameters:**

| Param               | Type     |
| ------------------- | -------- |
| `Rest` allowedTypes | `any`\[] |

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

#### ofActionErrored <a href="#ofactionerrored" id="ofactionerrored"></a>

▸ **ofActionErrored**(...allowedTypes: `any`*\[]*): `(Anonymous function)`

*Defined in* [*of-action.ts:50*](https://github.com/amcdnl/ngxs/blob/4ba1032/packages/store/src/of-action.ts#L50)

RxJS operator for selecting out specific actions.

This will ONLY grab actions that have just thrown an error

**Parameters:**

| Param               | Type     |
| ------------------- | -------- |
| `Rest` allowedTypes | `any`\[] |

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

#### ofActionOperator <a href="#ofactionoperator" id="ofactionoperator"></a>

▸ **ofActionOperator**(allowedTypes: `any`*\[]*, status?: [*ActionStatus*](https://github.com/ngxs/store/tree/af0da5bab249b0cf937a1b3cc862faeeabdf145f/docs/api/enums/_actions_stream_.actionstatus.md)): `(Anonymous function)`

*Defined in* [*of-action.ts:54*](https://github.com/amcdnl/ngxs/blob/4ba1032/packages/store/src/of-action.ts#L54)

**Parameters:**

| Param             | Type                                                                                                                                        |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| allowedTypes      | `any`\[]                                                                                                                                    |
| `Optional` status | [ActionStatus](https://github.com/ngxs/store/tree/af0da5bab249b0cf937a1b3cc862faeeabdf145f/docs/api/enums/_actions_stream_.actionstatus.md) |

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

#### ofActionSuccessful <a href="#ofactionsuccessful" id="ofactionsuccessful"></a>

▸ **ofActionSuccessful**(...allowedTypes: `any`*\[]*): `(Anonymous function)`

*Defined in* [*of-action.ts:32*](https://github.com/amcdnl/ngxs/blob/4ba1032/packages/store/src/of-action.ts#L32)

RxJS operator for selecting out specific actions.

This will ONLY grab actions that have just been successfully completed

**Parameters:**

| Param               | Type     |
| ------------------- | -------- |
| `Rest` allowedTypes | `any`\[] |

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