LogoLogo
v3.5
v3.5
  • Introduction
  • Getting Started
    • Why
    • Installation
  • Concepts
    • Introduction
    • Store
    • Actions
    • State
    • Select
  • API
    • @Action
    • Actions(Stream)
    • Init Actions
    • Module
    • of-action
    • @Select
    • @Selector
    • @State
    • Store
  • Advanced
    • State Operators
    • Options
    • Lazy Loading
    • Sub States
    • Cancellation
    • Action Handlers
    • Composition
    • Error Handling
    • Life-cycle
    • Meta Reducers
    • Shared State
  • Recipes
    • Authentication
    • Caching
    • Unit Testing
    • Style Guide
  • Plugins
    • Introduction
    • CLI
    • Logger
    • Devtools
    • Storage
    • Forms
    • Web Socket
    • Router
    • HMR
  • NGXS Labs
    • Introduction
    • Emitter
    • Immer adapter
    • Dispatch decorator
  • Community
    • FAQ
    • Resources
    • Contributors
    • Contributing
    • Sponsors
  • Changelog
Powered by GitBook
On this page
  • External module: "operators/of-action"
  • Index
  • Functions
  1. API

of-action

PreviousModuleNext@Select

Last updated 6 years ago

>

External module: "operators/of-action"

Index

Functions

Functions

createAllowedMap

▸ createAllowedMap(types: any[]): object

Parameters:

Name

Type

types

any[]

Returns: object

filterStatus

Parameters:

Name

Type

allowedTypes

object

Optional status

mapAction

ofAction

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

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

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:

Name

Type

allowedType

any

Returns: OperatorFunction<any, T>

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:

Name

Type

Rest allowedTypes

any[]

Returns: OperatorFunction<any, T>

ofActionCanceled

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

RxJS operator for selecting out specific actions.

This will ONLY grab actions that have just been canceled

Parameters:

Name

Type

Rest allowedTypes

any[]

Returns: (Anonymous function)

ofActionDispatched

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

RxJS operator for selecting out specific actions.

This will ONLY grab actions that have just been dispatched

Parameters:

Name

Type

Rest allowedTypes

any[]

Returns: (Anonymous function)

ofActionErrored

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

RxJS operator for selecting out specific actions.

This will ONLY grab actions that have just thrown an error

Parameters:

Name

Type

Rest allowedTypes

any[]

Returns: (Anonymous function)

ofActionOperator

Parameters:

Name

Type

allowedTypes

any[]

Optional status

Returns: (Anonymous function)

ofActionSuccessful

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

RxJS operator for selecting out specific actions.

This will ONLY grab actions that have just been successfully completed

Parameters:

Name

Type

Rest allowedTypes

any[]

Returns: (Anonymous function)

Defined in

▸ filterStatus(allowedTypes: object, status?: ): MonoTypeOperatorFunction<>

Defined in

Returns: MonoTypeOperatorFunction<>

▸ mapAction(): OperatorFunction<, any>

Defined in

Returns: OperatorFunction<, any>

Defined in

Defined in

Defined in

Defined in

Defined in

▸ ofActionOperator(allowedTypes: any[], status?: ): (Anonymous function)

Defined in

Defined in

operators/of-action.ts:76
ActionStatus
ActionContext
operators/of-action.ts:64
ActionContext
ActionContext
operators/of-action.ts:72
ActionContext
operators/of-action.ts:6
operators/of-action.ts:7
operators/of-action.ts:41
operators/of-action.ts:23
operators/of-action.ts:50
ActionStatus
operators/of-action.ts:54
operators/of-action.ts:32
API
"operators/of-action"
createAllowedMap
filterStatus
mapAction
ofAction
ofActionCanceled
ofActionDispatched
ofActionErrored
ofActionOperator
ofActionSuccessful
ActionStatus
ActionStatus