Type Alias AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig>

AsyncThunkAction: (
    dispatch: NonNullable<GetDispatch<ThunkApiConfig>>,
    getState: () => GetState<ThunkApiConfig>,
    extra: GetExtra<ThunkApiConfig>,
) => SafePromise<
    | ReturnType<AsyncThunkFulfilledActionCreator<Returned, ThunkArg>>
    | ReturnType<AsyncThunkRejectedActionCreator<ThunkArg, ThunkApiConfig>>,
> & {
    abort: (reason?: string) => void;
    arg: ThunkArg;
    requestId: string;
    unwrap: () => Promise<Returned>;
}

A ThunkAction created by createAsyncThunk. Dispatching it returns a Promise for either a fulfilled or rejected action. Also, the returned value contains an abort() method that allows the asyncAction to be cancelled from the outside.

Type Parameters

Returned
ThunkArg
ThunkApiConfig extends AsyncThunkConfig

Type declaration

- (
      dispatch: NonNullable<GetDispatch<ThunkApiConfig>>,
      getState: () => GetState<ThunkApiConfig>,
      extra: GetExtra<ThunkApiConfig>,
  ): SafePromise<
      | ReturnType<AsyncThunkFulfilledActionCreator<Returned, ThunkArg>>
      | ReturnType<AsyncThunkRejectedActionCreator<ThunkArg, ThunkApiConfig>>,
  > & {
      abort: (reason?: string) => void;
      arg: ThunkArg;
      requestId: string;
      unwrap: () => Promise<Returned>;
  }
- Parameters
  - dispatch: NonNullable<GetDispatch<ThunkApiConfig>>
  - getState: () => GetState<ThunkApiConfig>
  - extra: GetExtra<ThunkApiConfig>
  Returns SafePromise<
      | ReturnType<AsyncThunkFulfilledActionCreator<Returned, ThunkArg>>
      | ReturnType<AsyncThunkRejectedActionCreator<ThunkArg, ThunkApiConfig>>,
  > & {
      abort: (reason?: string) => void;
      arg: ThunkArg;
      requestId: string;
      unwrap: () => Promise<Returned>;
  }

Type Alias AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig>

Type Parameters

Type declaration

Parameters

Returns SafePromise< | ReturnType<AsyncThunkFulfilledActionCreator<Returned, ThunkArg>> | ReturnType<AsyncThunkRejectedActionCreator<ThunkArg, ThunkApiConfig>>,> & { abort: (reason?: string) => void; arg: ThunkArg; requestId: string; unwrap: () => Promise<Returned>;}

Settings

Returns SafePromise<
| ReturnType<AsyncThunkFulfilledActionCreator<Returned, ThunkArg>>
| ReturnType<AsyncThunkRejectedActionCreator<ThunkArg, ThunkApiConfig>>,
> & {
abort: (reason?: string) => void;
arg: ThunkArg;
requestId: string;
unwrap: () => Promise<Returned>;
}