Type alias PayloadAction<P, T, M, E>

PayloadAction<P, T, M, E>: {
    payload: P;
    type: T;
} & ([M] extends [never]
    ? {}
    : {
        meta: M;
    }) & ([E] extends [never]
    ? {}
    : {
        error: E;
    })

An action with a string type and an associated payload. This is the type of action returned by createAction() action creators.

Type Parameters

  • P = void

    The type of the action's payload.

  • T extends string = string

    the type used for the action type.

  • M = never

    The type of the action's meta (optional)

  • E = never

    The type of the action's error (optional)

Type declaration

  • payload: P
  • type: T

Settings

Member Visibility

Theme

Generated using TypeDoc