@tanstack/query-core 5.87.4 → 5.90.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/legacy/{hydration-_hO-y142.d.cts → hydration-DofhGwZq.d.cts} +57 -51
- package/build/legacy/{hydration-BYonJkjc.d.ts → hydration-iULCH7y8.d.ts} +57 -51
- package/build/legacy/hydration.d.cts +1 -1
- package/build/legacy/hydration.d.ts +1 -1
- package/build/legacy/index.d.cts +1 -1
- package/build/legacy/index.d.ts +1 -1
- package/build/legacy/infiniteQueryBehavior.d.cts +1 -1
- package/build/legacy/infiniteQueryBehavior.d.ts +1 -1
- package/build/legacy/infiniteQueryObserver.d.cts +1 -1
- package/build/legacy/infiniteQueryObserver.d.ts +1 -1
- package/build/legacy/mutation.cjs +44 -12
- package/build/legacy/mutation.cjs.map +1 -1
- package/build/legacy/mutation.d.cts +1 -1
- package/build/legacy/mutation.d.ts +1 -1
- package/build/legacy/mutation.js +44 -12
- package/build/legacy/mutation.js.map +1 -1
- package/build/legacy/mutationCache.cjs +1 -0
- package/build/legacy/mutationCache.cjs.map +1 -1
- package/build/legacy/mutationCache.d.cts +1 -1
- package/build/legacy/mutationCache.d.ts +1 -1
- package/build/legacy/mutationCache.js +1 -0
- package/build/legacy/mutationCache.js.map +1 -1
- package/build/legacy/mutationObserver.cjs +29 -4
- package/build/legacy/mutationObserver.cjs.map +1 -1
- package/build/legacy/mutationObserver.d.cts +1 -1
- package/build/legacy/mutationObserver.d.ts +1 -1
- package/build/legacy/mutationObserver.js +29 -4
- package/build/legacy/mutationObserver.js.map +1 -1
- package/build/legacy/queriesObserver.d.cts +1 -1
- package/build/legacy/queriesObserver.d.ts +1 -1
- package/build/legacy/query.d.cts +1 -1
- package/build/legacy/query.d.ts +1 -1
- package/build/legacy/queryCache.d.cts +1 -1
- package/build/legacy/queryCache.d.ts +1 -1
- package/build/legacy/queryClient.cjs.map +1 -1
- package/build/legacy/queryClient.d.cts +1 -1
- package/build/legacy/queryClient.d.ts +1 -1
- package/build/legacy/queryClient.js.map +1 -1
- package/build/legacy/queryObserver.d.cts +1 -1
- package/build/legacy/queryObserver.d.ts +1 -1
- package/build/legacy/retryer.d.cts +1 -1
- package/build/legacy/retryer.d.ts +1 -1
- package/build/legacy/streamedQuery.d.cts +1 -1
- package/build/legacy/streamedQuery.d.ts +1 -1
- package/build/legacy/types.cjs.map +1 -1
- package/build/legacy/types.d.cts +1 -1
- package/build/legacy/types.d.ts +1 -1
- package/build/legacy/types.js.map +1 -1
- package/build/legacy/utils.cjs.map +1 -1
- package/build/legacy/utils.d.cts +1 -1
- package/build/legacy/utils.d.ts +1 -1
- package/build/legacy/utils.js.map +1 -1
- package/build/modern/{hydration-_hO-y142.d.cts → hydration-DofhGwZq.d.cts} +57 -51
- package/build/modern/{hydration-BYonJkjc.d.ts → hydration-iULCH7y8.d.ts} +57 -51
- package/build/modern/hydration.d.cts +1 -1
- package/build/modern/hydration.d.ts +1 -1
- package/build/modern/index.d.cts +1 -1
- package/build/modern/index.d.ts +1 -1
- package/build/modern/infiniteQueryBehavior.d.cts +1 -1
- package/build/modern/infiniteQueryBehavior.d.ts +1 -1
- package/build/modern/infiniteQueryObserver.d.cts +1 -1
- package/build/modern/infiniteQueryObserver.d.ts +1 -1
- package/build/modern/mutation.cjs +39 -11
- package/build/modern/mutation.cjs.map +1 -1
- package/build/modern/mutation.d.cts +1 -1
- package/build/modern/mutation.d.ts +1 -1
- package/build/modern/mutation.js +39 -11
- package/build/modern/mutation.js.map +1 -1
- package/build/modern/mutationCache.cjs +1 -0
- package/build/modern/mutationCache.cjs.map +1 -1
- package/build/modern/mutationCache.d.cts +1 -1
- package/build/modern/mutationCache.d.ts +1 -1
- package/build/modern/mutationCache.js +1 -0
- package/build/modern/mutationCache.js.map +1 -1
- package/build/modern/mutationObserver.cjs +26 -4
- package/build/modern/mutationObserver.cjs.map +1 -1
- package/build/modern/mutationObserver.d.cts +1 -1
- package/build/modern/mutationObserver.d.ts +1 -1
- package/build/modern/mutationObserver.js +26 -4
- package/build/modern/mutationObserver.js.map +1 -1
- package/build/modern/queriesObserver.d.cts +1 -1
- package/build/modern/queriesObserver.d.ts +1 -1
- package/build/modern/query.d.cts +1 -1
- package/build/modern/query.d.ts +1 -1
- package/build/modern/queryCache.d.cts +1 -1
- package/build/modern/queryCache.d.ts +1 -1
- package/build/modern/queryClient.cjs.map +1 -1
- package/build/modern/queryClient.d.cts +1 -1
- package/build/modern/queryClient.d.ts +1 -1
- package/build/modern/queryClient.js.map +1 -1
- package/build/modern/queryObserver.d.cts +1 -1
- package/build/modern/queryObserver.d.ts +1 -1
- package/build/modern/retryer.d.cts +1 -1
- package/build/modern/retryer.d.ts +1 -1
- package/build/modern/streamedQuery.d.cts +1 -1
- package/build/modern/streamedQuery.d.ts +1 -1
- package/build/modern/types.cjs.map +1 -1
- package/build/modern/types.d.cts +1 -1
- package/build/modern/types.d.ts +1 -1
- package/build/modern/types.js.map +1 -1
- package/build/modern/utils.cjs.map +1 -1
- package/build/modern/utils.d.cts +1 -1
- package/build/modern/utils.d.ts +1 -1
- package/build/modern/utils.js.map +1 -1
- package/package.json +2 -2
- package/src/mutation.ts +61 -24
- package/src/mutationCache.ts +21 -11
- package/src/mutationObserver.ts +62 -22
- package/src/queryClient.ts +2 -2
- package/src/types.ts +67 -29
- package/src/utils.ts +2 -2
|
@@ -151,25 +151,25 @@ declare function fetchState<TQueryFnData, TError, TData, TQueryKey extends Query
|
|
|
151
151
|
readonly fetchStatus: "fetching" | "paused";
|
|
152
152
|
};
|
|
153
153
|
|
|
154
|
-
type MutationObserverListener<TData, TError, TVariables,
|
|
155
|
-
declare class MutationObserver<TData = unknown, TError = DefaultError, TVariables = void,
|
|
154
|
+
type MutationObserverListener<TData, TError, TVariables, TOnMutateResult> = (result: MutationObserverResult<TData, TError, TVariables, TOnMutateResult>) => void;
|
|
155
|
+
declare class MutationObserver<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends Subscribable<MutationObserverListener<TData, TError, TVariables, TOnMutateResult>> {
|
|
156
156
|
#private;
|
|
157
|
-
options: MutationObserverOptions<TData, TError, TVariables,
|
|
158
|
-
constructor(client: QueryClient, options: MutationObserverOptions<TData, TError, TVariables,
|
|
157
|
+
options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>;
|
|
158
|
+
constructor(client: QueryClient, options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>);
|
|
159
159
|
protected bindMethods(): void;
|
|
160
|
-
setOptions(options: MutationObserverOptions<TData, TError, TVariables,
|
|
160
|
+
setOptions(options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>): void;
|
|
161
161
|
protected onUnsubscribe(): void;
|
|
162
|
-
onMutationUpdate(action: Action<TData, TError, TVariables,
|
|
163
|
-
getCurrentResult(): MutationObserverResult<TData, TError, TVariables,
|
|
162
|
+
onMutationUpdate(action: Action<TData, TError, TVariables, TOnMutateResult>): void;
|
|
163
|
+
getCurrentResult(): MutationObserverResult<TData, TError, TVariables, TOnMutateResult>;
|
|
164
164
|
reset(): void;
|
|
165
|
-
mutate(variables: TVariables, options?: MutateOptions<TData, TError, TVariables,
|
|
165
|
+
mutate(variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TOnMutateResult>): Promise<TData>;
|
|
166
166
|
}
|
|
167
167
|
|
|
168
168
|
interface MutationCacheConfig {
|
|
169
|
-
onError?: (error: DefaultError, variables: unknown,
|
|
170
|
-
onSuccess?: (data: unknown, variables: unknown,
|
|
171
|
-
onMutate?: (variables: unknown, mutation: Mutation<unknown, unknown, unknown
|
|
172
|
-
onSettled?: (data: unknown | undefined, error: DefaultError | null, variables: unknown,
|
|
169
|
+
onError?: (error: DefaultError, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
170
|
+
onSuccess?: (data: unknown, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
171
|
+
onMutate?: (variables: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
172
|
+
onSettled?: (data: unknown | undefined, error: DefaultError | null, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
173
173
|
}
|
|
174
174
|
interface NotifyEventMutationAdded extends NotifyEvent {
|
|
175
175
|
type: 'added';
|
|
@@ -205,27 +205,28 @@ declare class MutationCache extends Subscribable<MutationCacheListener> {
|
|
|
205
205
|
#private;
|
|
206
206
|
config: MutationCacheConfig;
|
|
207
207
|
constructor(config?: MutationCacheConfig);
|
|
208
|
-
build<TData, TError, TVariables,
|
|
208
|
+
build<TData, TError, TVariables, TOnMutateResult>(client: QueryClient, options: MutationOptions<TData, TError, TVariables, TOnMutateResult>, state?: MutationState<TData, TError, TVariables, TOnMutateResult>): Mutation<TData, TError, TVariables, TOnMutateResult>;
|
|
209
209
|
add(mutation: Mutation<any, any, any, any>): void;
|
|
210
210
|
remove(mutation: Mutation<any, any, any, any>): void;
|
|
211
211
|
canRun(mutation: Mutation<any, any, any, any>): boolean;
|
|
212
212
|
runNext(mutation: Mutation<any, any, any, any>): Promise<unknown>;
|
|
213
213
|
clear(): void;
|
|
214
214
|
getAll(): Array<Mutation>;
|
|
215
|
-
find<TData = unknown, TError = DefaultError, TVariables = any,
|
|
215
|
+
find<TData = unknown, TError = DefaultError, TVariables = any, TOnMutateResult = unknown>(filters: MutationFilters): Mutation<TData, TError, TVariables, TOnMutateResult> | undefined;
|
|
216
216
|
findAll(filters?: MutationFilters): Array<Mutation>;
|
|
217
217
|
notify(event: MutationCacheNotifyEvent): void;
|
|
218
218
|
resumePausedMutations(): Promise<unknown>;
|
|
219
219
|
}
|
|
220
220
|
|
|
221
|
-
interface MutationConfig<TData, TError, TVariables,
|
|
221
|
+
interface MutationConfig<TData, TError, TVariables, TOnMutateResult> {
|
|
222
|
+
client: QueryClient;
|
|
222
223
|
mutationId: number;
|
|
223
224
|
mutationCache: MutationCache;
|
|
224
|
-
options: MutationOptions<TData, TError, TVariables,
|
|
225
|
-
state?: MutationState<TData, TError, TVariables,
|
|
225
|
+
options: MutationOptions<TData, TError, TVariables, TOnMutateResult>;
|
|
226
|
+
state?: MutationState<TData, TError, TVariables, TOnMutateResult>;
|
|
226
227
|
}
|
|
227
|
-
interface MutationState<TData = unknown, TError = DefaultError, TVariables = unknown,
|
|
228
|
-
context:
|
|
228
|
+
interface MutationState<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> {
|
|
229
|
+
context: TOnMutateResult | undefined;
|
|
229
230
|
data: TData | undefined;
|
|
230
231
|
error: TError | null;
|
|
231
232
|
failureCount: number;
|
|
@@ -240,11 +241,11 @@ interface FailedAction<TError> {
|
|
|
240
241
|
failureCount: number;
|
|
241
242
|
error: TError | null;
|
|
242
243
|
}
|
|
243
|
-
interface PendingAction<TVariables,
|
|
244
|
+
interface PendingAction<TVariables, TOnMutateResult> {
|
|
244
245
|
type: 'pending';
|
|
245
246
|
isPaused: boolean;
|
|
246
247
|
variables?: TVariables;
|
|
247
|
-
context?:
|
|
248
|
+
context?: TOnMutateResult;
|
|
248
249
|
}
|
|
249
250
|
interface SuccessAction<TData> {
|
|
250
251
|
type: 'success';
|
|
@@ -260,14 +261,14 @@ interface PauseAction {
|
|
|
260
261
|
interface ContinueAction {
|
|
261
262
|
type: 'continue';
|
|
262
263
|
}
|
|
263
|
-
type Action<TData, TError, TVariables,
|
|
264
|
-
declare class Mutation<TData = unknown, TError = DefaultError, TVariables = unknown,
|
|
264
|
+
type Action<TData, TError, TVariables, TOnMutateResult> = ContinueAction | ErrorAction<TError> | FailedAction<TError> | PendingAction<TVariables, TOnMutateResult> | PauseAction | SuccessAction<TData>;
|
|
265
|
+
declare class Mutation<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> extends Removable {
|
|
265
266
|
#private;
|
|
266
|
-
state: MutationState<TData, TError, TVariables,
|
|
267
|
-
options: MutationOptions<TData, TError, TVariables,
|
|
267
|
+
state: MutationState<TData, TError, TVariables, TOnMutateResult>;
|
|
268
|
+
options: MutationOptions<TData, TError, TVariables, TOnMutateResult>;
|
|
268
269
|
readonly mutationId: number;
|
|
269
|
-
constructor(config: MutationConfig<TData, TError, TVariables,
|
|
270
|
-
setOptions(options: MutationOptions<TData, TError, TVariables,
|
|
270
|
+
constructor(config: MutationConfig<TData, TError, TVariables, TOnMutateResult>);
|
|
271
|
+
setOptions(options: MutationOptions<TData, TError, TVariables, TOnMutateResult>): void;
|
|
271
272
|
get meta(): MutationMeta | undefined;
|
|
272
273
|
addObserver(observer: MutationObserver<any, any, any, any>): void;
|
|
273
274
|
removeObserver(observer: MutationObserver<any, any, any, any>): void;
|
|
@@ -275,7 +276,7 @@ declare class Mutation<TData = unknown, TError = DefaultError, TVariables = unkn
|
|
|
275
276
|
continue(): Promise<unknown>;
|
|
276
277
|
execute(variables: TVariables): Promise<TData>;
|
|
277
278
|
}
|
|
278
|
-
declare function getDefaultState<TData, TError, TVariables,
|
|
279
|
+
declare function getDefaultState<TData, TError, TVariables, TOnMutateResult>(): MutationState<TData, TError, TVariables, TOnMutateResult>;
|
|
279
280
|
|
|
280
281
|
interface QueryFilters<TQueryKey extends QueryKey = QueryKey> {
|
|
281
282
|
/**
|
|
@@ -303,7 +304,7 @@ interface QueryFilters<TQueryKey extends QueryKey = QueryKey> {
|
|
|
303
304
|
*/
|
|
304
305
|
fetchStatus?: FetchStatus;
|
|
305
306
|
}
|
|
306
|
-
interface MutationFilters<TData = unknown, TError = DefaultError, TVariables = unknown,
|
|
307
|
+
interface MutationFilters<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> {
|
|
307
308
|
/**
|
|
308
309
|
* Match mutation key exactly
|
|
309
310
|
*/
|
|
@@ -311,7 +312,7 @@ interface MutationFilters<TData = unknown, TError = DefaultError, TVariables = u
|
|
|
311
312
|
/**
|
|
312
313
|
* Include mutations matching this predicate function
|
|
313
314
|
*/
|
|
314
|
-
predicate?: (mutation: Mutation<TData, TError, TVariables,
|
|
315
|
+
predicate?: (mutation: Mutation<TData, TError, TVariables, TOnMutateResult>) => boolean;
|
|
315
316
|
/**
|
|
316
317
|
* Include mutations matching this mutation key
|
|
317
318
|
*/
|
|
@@ -468,7 +469,7 @@ declare class QueryClient {
|
|
|
468
469
|
setDefaultOptions(options: DefaultOptions): void;
|
|
469
470
|
setQueryDefaults<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData>(queryKey: QueryKey, options: Partial<OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData>, 'queryKey'>>): void;
|
|
470
471
|
getQueryDefaults(queryKey: QueryKey): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'>;
|
|
471
|
-
setMutationDefaults<TData = unknown, TError = DefaultError, TVariables = void,
|
|
472
|
+
setMutationDefaults<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown>(mutationKey: MutationKey, options: OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>, 'mutationKey'>): void;
|
|
472
473
|
getMutationDefaults(mutationKey: MutationKey): OmitKeyof<MutationObserverOptions<any, any, any, any>, 'mutationKey'>;
|
|
473
474
|
defaultQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam> | DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
|
|
474
475
|
defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(options?: T): T;
|
|
@@ -1182,14 +1183,19 @@ type MutationScope = {
|
|
|
1182
1183
|
type MutationMeta = Register extends {
|
|
1183
1184
|
mutationMeta: infer TMutationMeta;
|
|
1184
1185
|
} ? TMutationMeta extends Record<string, unknown> ? TMutationMeta : Record<string, unknown> : Record<string, unknown>;
|
|
1185
|
-
type
|
|
1186
|
-
|
|
1186
|
+
type MutationFunctionContext = {
|
|
1187
|
+
client: QueryClient;
|
|
1188
|
+
meta: MutationMeta | undefined;
|
|
1189
|
+
mutationKey?: MutationKey;
|
|
1190
|
+
};
|
|
1191
|
+
type MutationFunction<TData = unknown, TVariables = unknown> = (variables: TVariables, context: MutationFunctionContext) => Promise<TData>;
|
|
1192
|
+
interface MutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> {
|
|
1187
1193
|
mutationFn?: MutationFunction<TData, TVariables>;
|
|
1188
1194
|
mutationKey?: MutationKey;
|
|
1189
|
-
onMutate?: (variables: TVariables) => Promise<
|
|
1190
|
-
onSuccess?: (data: TData, variables: TVariables, context:
|
|
1191
|
-
onError?: (error: TError, variables: TVariables,
|
|
1192
|
-
onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables,
|
|
1195
|
+
onMutate?: (variables: TVariables, context: MutationFunctionContext) => Promise<TOnMutateResult | undefined> | TOnMutateResult | undefined;
|
|
1196
|
+
onSuccess?: (data: TData, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
1197
|
+
onError?: (error: TError, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
1198
|
+
onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
1193
1199
|
retry?: RetryValue<TError>;
|
|
1194
1200
|
retryDelay?: RetryDelayValue<TError>;
|
|
1195
1201
|
networkMode?: NetworkMode;
|
|
@@ -1198,16 +1204,16 @@ interface MutationOptions<TData = unknown, TError = DefaultError, TVariables = v
|
|
|
1198
1204
|
meta?: MutationMeta;
|
|
1199
1205
|
scope?: MutationScope;
|
|
1200
1206
|
}
|
|
1201
|
-
interface MutationObserverOptions<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1207
|
+
interface MutationObserverOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationOptions<TData, TError, TVariables, TOnMutateResult> {
|
|
1202
1208
|
throwOnError?: boolean | ((error: TError) => boolean);
|
|
1203
1209
|
}
|
|
1204
|
-
interface MutateOptions<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1205
|
-
onSuccess?: (data: TData, variables: TVariables, context:
|
|
1206
|
-
onError?: (error: TError, variables: TVariables,
|
|
1207
|
-
onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables,
|
|
1210
|
+
interface MutateOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> {
|
|
1211
|
+
onSuccess?: (data: TData, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => void;
|
|
1212
|
+
onError?: (error: TError, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => void;
|
|
1213
|
+
onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => void;
|
|
1208
1214
|
}
|
|
1209
|
-
type MutateFunction<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1210
|
-
interface MutationObserverBaseResult<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1215
|
+
type MutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TOnMutateResult>) => Promise<TData>;
|
|
1216
|
+
interface MutationObserverBaseResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationState<TData, TError, TVariables, TOnMutateResult> {
|
|
1211
1217
|
/**
|
|
1212
1218
|
* The last successfully resolved data for the mutation.
|
|
1213
1219
|
*/
|
|
@@ -1260,13 +1266,13 @@ interface MutationObserverBaseResult<TData = unknown, TError = DefaultError, TVa
|
|
|
1260
1266
|
* - If you make multiple requests, `onSuccess` will fire only after the latest call you've made.
|
|
1261
1267
|
* - All the callback functions (`onSuccess`, `onError`, `onSettled`) are void functions, and the returned value will be ignored.
|
|
1262
1268
|
*/
|
|
1263
|
-
mutate: MutateFunction<TData, TError, TVariables,
|
|
1269
|
+
mutate: MutateFunction<TData, TError, TVariables, TOnMutateResult>;
|
|
1264
1270
|
/**
|
|
1265
1271
|
* A function to clean the mutation internal state (i.e., it resets the mutation to its initial state).
|
|
1266
1272
|
*/
|
|
1267
1273
|
reset: () => void;
|
|
1268
1274
|
}
|
|
1269
|
-
interface MutationObserverIdleResult<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1275
|
+
interface MutationObserverIdleResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
|
|
1270
1276
|
data: undefined;
|
|
1271
1277
|
variables: undefined;
|
|
1272
1278
|
error: null;
|
|
@@ -1276,7 +1282,7 @@ interface MutationObserverIdleResult<TData = unknown, TError = DefaultError, TVa
|
|
|
1276
1282
|
isSuccess: false;
|
|
1277
1283
|
status: 'idle';
|
|
1278
1284
|
}
|
|
1279
|
-
interface MutationObserverLoadingResult<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1285
|
+
interface MutationObserverLoadingResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
|
|
1280
1286
|
data: undefined;
|
|
1281
1287
|
variables: TVariables;
|
|
1282
1288
|
error: null;
|
|
@@ -1286,7 +1292,7 @@ interface MutationObserverLoadingResult<TData = unknown, TError = DefaultError,
|
|
|
1286
1292
|
isSuccess: false;
|
|
1287
1293
|
status: 'pending';
|
|
1288
1294
|
}
|
|
1289
|
-
interface MutationObserverErrorResult<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1295
|
+
interface MutationObserverErrorResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
|
|
1290
1296
|
data: undefined;
|
|
1291
1297
|
error: TError;
|
|
1292
1298
|
variables: TVariables;
|
|
@@ -1296,7 +1302,7 @@ interface MutationObserverErrorResult<TData = unknown, TError = DefaultError, TV
|
|
|
1296
1302
|
isSuccess: false;
|
|
1297
1303
|
status: 'error';
|
|
1298
1304
|
}
|
|
1299
|
-
interface MutationObserverSuccessResult<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1305
|
+
interface MutationObserverSuccessResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
|
|
1300
1306
|
data: TData;
|
|
1301
1307
|
error: null;
|
|
1302
1308
|
variables: TVariables;
|
|
@@ -1306,7 +1312,7 @@ interface MutationObserverSuccessResult<TData = unknown, TError = DefaultError,
|
|
|
1306
1312
|
isSuccess: true;
|
|
1307
1313
|
status: 'success';
|
|
1308
1314
|
}
|
|
1309
|
-
type MutationObserverResult<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1315
|
+
type MutationObserverResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = MutationObserverIdleResult<TData, TError, TVariables, TOnMutateResult> | MutationObserverLoadingResult<TData, TError, TVariables, TOnMutateResult> | MutationObserverErrorResult<TData, TError, TVariables, TOnMutateResult> | MutationObserverSuccessResult<TData, TError, TVariables, TOnMutateResult>;
|
|
1310
1316
|
interface QueryClientConfig {
|
|
1311
1317
|
queryCache?: QueryCache;
|
|
1312
1318
|
mutationCache?: MutationCache;
|
|
@@ -1367,4 +1373,4 @@ declare function defaultShouldDehydrateQuery(query: Query): boolean;
|
|
|
1367
1373
|
declare function dehydrate(client: QueryClient, options?: DehydrateOptions): DehydratedState;
|
|
1368
1374
|
declare function hydrate(client: QueryClient, dehydratedState: unknown, options?: HydrateOptions): void;
|
|
1369
1375
|
|
|
1370
|
-
export { type Enabled as $, type QueryState as A, type DistributiveOmit as B, CancelledError as C, type DehydratedState as D, type Override as E, type NoInfer as F, type DefaultError as G, type HydrateOptions as H, type QueryKey as I, dataTagSymbol as J, dataTagErrorSymbol as K, unsetMarker as L, MutationCache as M, type NonUndefinedGuard as N, type OmitKeyof as O, type UnsetMarker as P, QueryCache as Q, type Register as R, type SkipToken as S, type AnyDataTag as T, type Updater as U, type DataTag as V, type InferDataFromTag as W, type InferErrorFromTag as X, type QueryFunction as Y, type StaleTime as Z, type StaleTimeFunction as _, defaultShouldDehydrateQuery as a, type
|
|
1376
|
+
export { type Enabled as $, type QueryState as A, type DistributiveOmit as B, CancelledError as C, type DehydratedState as D, type Override as E, type NoInfer as F, type DefaultError as G, type HydrateOptions as H, type QueryKey as I, dataTagSymbol as J, dataTagErrorSymbol as K, unsetMarker as L, MutationCache as M, type NonUndefinedGuard as N, type OmitKeyof as O, type UnsetMarker as P, QueryCache as Q, type Register as R, type SkipToken as S, type AnyDataTag as T, type Updater as U, type DataTag as V, type InferDataFromTag as W, type InferErrorFromTag as X, type QueryFunction as Y, type StaleTime as Z, type StaleTimeFunction as _, defaultShouldDehydrateQuery as a, type MutationObserverBaseResult as a$, type QueryPersister as a0, type QueryFunctionContext as a1, type InitialDataFunction as a2, type PlaceholderDataFunction as a3, type QueriesPlaceholderDataFunction as a4, type QueryKeyHashFunction as a5, type GetPreviousPageParamFunction as a6, type GetNextPageParamFunction as a7, type InfiniteData as a8, type QueryMeta as a9, type QueryObserverPendingResult as aA, type QueryObserverLoadingResult as aB, type QueryObserverLoadingErrorResult as aC, type QueryObserverRefetchErrorResult as aD, type QueryObserverSuccessResult as aE, type QueryObserverPlaceholderResult as aF, type DefinedQueryObserverResult as aG, type QueryObserverResult as aH, type InfiniteQueryObserverBaseResult as aI, type InfiniteQueryObserverPendingResult as aJ, type InfiniteQueryObserverLoadingResult as aK, type InfiniteQueryObserverLoadingErrorResult as aL, type InfiniteQueryObserverRefetchErrorResult as aM, type InfiniteQueryObserverSuccessResult as aN, type InfiniteQueryObserverPlaceholderResult as aO, type DefinedInfiniteQueryObserverResult as aP, type InfiniteQueryObserverResult as aQ, type MutationKey as aR, type MutationStatus as aS, type MutationScope as aT, type MutationMeta as aU, type MutationFunctionContext as aV, type MutationFunction as aW, type MutationOptions as aX, type MutationObserverOptions as aY, type MutateOptions as aZ, type MutateFunction as a_, type NetworkMode as aa, type NotifyOnChangeProps as ab, type QueryOptions as ac, type InitialPageParam as ad, type InfiniteQueryPageParamsOptions as ae, type ThrowOnError as af, type QueryObserverOptions as ag, type WithRequired as ah, type DefaultedQueryObserverOptions as ai, type InfiniteQueryObserverOptions as aj, type DefaultedInfiniteQueryObserverOptions as ak, type FetchQueryOptions as al, type EnsureQueryDataOptions as am, type EnsureInfiniteQueryDataOptions as an, type FetchInfiniteQueryOptions as ao, type ResultOptions as ap, type RefetchOptions as aq, type InvalidateQueryFilters as ar, type RefetchQueryFilters as as, type InvalidateOptions as at, type ResetOptions as au, type FetchNextPageOptions as av, type FetchPreviousPageOptions as aw, type QueryStatus as ax, type FetchStatus as ay, type QueryObserverBaseResult as az, dehydrate as b, type MutationObserverIdleResult as b0, type MutationObserverLoadingResult as b1, type MutationObserverErrorResult as b2, type MutationObserverSuccessResult as b3, type MutationObserverResult as b4, type QueryClientConfig as b5, type DefaultOptions as b6, type CancelOptions as b7, type SetDataOptions as b8, type NotifyEventType as b9, type QueryStore as bA, type Retryer as bB, type RetryValue as bC, type RetryDelayValue as bD, canFetch as bE, createRetryer as bF, type NotifyEvent as ba, type QueryBehavior as bb, type FetchContext as bc, type FetchDirection as bd, type FetchMeta as be, type FetchOptions as bf, type Action$1 as bg, type SetStateOptions as bh, fetchState as bi, type Action as bj, getDefaultState as bk, type QueryTypeFilter as bl, functionalUpdate as bm, isValidTimeout as bn, timeUntilStale as bo, resolveStaleTime as bp, resolveEnabled as bq, hashQueryKeyByOptions as br, shallowEqualObjects as bs, isPlainArray as bt, isPlainObject as bu, sleep as bv, replaceData as bw, addToEnd as bx, addToStart as by, ensureQueryFn as bz, type MutationCacheNotifyEvent as c, defaultShouldDehydrateMutation as d, MutationObserver as e, type QueryCacheNotifyEvent as f, QueryClient as g, hydrate as h, QueryObserver as i, isCancelledError as j, hashKey as k, isServer as l, keepPreviousData as m, matchMutation as n, matchQuery as o, noop as p, partialMatchKey as q, replaceEqualDeep as r, shouldThrowError as s, skipToken as t, type MutationFilters as u, type QueryFilters as v, type DehydrateOptions as w, Mutation as x, type MutationState as y, Query as z };
|
|
@@ -151,25 +151,25 @@ declare function fetchState<TQueryFnData, TError, TData, TQueryKey extends Query
|
|
|
151
151
|
readonly fetchStatus: "fetching" | "paused";
|
|
152
152
|
};
|
|
153
153
|
|
|
154
|
-
type MutationObserverListener<TData, TError, TVariables,
|
|
155
|
-
declare class MutationObserver<TData = unknown, TError = DefaultError, TVariables = void,
|
|
154
|
+
type MutationObserverListener<TData, TError, TVariables, TOnMutateResult> = (result: MutationObserverResult<TData, TError, TVariables, TOnMutateResult>) => void;
|
|
155
|
+
declare class MutationObserver<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends Subscribable<MutationObserverListener<TData, TError, TVariables, TOnMutateResult>> {
|
|
156
156
|
#private;
|
|
157
|
-
options: MutationObserverOptions<TData, TError, TVariables,
|
|
158
|
-
constructor(client: QueryClient, options: MutationObserverOptions<TData, TError, TVariables,
|
|
157
|
+
options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>;
|
|
158
|
+
constructor(client: QueryClient, options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>);
|
|
159
159
|
protected bindMethods(): void;
|
|
160
|
-
setOptions(options: MutationObserverOptions<TData, TError, TVariables,
|
|
160
|
+
setOptions(options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>): void;
|
|
161
161
|
protected onUnsubscribe(): void;
|
|
162
|
-
onMutationUpdate(action: Action<TData, TError, TVariables,
|
|
163
|
-
getCurrentResult(): MutationObserverResult<TData, TError, TVariables,
|
|
162
|
+
onMutationUpdate(action: Action<TData, TError, TVariables, TOnMutateResult>): void;
|
|
163
|
+
getCurrentResult(): MutationObserverResult<TData, TError, TVariables, TOnMutateResult>;
|
|
164
164
|
reset(): void;
|
|
165
|
-
mutate(variables: TVariables, options?: MutateOptions<TData, TError, TVariables,
|
|
165
|
+
mutate(variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TOnMutateResult>): Promise<TData>;
|
|
166
166
|
}
|
|
167
167
|
|
|
168
168
|
interface MutationCacheConfig {
|
|
169
|
-
onError?: (error: DefaultError, variables: unknown,
|
|
170
|
-
onSuccess?: (data: unknown, variables: unknown,
|
|
171
|
-
onMutate?: (variables: unknown, mutation: Mutation<unknown, unknown, unknown
|
|
172
|
-
onSettled?: (data: unknown | undefined, error: DefaultError | null, variables: unknown,
|
|
169
|
+
onError?: (error: DefaultError, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
170
|
+
onSuccess?: (data: unknown, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
171
|
+
onMutate?: (variables: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
172
|
+
onSettled?: (data: unknown | undefined, error: DefaultError | null, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
173
173
|
}
|
|
174
174
|
interface NotifyEventMutationAdded extends NotifyEvent {
|
|
175
175
|
type: 'added';
|
|
@@ -205,27 +205,28 @@ declare class MutationCache extends Subscribable<MutationCacheListener> {
|
|
|
205
205
|
#private;
|
|
206
206
|
config: MutationCacheConfig;
|
|
207
207
|
constructor(config?: MutationCacheConfig);
|
|
208
|
-
build<TData, TError, TVariables,
|
|
208
|
+
build<TData, TError, TVariables, TOnMutateResult>(client: QueryClient, options: MutationOptions<TData, TError, TVariables, TOnMutateResult>, state?: MutationState<TData, TError, TVariables, TOnMutateResult>): Mutation<TData, TError, TVariables, TOnMutateResult>;
|
|
209
209
|
add(mutation: Mutation<any, any, any, any>): void;
|
|
210
210
|
remove(mutation: Mutation<any, any, any, any>): void;
|
|
211
211
|
canRun(mutation: Mutation<any, any, any, any>): boolean;
|
|
212
212
|
runNext(mutation: Mutation<any, any, any, any>): Promise<unknown>;
|
|
213
213
|
clear(): void;
|
|
214
214
|
getAll(): Array<Mutation>;
|
|
215
|
-
find<TData = unknown, TError = DefaultError, TVariables = any,
|
|
215
|
+
find<TData = unknown, TError = DefaultError, TVariables = any, TOnMutateResult = unknown>(filters: MutationFilters): Mutation<TData, TError, TVariables, TOnMutateResult> | undefined;
|
|
216
216
|
findAll(filters?: MutationFilters): Array<Mutation>;
|
|
217
217
|
notify(event: MutationCacheNotifyEvent): void;
|
|
218
218
|
resumePausedMutations(): Promise<unknown>;
|
|
219
219
|
}
|
|
220
220
|
|
|
221
|
-
interface MutationConfig<TData, TError, TVariables,
|
|
221
|
+
interface MutationConfig<TData, TError, TVariables, TOnMutateResult> {
|
|
222
|
+
client: QueryClient;
|
|
222
223
|
mutationId: number;
|
|
223
224
|
mutationCache: MutationCache;
|
|
224
|
-
options: MutationOptions<TData, TError, TVariables,
|
|
225
|
-
state?: MutationState<TData, TError, TVariables,
|
|
225
|
+
options: MutationOptions<TData, TError, TVariables, TOnMutateResult>;
|
|
226
|
+
state?: MutationState<TData, TError, TVariables, TOnMutateResult>;
|
|
226
227
|
}
|
|
227
|
-
interface MutationState<TData = unknown, TError = DefaultError, TVariables = unknown,
|
|
228
|
-
context:
|
|
228
|
+
interface MutationState<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> {
|
|
229
|
+
context: TOnMutateResult | undefined;
|
|
229
230
|
data: TData | undefined;
|
|
230
231
|
error: TError | null;
|
|
231
232
|
failureCount: number;
|
|
@@ -240,11 +241,11 @@ interface FailedAction<TError> {
|
|
|
240
241
|
failureCount: number;
|
|
241
242
|
error: TError | null;
|
|
242
243
|
}
|
|
243
|
-
interface PendingAction<TVariables,
|
|
244
|
+
interface PendingAction<TVariables, TOnMutateResult> {
|
|
244
245
|
type: 'pending';
|
|
245
246
|
isPaused: boolean;
|
|
246
247
|
variables?: TVariables;
|
|
247
|
-
context?:
|
|
248
|
+
context?: TOnMutateResult;
|
|
248
249
|
}
|
|
249
250
|
interface SuccessAction<TData> {
|
|
250
251
|
type: 'success';
|
|
@@ -260,14 +261,14 @@ interface PauseAction {
|
|
|
260
261
|
interface ContinueAction {
|
|
261
262
|
type: 'continue';
|
|
262
263
|
}
|
|
263
|
-
type Action<TData, TError, TVariables,
|
|
264
|
-
declare class Mutation<TData = unknown, TError = DefaultError, TVariables = unknown,
|
|
264
|
+
type Action<TData, TError, TVariables, TOnMutateResult> = ContinueAction | ErrorAction<TError> | FailedAction<TError> | PendingAction<TVariables, TOnMutateResult> | PauseAction | SuccessAction<TData>;
|
|
265
|
+
declare class Mutation<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> extends Removable {
|
|
265
266
|
#private;
|
|
266
|
-
state: MutationState<TData, TError, TVariables,
|
|
267
|
-
options: MutationOptions<TData, TError, TVariables,
|
|
267
|
+
state: MutationState<TData, TError, TVariables, TOnMutateResult>;
|
|
268
|
+
options: MutationOptions<TData, TError, TVariables, TOnMutateResult>;
|
|
268
269
|
readonly mutationId: number;
|
|
269
|
-
constructor(config: MutationConfig<TData, TError, TVariables,
|
|
270
|
-
setOptions(options: MutationOptions<TData, TError, TVariables,
|
|
270
|
+
constructor(config: MutationConfig<TData, TError, TVariables, TOnMutateResult>);
|
|
271
|
+
setOptions(options: MutationOptions<TData, TError, TVariables, TOnMutateResult>): void;
|
|
271
272
|
get meta(): MutationMeta | undefined;
|
|
272
273
|
addObserver(observer: MutationObserver<any, any, any, any>): void;
|
|
273
274
|
removeObserver(observer: MutationObserver<any, any, any, any>): void;
|
|
@@ -275,7 +276,7 @@ declare class Mutation<TData = unknown, TError = DefaultError, TVariables = unkn
|
|
|
275
276
|
continue(): Promise<unknown>;
|
|
276
277
|
execute(variables: TVariables): Promise<TData>;
|
|
277
278
|
}
|
|
278
|
-
declare function getDefaultState<TData, TError, TVariables,
|
|
279
|
+
declare function getDefaultState<TData, TError, TVariables, TOnMutateResult>(): MutationState<TData, TError, TVariables, TOnMutateResult>;
|
|
279
280
|
|
|
280
281
|
interface QueryFilters<TQueryKey extends QueryKey = QueryKey> {
|
|
281
282
|
/**
|
|
@@ -303,7 +304,7 @@ interface QueryFilters<TQueryKey extends QueryKey = QueryKey> {
|
|
|
303
304
|
*/
|
|
304
305
|
fetchStatus?: FetchStatus;
|
|
305
306
|
}
|
|
306
|
-
interface MutationFilters<TData = unknown, TError = DefaultError, TVariables = unknown,
|
|
307
|
+
interface MutationFilters<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> {
|
|
307
308
|
/**
|
|
308
309
|
* Match mutation key exactly
|
|
309
310
|
*/
|
|
@@ -311,7 +312,7 @@ interface MutationFilters<TData = unknown, TError = DefaultError, TVariables = u
|
|
|
311
312
|
/**
|
|
312
313
|
* Include mutations matching this predicate function
|
|
313
314
|
*/
|
|
314
|
-
predicate?: (mutation: Mutation<TData, TError, TVariables,
|
|
315
|
+
predicate?: (mutation: Mutation<TData, TError, TVariables, TOnMutateResult>) => boolean;
|
|
315
316
|
/**
|
|
316
317
|
* Include mutations matching this mutation key
|
|
317
318
|
*/
|
|
@@ -468,7 +469,7 @@ declare class QueryClient {
|
|
|
468
469
|
setDefaultOptions(options: DefaultOptions): void;
|
|
469
470
|
setQueryDefaults<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData>(queryKey: QueryKey, options: Partial<OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData>, 'queryKey'>>): void;
|
|
470
471
|
getQueryDefaults(queryKey: QueryKey): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'>;
|
|
471
|
-
setMutationDefaults<TData = unknown, TError = DefaultError, TVariables = void,
|
|
472
|
+
setMutationDefaults<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown>(mutationKey: MutationKey, options: OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>, 'mutationKey'>): void;
|
|
472
473
|
getMutationDefaults(mutationKey: MutationKey): OmitKeyof<MutationObserverOptions<any, any, any, any>, 'mutationKey'>;
|
|
473
474
|
defaultQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam> | DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
|
|
474
475
|
defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(options?: T): T;
|
|
@@ -1182,14 +1183,19 @@ type MutationScope = {
|
|
|
1182
1183
|
type MutationMeta = Register extends {
|
|
1183
1184
|
mutationMeta: infer TMutationMeta;
|
|
1184
1185
|
} ? TMutationMeta extends Record<string, unknown> ? TMutationMeta : Record<string, unknown> : Record<string, unknown>;
|
|
1185
|
-
type
|
|
1186
|
-
|
|
1186
|
+
type MutationFunctionContext = {
|
|
1187
|
+
client: QueryClient;
|
|
1188
|
+
meta: MutationMeta | undefined;
|
|
1189
|
+
mutationKey?: MutationKey;
|
|
1190
|
+
};
|
|
1191
|
+
type MutationFunction<TData = unknown, TVariables = unknown> = (variables: TVariables, context: MutationFunctionContext) => Promise<TData>;
|
|
1192
|
+
interface MutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> {
|
|
1187
1193
|
mutationFn?: MutationFunction<TData, TVariables>;
|
|
1188
1194
|
mutationKey?: MutationKey;
|
|
1189
|
-
onMutate?: (variables: TVariables) => Promise<
|
|
1190
|
-
onSuccess?: (data: TData, variables: TVariables, context:
|
|
1191
|
-
onError?: (error: TError, variables: TVariables,
|
|
1192
|
-
onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables,
|
|
1195
|
+
onMutate?: (variables: TVariables, context: MutationFunctionContext) => Promise<TOnMutateResult | undefined> | TOnMutateResult | undefined;
|
|
1196
|
+
onSuccess?: (data: TData, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
1197
|
+
onError?: (error: TError, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
1198
|
+
onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => Promise<unknown> | unknown;
|
|
1193
1199
|
retry?: RetryValue<TError>;
|
|
1194
1200
|
retryDelay?: RetryDelayValue<TError>;
|
|
1195
1201
|
networkMode?: NetworkMode;
|
|
@@ -1198,16 +1204,16 @@ interface MutationOptions<TData = unknown, TError = DefaultError, TVariables = v
|
|
|
1198
1204
|
meta?: MutationMeta;
|
|
1199
1205
|
scope?: MutationScope;
|
|
1200
1206
|
}
|
|
1201
|
-
interface MutationObserverOptions<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1207
|
+
interface MutationObserverOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationOptions<TData, TError, TVariables, TOnMutateResult> {
|
|
1202
1208
|
throwOnError?: boolean | ((error: TError) => boolean);
|
|
1203
1209
|
}
|
|
1204
|
-
interface MutateOptions<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1205
|
-
onSuccess?: (data: TData, variables: TVariables, context:
|
|
1206
|
-
onError?: (error: TError, variables: TVariables,
|
|
1207
|
-
onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables,
|
|
1210
|
+
interface MutateOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> {
|
|
1211
|
+
onSuccess?: (data: TData, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => void;
|
|
1212
|
+
onError?: (error: TError, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => void;
|
|
1213
|
+
onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => void;
|
|
1208
1214
|
}
|
|
1209
|
-
type MutateFunction<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1210
|
-
interface MutationObserverBaseResult<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1215
|
+
type MutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TOnMutateResult>) => Promise<TData>;
|
|
1216
|
+
interface MutationObserverBaseResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationState<TData, TError, TVariables, TOnMutateResult> {
|
|
1211
1217
|
/**
|
|
1212
1218
|
* The last successfully resolved data for the mutation.
|
|
1213
1219
|
*/
|
|
@@ -1260,13 +1266,13 @@ interface MutationObserverBaseResult<TData = unknown, TError = DefaultError, TVa
|
|
|
1260
1266
|
* - If you make multiple requests, `onSuccess` will fire only after the latest call you've made.
|
|
1261
1267
|
* - All the callback functions (`onSuccess`, `onError`, `onSettled`) are void functions, and the returned value will be ignored.
|
|
1262
1268
|
*/
|
|
1263
|
-
mutate: MutateFunction<TData, TError, TVariables,
|
|
1269
|
+
mutate: MutateFunction<TData, TError, TVariables, TOnMutateResult>;
|
|
1264
1270
|
/**
|
|
1265
1271
|
* A function to clean the mutation internal state (i.e., it resets the mutation to its initial state).
|
|
1266
1272
|
*/
|
|
1267
1273
|
reset: () => void;
|
|
1268
1274
|
}
|
|
1269
|
-
interface MutationObserverIdleResult<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1275
|
+
interface MutationObserverIdleResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
|
|
1270
1276
|
data: undefined;
|
|
1271
1277
|
variables: undefined;
|
|
1272
1278
|
error: null;
|
|
@@ -1276,7 +1282,7 @@ interface MutationObserverIdleResult<TData = unknown, TError = DefaultError, TVa
|
|
|
1276
1282
|
isSuccess: false;
|
|
1277
1283
|
status: 'idle';
|
|
1278
1284
|
}
|
|
1279
|
-
interface MutationObserverLoadingResult<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1285
|
+
interface MutationObserverLoadingResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
|
|
1280
1286
|
data: undefined;
|
|
1281
1287
|
variables: TVariables;
|
|
1282
1288
|
error: null;
|
|
@@ -1286,7 +1292,7 @@ interface MutationObserverLoadingResult<TData = unknown, TError = DefaultError,
|
|
|
1286
1292
|
isSuccess: false;
|
|
1287
1293
|
status: 'pending';
|
|
1288
1294
|
}
|
|
1289
|
-
interface MutationObserverErrorResult<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1295
|
+
interface MutationObserverErrorResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
|
|
1290
1296
|
data: undefined;
|
|
1291
1297
|
error: TError;
|
|
1292
1298
|
variables: TVariables;
|
|
@@ -1296,7 +1302,7 @@ interface MutationObserverErrorResult<TData = unknown, TError = DefaultError, TV
|
|
|
1296
1302
|
isSuccess: false;
|
|
1297
1303
|
status: 'error';
|
|
1298
1304
|
}
|
|
1299
|
-
interface MutationObserverSuccessResult<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1305
|
+
interface MutationObserverSuccessResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
|
|
1300
1306
|
data: TData;
|
|
1301
1307
|
error: null;
|
|
1302
1308
|
variables: TVariables;
|
|
@@ -1306,7 +1312,7 @@ interface MutationObserverSuccessResult<TData = unknown, TError = DefaultError,
|
|
|
1306
1312
|
isSuccess: true;
|
|
1307
1313
|
status: 'success';
|
|
1308
1314
|
}
|
|
1309
|
-
type MutationObserverResult<TData = unknown, TError = DefaultError, TVariables = void,
|
|
1315
|
+
type MutationObserverResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = MutationObserverIdleResult<TData, TError, TVariables, TOnMutateResult> | MutationObserverLoadingResult<TData, TError, TVariables, TOnMutateResult> | MutationObserverErrorResult<TData, TError, TVariables, TOnMutateResult> | MutationObserverSuccessResult<TData, TError, TVariables, TOnMutateResult>;
|
|
1310
1316
|
interface QueryClientConfig {
|
|
1311
1317
|
queryCache?: QueryCache;
|
|
1312
1318
|
mutationCache?: MutationCache;
|
|
@@ -1367,4 +1373,4 @@ declare function defaultShouldDehydrateQuery(query: Query): boolean;
|
|
|
1367
1373
|
declare function dehydrate(client: QueryClient, options?: DehydrateOptions): DehydratedState;
|
|
1368
1374
|
declare function hydrate(client: QueryClient, dehydratedState: unknown, options?: HydrateOptions): void;
|
|
1369
1375
|
|
|
1370
|
-
export { type Enabled as $, type QueryState as A, type DistributiveOmit as B, CancelledError as C, type DehydratedState as D, type Override as E, type NoInfer as F, type DefaultError as G, type HydrateOptions as H, type QueryKey as I, dataTagSymbol as J, dataTagErrorSymbol as K, unsetMarker as L, MutationCache as M, type NonUndefinedGuard as N, type OmitKeyof as O, type UnsetMarker as P, QueryCache as Q, type Register as R, type SkipToken as S, type AnyDataTag as T, type Updater as U, type DataTag as V, type InferDataFromTag as W, type InferErrorFromTag as X, type QueryFunction as Y, type StaleTime as Z, type StaleTimeFunction as _, defaultShouldDehydrateQuery as a, type
|
|
1376
|
+
export { type Enabled as $, type QueryState as A, type DistributiveOmit as B, CancelledError as C, type DehydratedState as D, type Override as E, type NoInfer as F, type DefaultError as G, type HydrateOptions as H, type QueryKey as I, dataTagSymbol as J, dataTagErrorSymbol as K, unsetMarker as L, MutationCache as M, type NonUndefinedGuard as N, type OmitKeyof as O, type UnsetMarker as P, QueryCache as Q, type Register as R, type SkipToken as S, type AnyDataTag as T, type Updater as U, type DataTag as V, type InferDataFromTag as W, type InferErrorFromTag as X, type QueryFunction as Y, type StaleTime as Z, type StaleTimeFunction as _, defaultShouldDehydrateQuery as a, type MutationObserverBaseResult as a$, type QueryPersister as a0, type QueryFunctionContext as a1, type InitialDataFunction as a2, type PlaceholderDataFunction as a3, type QueriesPlaceholderDataFunction as a4, type QueryKeyHashFunction as a5, type GetPreviousPageParamFunction as a6, type GetNextPageParamFunction as a7, type InfiniteData as a8, type QueryMeta as a9, type QueryObserverPendingResult as aA, type QueryObserverLoadingResult as aB, type QueryObserverLoadingErrorResult as aC, type QueryObserverRefetchErrorResult as aD, type QueryObserverSuccessResult as aE, type QueryObserverPlaceholderResult as aF, type DefinedQueryObserverResult as aG, type QueryObserverResult as aH, type InfiniteQueryObserverBaseResult as aI, type InfiniteQueryObserverPendingResult as aJ, type InfiniteQueryObserverLoadingResult as aK, type InfiniteQueryObserverLoadingErrorResult as aL, type InfiniteQueryObserverRefetchErrorResult as aM, type InfiniteQueryObserverSuccessResult as aN, type InfiniteQueryObserverPlaceholderResult as aO, type DefinedInfiniteQueryObserverResult as aP, type InfiniteQueryObserverResult as aQ, type MutationKey as aR, type MutationStatus as aS, type MutationScope as aT, type MutationMeta as aU, type MutationFunctionContext as aV, type MutationFunction as aW, type MutationOptions as aX, type MutationObserverOptions as aY, type MutateOptions as aZ, type MutateFunction as a_, type NetworkMode as aa, type NotifyOnChangeProps as ab, type QueryOptions as ac, type InitialPageParam as ad, type InfiniteQueryPageParamsOptions as ae, type ThrowOnError as af, type QueryObserverOptions as ag, type WithRequired as ah, type DefaultedQueryObserverOptions as ai, type InfiniteQueryObserverOptions as aj, type DefaultedInfiniteQueryObserverOptions as ak, type FetchQueryOptions as al, type EnsureQueryDataOptions as am, type EnsureInfiniteQueryDataOptions as an, type FetchInfiniteQueryOptions as ao, type ResultOptions as ap, type RefetchOptions as aq, type InvalidateQueryFilters as ar, type RefetchQueryFilters as as, type InvalidateOptions as at, type ResetOptions as au, type FetchNextPageOptions as av, type FetchPreviousPageOptions as aw, type QueryStatus as ax, type FetchStatus as ay, type QueryObserverBaseResult as az, dehydrate as b, type MutationObserverIdleResult as b0, type MutationObserverLoadingResult as b1, type MutationObserverErrorResult as b2, type MutationObserverSuccessResult as b3, type MutationObserverResult as b4, type QueryClientConfig as b5, type DefaultOptions as b6, type CancelOptions as b7, type SetDataOptions as b8, type NotifyEventType as b9, type QueryStore as bA, type Retryer as bB, type RetryValue as bC, type RetryDelayValue as bD, canFetch as bE, createRetryer as bF, type NotifyEvent as ba, type QueryBehavior as bb, type FetchContext as bc, type FetchDirection as bd, type FetchMeta as be, type FetchOptions as bf, type Action$1 as bg, type SetStateOptions as bh, fetchState as bi, type Action as bj, getDefaultState as bk, type QueryTypeFilter as bl, functionalUpdate as bm, isValidTimeout as bn, timeUntilStale as bo, resolveStaleTime as bp, resolveEnabled as bq, hashQueryKeyByOptions as br, shallowEqualObjects as bs, isPlainArray as bt, isPlainObject as bu, sleep as bv, replaceData as bw, addToEnd as bx, addToStart as by, ensureQueryFn as bz, type MutationCacheNotifyEvent as c, defaultShouldDehydrateMutation as d, MutationObserver as e, type QueryCacheNotifyEvent as f, QueryClient as g, hydrate as h, QueryObserver as i, isCancelledError as j, hashKey as k, isServer as l, keepPreviousData as m, matchMutation as n, matchQuery as o, noop as p, partialMatchKey as q, replaceEqualDeep as r, shouldThrowError as s, skipToken as t, type MutationFilters as u, type QueryFilters as v, type DehydrateOptions as w, Mutation as x, type MutationState as y, Query as z };
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { w as DehydrateOptions, D as DehydratedState, H as HydrateOptions, d as defaultShouldDehydrateMutation, a as defaultShouldDehydrateQuery, b as dehydrate, h as hydrate } from './hydration-
|
|
1
|
+
export { w as DehydrateOptions, D as DehydratedState, H as HydrateOptions, d as defaultShouldDehydrateMutation, a as defaultShouldDehydrateQuery, b as dehydrate, h as hydrate } from './hydration-DofhGwZq.cjs';
|
|
2
2
|
import './removable.cjs';
|
|
3
3
|
import './subscribable.cjs';
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { w as DehydrateOptions, D as DehydratedState, H as HydrateOptions, d as defaultShouldDehydrateMutation, a as defaultShouldDehydrateQuery, b as dehydrate, h as hydrate } from './hydration-
|
|
1
|
+
export { w as DehydrateOptions, D as DehydratedState, H as HydrateOptions, d as defaultShouldDehydrateMutation, a as defaultShouldDehydrateQuery, b as dehydrate, h as hydrate } from './hydration-iULCH7y8.js';
|
|
2
2
|
import './removable.js';
|
|
3
3
|
import './subscribable.js';
|
package/build/legacy/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export { focusManager } from './focusManager.cjs';
|
|
2
|
-
export { T as AnyDataTag,
|
|
2
|
+
export { T as AnyDataTag, b7 as CancelOptions, C as CancelledError, V as DataTag, G as DefaultError, b6 as DefaultOptions, ak as DefaultedInfiniteQueryObserverOptions, ai as DefaultedQueryObserverOptions, aP as DefinedInfiniteQueryObserverResult, aG as DefinedQueryObserverResult, w as DehydrateOptions, D as DehydratedState, B as DistributiveOmit, $ as Enabled, an as EnsureInfiniteQueryDataOptions, am as EnsureQueryDataOptions, ao as FetchInfiniteQueryOptions, av as FetchNextPageOptions, aw as FetchPreviousPageOptions, al as FetchQueryOptions, ay as FetchStatus, a7 as GetNextPageParamFunction, a6 as GetPreviousPageParamFunction, H as HydrateOptions, W as InferDataFromTag, X as InferErrorFromTag, a8 as InfiniteData, aI as InfiniteQueryObserverBaseResult, aL as InfiniteQueryObserverLoadingErrorResult, aK as InfiniteQueryObserverLoadingResult, aj as InfiniteQueryObserverOptions, aJ as InfiniteQueryObserverPendingResult, aO as InfiniteQueryObserverPlaceholderResult, aM as InfiniteQueryObserverRefetchErrorResult, aQ as InfiniteQueryObserverResult, aN as InfiniteQueryObserverSuccessResult, ae as InfiniteQueryPageParamsOptions, a2 as InitialDataFunction, ad as InitialPageParam, at as InvalidateOptions, ar as InvalidateQueryFilters, a_ as MutateFunction, aZ as MutateOptions, x as Mutation, M as MutationCache, c as MutationCacheNotifyEvent, u as MutationFilters, aW as MutationFunction, aV as MutationFunctionContext, aR as MutationKey, aU as MutationMeta, e as MutationObserver, a$ as MutationObserverBaseResult, b2 as MutationObserverErrorResult, b0 as MutationObserverIdleResult, b1 as MutationObserverLoadingResult, aY as MutationObserverOptions, b4 as MutationObserverResult, b3 as MutationObserverSuccessResult, aX as MutationOptions, aT as MutationScope, y as MutationState, aS as MutationStatus, aa as NetworkMode, F as NoInfer, N as NonUndefinedGuard, ba as NotifyEvent, b9 as NotifyEventType, ab as NotifyOnChangeProps, O as OmitKeyof, E as Override, a3 as PlaceholderDataFunction, a4 as QueriesPlaceholderDataFunction, z as Query, Q as QueryCache, f as QueryCacheNotifyEvent, g as QueryClient, b5 as QueryClientConfig, v as QueryFilters, Y as QueryFunction, a1 as QueryFunctionContext, I as QueryKey, a5 as QueryKeyHashFunction, a9 as QueryMeta, i as QueryObserver, az as QueryObserverBaseResult, aC as QueryObserverLoadingErrorResult, aB as QueryObserverLoadingResult, ag as QueryObserverOptions, aA as QueryObserverPendingResult, aF as QueryObserverPlaceholderResult, aD as QueryObserverRefetchErrorResult, aH as QueryObserverResult, aE as QueryObserverSuccessResult, ac as QueryOptions, a0 as QueryPersister, A as QueryState, ax as QueryStatus, aq as RefetchOptions, as as RefetchQueryFilters, R as Register, au as ResetOptions, ap as ResultOptions, b8 as SetDataOptions, S as SkipToken, Z as StaleTime, _ as StaleTimeFunction, af as ThrowOnError, P as UnsetMarker, U as Updater, ah as WithRequired, K as dataTagErrorSymbol, J as dataTagSymbol, d as defaultShouldDehydrateMutation, a as defaultShouldDehydrateQuery, b as dehydrate, k as hashKey, h as hydrate, j as isCancelledError, l as isServer, m as keepPreviousData, n as matchMutation, o as matchQuery, p as noop, q as partialMatchKey, r as replaceEqualDeep, s as shouldThrowError, t as skipToken, L as unsetMarker } from './hydration-DofhGwZq.cjs';
|
|
3
3
|
export { InfiniteQueryObserver } from './infiniteQueryObserver.cjs';
|
|
4
4
|
export { defaultScheduler, notifyManager } from './notifyManager.cjs';
|
|
5
5
|
export { onlineManager } from './onlineManager.cjs';
|