export AsyncThunkOptions (#950)

reduxjs · Mar 28, 2021 · 7db3e48 · 7db3e48
1 parent 9abaec4
commit 7db3e48
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/etc/redux-toolkit.api.md b/etc/redux-toolkit.api.md
@@ -87,6 +87,14 @@ export type AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig extends AsyncThu
     arg: ThunkArg;
 };
 
+// @public
+export interface AsyncThunkOptions<ThunkArg = void, ThunkApiConfig extends AsyncThunkConfig = {}> {
+    condition?(arg: ThunkArg, api: Pick<GetThunkAPI<ThunkApiConfig>, 'getState' | 'extra'>): boolean | undefined;
+    dispatchConditionRejection?: boolean;
+    // (undocumented)
+    serializeError?: (x: unknown) => GetSerializedErrorType<ThunkApiConfig>;
+}
+
 // @public
 export type AsyncThunkPayloadCreator<Returned, ThunkArg = void, ThunkApiConfig extends AsyncThunkConfig = {}> = (arg: ThunkArg, thunkAPI: GetThunkAPI<ThunkApiConfig>) => AsyncThunkPayloadCreatorReturnValue<Returned, ThunkApiConfig>;
 

diff --git a/src/createAsyncThunk.ts b/src/createAsyncThunk.ts
@@ -193,7 +193,12 @@ type AsyncThunkActionCreator<
     : (arg: ThunkArg) => AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig>
 >
 
-interface AsyncThunkOptions<
+/**
+ * Options object for `createAsyncThunk`.
+ *
+ * @public
+ */
+export interface AsyncThunkOptions<
   ThunkArg = void,
   ThunkApiConfig extends AsyncThunkConfig = {}
 > {

diff --git a/src/index.ts b/src/index.ts
@@ -106,6 +106,7 @@ export {
 
 export {
   AsyncThunk,
+  AsyncThunkOptions,
   AsyncThunkAction,
   AsyncThunkPayloadCreatorReturnValue,
   AsyncThunkPayloadCreator,