Interface ActionCreatorWithPreparedPayload<Args, P, T, E, M>

Basic type for all action creators.

Inherit Doc

Type Parameters

  • Args extends unknown[]

    arguments for the action creator function

  • P

    payload type

  • T extends string = string

    type name

  • E = never

    optional error type

  • M = never

    optional meta type

Hierarchy

  • Calling this redux#ActionCreator with Args will return an Action with a payload of type P and (depending on the PrepareAction method used) a meta- and error property of types M and E respectively.

    Parameters

    • Rest ...args: Args

    Returns PayloadAction<P, T, M, E>

Properties

Properties

match: ((action) => action is PayloadAction<P, T, M, E>)

Type declaration

type: T

Generated using TypeDoc