Options
All
  • Public
  • Public/Protected
  • All
Menu

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

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

  • BaseActionCreator<P, T, M, E>
    • ActionCreatorWithPreparedPayload

Callable

  • ActionCreatorWithPreparedPayload(...args: Args): PayloadAction<P, T, M, E>
  • Calling this {@link 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.

    inheritdoc

    Parameters

    • Rest ...args: Args

    Returns PayloadAction<P, T, M, E>

Index

Properties

Methods

Properties

type: T

Methods

  • match(action: Action<unknown>): action is PayloadAction<P, T, M, E>
  • Parameters

    • action: Action<unknown>

    Returns action is PayloadAction<P, T, M, E>

Generated using TypeDoc