Skip to content

Commit a40e060

Browse files
committed
Update public API
1 parent 95d2bcd commit a40e060

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

etc/redux-toolkit.api.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ export type CaseReducerWithPrepare<State, Action extends PayloadAction> = {
7878
};
7979

8080
// @alpha (undocumented)
81-
export type Comparer<T> = ComparerNum<T> | ComparerStr<T>;
81+
export type Comparer<T> = (a: T, b: T) => EntityId;
8282

8383
// @public
8484
export type ConfigureEnhancersCallback = (defaultEnhancers: StoreEnhancer[]) => StoreEnhancer[];
@@ -102,19 +102,23 @@ export function createAction<P = void, T extends string = string>(type: T): Payl
102102
export function createAction<PA extends PrepareAction<any>, T extends string = string>(type: T, prepareAction: PA): PayloadActionCreator<ReturnType<PA>['payload'], T, PA>;
103103

104104
// @alpha (undocumented)
105-
export function createAsyncThunk<ActionType extends string, PayloadCreator extends AsyncActionCreator<unknown, Dispatch, unknown, undefined>>(type: ActionType, payloadCreator: PayloadCreator): {
106-
(args?: Parameters<PayloadCreator>[0]["args"] | undefined): (dispatch: any, getState: any, extra: any) => Promise<any>;
107-
pending: import("./createAction").ActionCreatorWithPreparedPayload<[Parameters<PayloadCreator>[0]["args"]], undefined, string, never, {
108-
args: Parameters<PayloadCreator>[0]["args"];
105+
export function createAsyncThunk<ActionType extends string, Returned, ActionParams = void, TA extends AsyncThunksArgs<any, any, any> = AsyncThunksArgs<unknown, unknown, Dispatch>>(type: ActionType, payloadCreator: (args: ActionParams, thunkArgs: TA) => Promise<Returned> | Returned): {
106+
(args: ActionParams): (dispatch: TA["dispatch"], getState: TA["getState"], extra: TA["extra"]) => Promise<any>;
107+
pending: import("./createAction").ActionCreatorWithPreparedPayload<[string, ActionParams], undefined, string, never, {
108+
args: ActionParams;
109+
requestId: string;
109110
}>;
110-
rejected: import("./createAction").ActionCreatorWithPreparedPayload<[Error, Parameters<PayloadCreator>[0]["args"]], undefined, string, Error, {
111-
args: Parameters<PayloadCreator>[0]["args"];
111+
rejected: import("./createAction").ActionCreatorWithPreparedPayload<[Error, string, ActionParams], undefined, string, Error, {
112+
args: ActionParams;
113+
requestId: string;
112114
}>;
113-
fulfilled: import("./createAction").ActionCreatorWithPreparedPayload<[Await<ReturnType<PayloadCreator>>, Parameters<PayloadCreator>[0]["args"]], Await<ReturnType<PayloadCreator>>, string, never, {
114-
args: Parameters<PayloadCreator>[0]["args"];
115+
fulfilled: import("./createAction").ActionCreatorWithPreparedPayload<[Returned, string, ActionParams], Returned, string, never, {
116+
args: ActionParams;
117+
requestId: string;
115118
}>;
116-
finished: import("./createAction").ActionCreatorWithPreparedPayload<[Parameters<PayloadCreator>[0]["args"]], undefined, string, never, {
117-
args: Parameters<PayloadCreator>[0]["args"];
119+
finished: import("./createAction").ActionCreatorWithPreparedPayload<[string, ActionParams], undefined, string, never, {
120+
args: ActionParams;
121+
requestId: string;
118122
}>;
119123
};
120124

@@ -185,7 +189,7 @@ export interface EntityState<T> {
185189
// (undocumented)
186190
entities: Dictionary<T>;
187191
// (undocumented)
188-
ids: string[] | number[];
192+
ids: EntityId[];
189193
}
190194

191195
// @public (undocumented)
@@ -202,7 +206,7 @@ export function getDefaultMiddleware<S = any, O extends Partial<GetDefaultMiddle
202206
export function getType<T extends string>(actionCreator: PayloadActionCreator<any, T>): T;
203207

204208
// @alpha (undocumented)
205-
export type IdSelector<T> = IdSelectorStr<T> | IdSelectorNum<T>;
209+
export type IdSelector<T> = (model: T) => EntityId;
206210

207211
// @public
208212
export function isPlain(val: any): boolean;

0 commit comments

Comments
 (0)