Interface ActionCreatorWithPayload<P, T>

Basic type for all action creators.

Inherit Doc

Type Parameters

P
T extends string = string

Hierarchy

BaseActionCreator<P, T>
- ActionCreatorWithPayload

ActionCreatorWithPayload(payload): {
payload: P;
type: T;
}
Calling this redux#ActionCreator with an argument will return a PayloadAction of type T with a payload of P
Parameters
- payload: P
Returns {
payload: P;
type: T;
}
- payload: P
- type: T
- Defined in node_modules/@reduxjs/toolkit/dist/createAction.d.ts:123

Index

Properties

Properties

match

match: ((action) => action is {
payload: P;
type: T;
})

Type declaration

- (action): action is {
  payload: P;
  type: T;
  }
- Parameters
  - action: Action<unknown>
  Returns action is {
  payload: P;
  type: T;
  }

type

type: T

Generated using TypeDoc