PayloadActionDefinition | yartsul

Describes action with given type and payload type. Can be used as action creator function and provides other utilities.

Type parameters

P

Hierarchy

PayloadActionDefinition

Callable

__call(payload: P): Action<P>

- Defined in action-definition.ts:43
action creator function

Parameters
- payload: P
Returns Action<P>

plain action object containing type and paylaod

Index

Properties

actionType

Methods

Properties

actionType

actionType: string

globally unique action type

Methods

handler

handler<S>(fn: function): ActionHandler<S, P>

- Defined in action-definition.ts:64
Creates action handler object for usage in createReducer function.

see

immer.js

Type parameters
- S
Parameters
- fn: function
  
  the actual handler function which receives mutable state draft and action paylaod.
  - - (stateDraft: Draft<S>, paylaod: P): DraftHandlerResult<S>
    - Parameters
      - stateDraft: Draft<S>
      - paylaod: P
      Returns DraftHandlerResult<S>
Returns ActionHandler<S, P>

isTypeOf

isTypeOf(action: UnknownAction): boolean

- Defined in action-definition.ts:57
Typeguard for checking if action is of given type. Narrows action.payload type to appropriate P type

Parameters
- action: UnknownAction
Returns boolean

Generated using TypeDoc