VoidActionDefinition | yartsul

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

Hierarchy

VoidActionDefinition

Callable

__call(): Action<void>

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

Returns Action<void>

plain action object containing type

Index

Properties

actionType

Methods

Properties

actionType

actionType: string

globally unique action type

Methods

handler

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

- Defined in action-definition.ts:32
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.
  - - (stateDraft: Draft<S>): DraftHandlerResult<S>
    - Parameters
      - stateDraft: Draft<S>
      Returns DraftHandlerResult<S>
Returns ActionHandler<S, void>

isTypeOf

isTypeOf(action: UnknownAction): boolean

- Defined in action-definition.ts:25
Typeguard for checking if action is of given type. Narrows action.payload type to undefined

Parameters
- action: UnknownAction
Returns boolean

Generated using TypeDoc