eden2query 0.1.1 → 0.1.2

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/dist/index.d.ts CHANGED
@@ -1,1271 +1,16 @@
1
- import * as _tanstack_react_query0 from "@tanstack/react-query";
2
- import { mutationOptions, queryOptions } from "@tanstack/react-query";
3
1
  import { Treaty } from "@elysiajs/eden";
4
-
5
- //#region node_modules/@tanstack/query-core/build/modern/subscribable.d.ts
6
- declare class Subscribable<TListener extends Function> {
7
- protected listeners: Set<TListener>;
8
- constructor();
9
- subscribe(listener: TListener): () => void;
10
- hasListeners(): boolean;
11
- protected onSubscribe(): void;
12
- protected onUnsubscribe(): void;
13
- }
14
- //#endregion
15
- //#region node_modules/@tanstack/query-core/build/modern/removable.d.ts
16
- declare abstract class Removable {
17
- #private;
18
- gcTime: number;
19
- destroy(): void;
20
- protected scheduleGc(): void;
21
- protected updateGcTime(newGcTime: number | undefined): void;
22
- protected clearGcTimeout(): void;
23
- protected abstract optionalRemove(): void;
24
- }
25
- //#endregion
26
- //#region node_modules/@tanstack/query-core/build/modern/hydration-BlEVG2Lp.d.ts
27
- type QueryObserverListener<TData, TError> = (result: QueryObserverResult<TData, TError>) => void;
28
- interface ObserverFetchOptions extends FetchOptions {
29
- throwOnError?: boolean;
30
- }
31
- declare class QueryObserver<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends Subscribable<QueryObserverListener<TData, TError>> {
32
- #private;
33
- options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
34
- constructor(client: QueryClient, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>);
35
- protected bindMethods(): void;
36
- protected onSubscribe(): void;
37
- protected onUnsubscribe(): void;
38
- shouldFetchOnReconnect(): boolean;
39
- shouldFetchOnWindowFocus(): boolean;
40
- destroy(): void;
41
- setOptions(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): void;
42
- getOptimisticResult(options: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
43
- getCurrentResult(): QueryObserverResult<TData, TError>;
44
- trackResult(result: QueryObserverResult<TData, TError>, onPropTracked?: (key: keyof QueryObserverResult) => void): QueryObserverResult<TData, TError>;
45
- trackProp(key: keyof QueryObserverResult): void;
46
- getCurrentQuery(): Query<TQueryFnData, TError, TQueryData, TQueryKey>;
47
- refetch({
48
- ...options
49
- }?: RefetchOptions): Promise<QueryObserverResult<TData, TError>>;
50
- fetchOptimistic(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): Promise<QueryObserverResult<TData, TError>>;
51
- protected fetch(fetchOptions: ObserverFetchOptions): Promise<QueryObserverResult<TData, TError>>;
52
- protected createResult(query: Query<TQueryFnData, TError, TQueryData, TQueryKey>, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
53
- updateResult(): void;
54
- onQueryUpdate(): void;
55
- }
56
- interface QueryConfig<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
57
- client: QueryClient;
58
- queryKey: TQueryKey;
59
- queryHash: string;
60
- options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
61
- defaultOptions?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
62
- state?: QueryState<TData, TError>;
63
- }
64
- interface QueryState<TData = unknown, TError = DefaultError> {
65
- data: TData | undefined;
66
- dataUpdateCount: number;
67
- dataUpdatedAt: number;
68
- error: TError | null;
69
- errorUpdateCount: number;
70
- errorUpdatedAt: number;
71
- fetchFailureCount: number;
72
- fetchFailureReason: TError | null;
73
- fetchMeta: FetchMeta | null;
74
- isInvalidated: boolean;
75
- status: QueryStatus;
76
- fetchStatus: FetchStatus;
77
- }
78
- interface FetchContext<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
79
- fetchFn: () => unknown | Promise<unknown>;
80
- fetchOptions?: FetchOptions;
81
- signal: AbortSignal;
82
- options: QueryOptions<TQueryFnData, TError, TData, any>;
83
- client: QueryClient;
84
- queryKey: TQueryKey;
85
- state: QueryState<TData, TError>;
86
- }
87
- interface QueryBehavior<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> {
88
- onFetch: (context: FetchContext<TQueryFnData, TError, TData, TQueryKey>, query: Query) => void;
89
- }
90
- type FetchDirection = 'forward' | 'backward';
91
- interface FetchMeta {
92
- fetchMore?: {
93
- direction: FetchDirection;
94
- };
95
- }
96
- interface FetchOptions<TData = unknown> {
97
- cancelRefetch?: boolean;
98
- meta?: FetchMeta;
99
- initialPromise?: Promise<TData>;
100
- }
101
- interface FailedAction$1<TError> {
102
- type: 'failed';
103
- failureCount: number;
104
- error: TError;
105
- }
106
- interface FetchAction {
107
- type: 'fetch';
108
- meta?: FetchMeta;
109
- }
110
- interface SuccessAction$1<TData> {
111
- data: TData | undefined;
112
- type: 'success';
113
- dataUpdatedAt?: number;
114
- manual?: boolean;
115
- }
116
- interface ErrorAction$1<TError> {
117
- type: 'error';
118
- error: TError;
119
- }
120
- interface InvalidateAction {
121
- type: 'invalidate';
122
- }
123
- interface PauseAction$1 {
124
- type: 'pause';
125
- }
126
- interface ContinueAction$1 {
127
- type: 'continue';
128
- }
129
- interface SetStateAction<TData, TError> {
130
- type: 'setState';
131
- state: Partial<QueryState<TData, TError>>;
132
- setStateOptions?: SetStateOptions;
133
- }
134
- type Action$1<TData, TError> = ContinueAction$1 | ErrorAction$1<TError> | FailedAction$1<TError> | FetchAction | InvalidateAction | PauseAction$1 | SetStateAction<TData, TError> | SuccessAction$1<TData>;
135
- interface SetStateOptions {
136
- meta?: any;
137
- }
138
- declare class Query<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends Removable {
139
- #private;
140
- queryKey: TQueryKey;
141
- queryHash: string;
142
- options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
143
- state: QueryState<TData, TError>;
144
- observers: Array<QueryObserver<any, any, any, any, any>>;
145
- constructor(config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>);
146
- get meta(): QueryMeta | undefined;
147
- get promise(): Promise<TData> | undefined;
148
- setOptions(options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>): void;
149
- protected optionalRemove(): void;
150
- setData(newData: TData, options?: SetDataOptions & {
151
- manual: boolean;
152
- }): TData;
153
- setState(state: Partial<QueryState<TData, TError>>, setStateOptions?: SetStateOptions): void;
154
- cancel(options?: CancelOptions): Promise<void>;
155
- destroy(): void;
156
- reset(): void;
157
- isActive(): boolean;
158
- isDisabled(): boolean;
159
- isStatic(): boolean;
160
- isStale(): boolean;
161
- isStaleByTime(staleTime?: StaleTime): boolean;
162
- onFocus(): void;
163
- onOnline(): void;
164
- addObserver(observer: QueryObserver<any, any, any, any, any>): void;
165
- removeObserver(observer: QueryObserver<any, any, any, any, any>): void;
166
- getObserversCount(): number;
167
- invalidate(): void;
168
- fetch(options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>, fetchOptions?: FetchOptions<TQueryFnData>): Promise<TData>;
169
- }
170
- type MutationObserverListener<TData, TError, TVariables, TOnMutateResult> = (result: MutationObserverResult<TData, TError, TVariables, TOnMutateResult>) => void;
171
- declare class MutationObserver<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends Subscribable<MutationObserverListener<TData, TError, TVariables, TOnMutateResult>> {
172
- #private;
173
- options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>;
174
- constructor(client: QueryClient, options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>);
175
- protected bindMethods(): void;
176
- setOptions(options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>): void;
177
- protected onUnsubscribe(): void;
178
- onMutationUpdate(action: Action<TData, TError, TVariables, TOnMutateResult>): void;
179
- getCurrentResult(): MutationObserverResult<TData, TError, TVariables, TOnMutateResult>;
180
- reset(): void;
181
- mutate(variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TOnMutateResult>): Promise<TData>;
182
- }
183
- interface MutationCacheConfig {
184
- onError?: (error: DefaultError, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
185
- onSuccess?: (data: unknown, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
186
- onMutate?: (variables: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
187
- onSettled?: (data: unknown | undefined, error: DefaultError | null, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
188
- }
189
- interface NotifyEventMutationAdded extends NotifyEvent {
190
- type: 'added';
191
- mutation: Mutation<any, any, any, any>;
192
- }
193
- interface NotifyEventMutationRemoved extends NotifyEvent {
194
- type: 'removed';
195
- mutation: Mutation<any, any, any, any>;
196
- }
197
- interface NotifyEventMutationObserverAdded extends NotifyEvent {
198
- type: 'observerAdded';
199
- mutation: Mutation<any, any, any, any>;
200
- observer: MutationObserver<any, any, any>;
201
- }
202
- interface NotifyEventMutationObserverRemoved extends NotifyEvent {
203
- type: 'observerRemoved';
204
- mutation: Mutation<any, any, any, any>;
205
- observer: MutationObserver<any, any, any>;
206
- }
207
- interface NotifyEventMutationObserverOptionsUpdated extends NotifyEvent {
208
- type: 'observerOptionsUpdated';
209
- mutation?: Mutation<any, any, any, any>;
210
- observer: MutationObserver<any, any, any, any>;
211
- }
212
- interface NotifyEventMutationUpdated extends NotifyEvent {
213
- type: 'updated';
214
- mutation: Mutation<any, any, any, any>;
215
- action: Action<any, any, any, any>;
216
- }
217
- type MutationCacheNotifyEvent = NotifyEventMutationAdded | NotifyEventMutationRemoved | NotifyEventMutationObserverAdded | NotifyEventMutationObserverRemoved | NotifyEventMutationObserverOptionsUpdated | NotifyEventMutationUpdated;
218
- type MutationCacheListener = (event: MutationCacheNotifyEvent) => void;
219
- declare class MutationCache extends Subscribable<MutationCacheListener> {
220
- #private;
221
- config: MutationCacheConfig;
222
- constructor(config?: MutationCacheConfig);
223
- build<TData, TError, TVariables, TOnMutateResult>(client: QueryClient, options: MutationOptions<TData, TError, TVariables, TOnMutateResult>, state?: MutationState<TData, TError, TVariables, TOnMutateResult>): Mutation<TData, TError, TVariables, TOnMutateResult>;
224
- add(mutation: Mutation<any, any, any, any>): void;
225
- remove(mutation: Mutation<any, any, any, any>): void;
226
- canRun(mutation: Mutation<any, any, any, any>): boolean;
227
- runNext(mutation: Mutation<any, any, any, any>): Promise<unknown>;
228
- clear(): void;
229
- getAll(): Array<Mutation>;
230
- find<TData = unknown, TError = DefaultError, TVariables = any, TOnMutateResult = unknown>(filters: MutationFilters): Mutation<TData, TError, TVariables, TOnMutateResult> | undefined;
231
- findAll(filters?: MutationFilters): Array<Mutation>;
232
- notify(event: MutationCacheNotifyEvent): void;
233
- resumePausedMutations(): Promise<unknown>;
234
- }
235
- interface MutationConfig<TData, TError, TVariables, TOnMutateResult> {
236
- client: QueryClient;
237
- mutationId: number;
238
- mutationCache: MutationCache;
239
- options: MutationOptions<TData, TError, TVariables, TOnMutateResult>;
240
- state?: MutationState<TData, TError, TVariables, TOnMutateResult>;
241
- }
242
- interface MutationState<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> {
243
- context: TOnMutateResult | undefined;
244
- data: TData | undefined;
245
- error: TError | null;
246
- failureCount: number;
247
- failureReason: TError | null;
248
- isPaused: boolean;
249
- status: MutationStatus;
250
- variables: TVariables | undefined;
251
- submittedAt: number;
252
- }
253
- interface FailedAction<TError> {
254
- type: 'failed';
255
- failureCount: number;
256
- error: TError | null;
257
- }
258
- interface PendingAction<TVariables, TOnMutateResult> {
259
- type: 'pending';
260
- isPaused: boolean;
261
- variables?: TVariables;
262
- context?: TOnMutateResult;
263
- }
264
- interface SuccessAction<TData> {
265
- type: 'success';
266
- data: TData;
267
- }
268
- interface ErrorAction<TError> {
269
- type: 'error';
270
- error: TError;
271
- }
272
- interface PauseAction {
273
- type: 'pause';
274
- }
275
- interface ContinueAction {
276
- type: 'continue';
277
- }
278
- type Action<TData, TError, TVariables, TOnMutateResult> = ContinueAction | ErrorAction<TError> | FailedAction<TError> | PendingAction<TVariables, TOnMutateResult> | PauseAction | SuccessAction<TData>;
279
- declare class Mutation<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> extends Removable {
280
- #private;
281
- state: MutationState<TData, TError, TVariables, TOnMutateResult>;
282
- options: MutationOptions<TData, TError, TVariables, TOnMutateResult>;
283
- readonly mutationId: number;
284
- constructor(config: MutationConfig<TData, TError, TVariables, TOnMutateResult>);
285
- setOptions(options: MutationOptions<TData, TError, TVariables, TOnMutateResult>): void;
286
- get meta(): MutationMeta | undefined;
287
- addObserver(observer: MutationObserver<any, any, any, any>): void;
288
- removeObserver(observer: MutationObserver<any, any, any, any>): void;
289
- protected optionalRemove(): void;
290
- continue(): Promise<unknown>;
291
- execute(variables: TVariables): Promise<TData>;
292
- }
293
- type DropLast<T extends ReadonlyArray<unknown>> = T extends readonly [...infer R, unknown] ? readonly [...R] : never;
294
- type TuplePrefixes<T extends ReadonlyArray<unknown>> = T extends readonly [] ? readonly [] : TuplePrefixes<DropLast<T>> | T;
295
- interface QueryFilters<TQueryKey extends QueryKey = QueryKey> {
296
- /**
297
- * Filter to active queries, inactive queries or all queries
298
- */
299
- type?: QueryTypeFilter;
300
- /**
301
- * Match query key exactly
302
- */
303
- exact?: boolean;
304
- /**
305
- * Include queries matching this predicate function
306
- */
307
- predicate?: (query: Query) => boolean;
308
- /**
309
- * Include queries matching this query key
310
- */
311
- queryKey?: TQueryKey | TuplePrefixes<TQueryKey>;
312
- /**
313
- * Include or exclude stale queries
314
- */
315
- stale?: boolean;
316
- /**
317
- * Include queries matching their fetchStatus
318
- */
319
- fetchStatus?: FetchStatus;
320
- }
321
- interface MutationFilters<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> {
322
- /**
323
- * Match mutation key exactly
324
- */
325
- exact?: boolean;
326
- /**
327
- * Include mutations matching this predicate function
328
- */
329
- predicate?: (mutation: Mutation<TData, TError, TVariables, TOnMutateResult>) => boolean;
330
- /**
331
- * Include mutations matching this mutation key
332
- */
333
- mutationKey?: TuplePrefixes<MutationKey>;
334
- /**
335
- * Filter by mutation status
336
- */
337
- status?: MutationStatus;
338
- }
339
- type Updater<TInput, TOutput> = TOutput | ((input: TInput) => TOutput);
340
- type QueryTypeFilter = 'all' | 'active' | 'inactive';
341
- declare const skipToken: unique symbol;
342
- type SkipToken = typeof skipToken;
343
- interface QueryCacheConfig {
344
- onError?: (error: DefaultError, query: Query<unknown, unknown, unknown>) => void;
345
- onSuccess?: (data: unknown, query: Query<unknown, unknown, unknown>) => void;
346
- onSettled?: (data: unknown | undefined, error: DefaultError | null, query: Query<unknown, unknown, unknown>) => void;
347
- }
348
- interface NotifyEventQueryAdded extends NotifyEvent {
349
- type: 'added';
350
- query: Query<any, any, any, any>;
351
- }
352
- interface NotifyEventQueryRemoved extends NotifyEvent {
353
- type: 'removed';
354
- query: Query<any, any, any, any>;
355
- }
356
- interface NotifyEventQueryUpdated extends NotifyEvent {
357
- type: 'updated';
358
- query: Query<any, any, any, any>;
359
- action: Action$1<any, any>;
360
- }
361
- interface NotifyEventQueryObserverAdded extends NotifyEvent {
362
- type: 'observerAdded';
363
- query: Query<any, any, any, any>;
364
- observer: QueryObserver<any, any, any, any, any>;
365
- }
366
- interface NotifyEventQueryObserverRemoved extends NotifyEvent {
367
- type: 'observerRemoved';
368
- query: Query<any, any, any, any>;
369
- observer: QueryObserver<any, any, any, any, any>;
370
- }
371
- interface NotifyEventQueryObserverResultsUpdated extends NotifyEvent {
372
- type: 'observerResultsUpdated';
373
- query: Query<any, any, any, any>;
374
- }
375
- interface NotifyEventQueryObserverOptionsUpdated extends NotifyEvent {
376
- type: 'observerOptionsUpdated';
377
- query: Query<any, any, any, any>;
378
- observer: QueryObserver<any, any, any, any, any>;
379
- }
380
- type QueryCacheNotifyEvent = NotifyEventQueryAdded | NotifyEventQueryRemoved | NotifyEventQueryUpdated | NotifyEventQueryObserverAdded | NotifyEventQueryObserverRemoved | NotifyEventQueryObserverResultsUpdated | NotifyEventQueryObserverOptionsUpdated;
381
- type QueryCacheListener = (event: QueryCacheNotifyEvent) => void;
382
- declare class QueryCache extends Subscribable<QueryCacheListener> {
383
- #private;
384
- config: QueryCacheConfig;
385
- constructor(config?: QueryCacheConfig);
386
- build<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(client: QueryClient, options: WithRequired<QueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey'>, state?: QueryState<TData, TError>): Query<TQueryFnData, TError, TData, TQueryKey>;
387
- add(query: Query<any, any, any, any>): void;
388
- remove(query: Query<any, any, any, any>): void;
389
- clear(): void;
390
- get<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryHash: string): Query<TQueryFnData, TError, TData, TQueryKey> | undefined;
391
- getAll(): Array<Query>;
392
- find<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData>(filters: WithRequired<QueryFilters, 'queryKey'>): Query<TQueryFnData, TError, TData> | undefined;
393
- findAll(filters?: QueryFilters<any>): Array<Query>;
394
- notify(event: QueryCacheNotifyEvent): void;
395
- onFocus(): void;
396
- onOnline(): void;
397
- }
398
- declare class QueryClient {
399
- #private;
400
- constructor(config?: QueryClientConfig);
401
- mount(): void;
402
- unmount(): void;
403
- isFetching<TQueryFilters extends QueryFilters<any> = QueryFilters>(filters?: TQueryFilters): number;
404
- isMutating<TMutationFilters extends MutationFilters<any, any> = MutationFilters>(filters?: TMutationFilters): number;
405
- /**
406
- * Imperative (non-reactive) way to retrieve data for a QueryKey.
407
- * Should only be used in callbacks or functions where reading the latest data is necessary, e.g. for optimistic updates.
408
- *
409
- * Hint: Do not use this function inside a component, because it won't receive updates.
410
- * Use `useQuery` to create a `QueryObserver` that subscribes to changes.
411
- */
412
- getQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>>(queryKey: TTaggedQueryKey): TInferredQueryFnData | undefined;
413
- ensureQueryData<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>;
414
- getQueriesData<TQueryFnData = unknown, TQueryFilters extends QueryFilters<any> = QueryFilters>(filters: TQueryFilters): Array<[QueryKey, TQueryFnData | undefined]>;
415
- setQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>>(queryKey: TTaggedQueryKey, updater: Updater<NoInfer<TInferredQueryFnData> | undefined, NoInfer<TInferredQueryFnData> | undefined>, options?: SetDataOptions): NoInfer<TInferredQueryFnData> | undefined;
416
- setQueriesData<TQueryFnData, TQueryFilters extends QueryFilters<any> = QueryFilters>(filters: TQueryFilters, updater: Updater<NoInfer<TQueryFnData> | undefined, NoInfer<TQueryFnData> | undefined>, options?: SetDataOptions): Array<[QueryKey, TQueryFnData | undefined]>;
417
- getQueryState<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(queryKey: TTaggedQueryKey): QueryState<TInferredQueryFnData, TInferredError> | undefined;
418
- removeQueries<TTaggedQueryKey extends QueryKey = QueryKey>(filters?: QueryFilters<TTaggedQueryKey>): void;
419
- resetQueries<TTaggedQueryKey extends QueryKey = QueryKey>(filters?: QueryFilters<TTaggedQueryKey>, options?: ResetOptions): Promise<void>;
420
- cancelQueries<TTaggedQueryKey extends QueryKey = QueryKey>(filters?: QueryFilters<TTaggedQueryKey>, cancelOptions?: CancelOptions): Promise<void>;
421
- invalidateQueries<TTaggedQueryKey extends QueryKey = QueryKey>(filters?: InvalidateQueryFilters<TTaggedQueryKey>, options?: InvalidateOptions): Promise<void>;
422
- refetchQueries<TTaggedQueryKey extends QueryKey = QueryKey>(filters?: RefetchQueryFilters<TTaggedQueryKey>, options?: RefetchOptions): Promise<void>;
423
- fetchQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<TData>;
424
- prefetchQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
425
- fetchInfiniteQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<InfiniteData<TData, TPageParam>>;
426
- prefetchInfiniteQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<void>;
427
- ensureInfiniteQueryData<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: EnsureInfiniteQueryDataOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<InfiniteData<TData, TPageParam>>;
428
- resumePausedMutations(): Promise<unknown>;
429
- getQueryCache(): QueryCache;
430
- getMutationCache(): MutationCache;
431
- getDefaultOptions(): DefaultOptions;
432
- setDefaultOptions(options: DefaultOptions): void;
433
- setQueryDefaults<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData>(queryKey: QueryKey, options: Partial<OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData>, 'queryKey'>>): void;
434
- getQueryDefaults(queryKey: QueryKey): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'>;
435
- setMutationDefaults<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown>(mutationKey: MutationKey, options: OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>, 'mutationKey'>): void;
436
- getMutationDefaults(mutationKey: MutationKey): OmitKeyof<MutationObserverOptions<any, any, any, any>, 'mutationKey'>;
437
- 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>;
438
- defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(options?: T): T;
439
- clear(): void;
440
- }
441
- type RetryValue<TError> = boolean | number | ShouldRetryFunction<TError>;
442
- type ShouldRetryFunction<TError = DefaultError> = (failureCount: number, error: TError) => boolean;
443
- type RetryDelayValue<TError> = number | RetryDelayFunction<TError>;
444
- type RetryDelayFunction<TError = DefaultError> = (failureCount: number, error: TError) => number;
445
- type OmitKeyof<TObject, TKey extends (TStrictly extends 'safely' ? keyof TObject | (string & Record<never, never>) | (number & Record<never, never>) | (symbol & Record<never, never>) : keyof TObject), TStrictly extends 'strictly' | 'safely' = 'strictly'> = Omit<TObject, TKey>;
446
- type NoInfer<T> = [T][T extends any ? 0 : never];
447
- interface Register {}
448
- type DefaultError = Register extends {
449
- defaultError: infer TError;
450
- } ? TError : Error;
451
- type QueryKey = Register extends {
452
- queryKey: infer TQueryKey;
453
- } ? TQueryKey extends ReadonlyArray<unknown> ? TQueryKey : TQueryKey extends Array<unknown> ? TQueryKey : ReadonlyArray<unknown> : ReadonlyArray<unknown>;
454
- declare const dataTagSymbol$1: unique symbol;
455
- type dataTagSymbol$1 = typeof dataTagSymbol$1;
456
- declare const dataTagErrorSymbol$1: unique symbol;
457
- type dataTagErrorSymbol$1 = typeof dataTagErrorSymbol$1;
458
- declare const unsetMarker: unique symbol;
459
- type UnsetMarker = typeof unsetMarker;
460
- type AnyDataTag = {
461
- [dataTagSymbol$1]: any;
462
- [dataTagErrorSymbol$1]: any;
463
- };
464
- type DataTag<TType, TValue, TError = UnsetMarker> = TType extends AnyDataTag ? TType : TType & {
465
- [dataTagSymbol$1]: TValue;
466
- [dataTagErrorSymbol$1]: TError;
467
- };
468
- type InferDataFromTag<TQueryFnData, TTaggedQueryKey extends QueryKey> = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue, unknown> ? TaggedValue : TQueryFnData;
469
- type InferErrorFromTag<TError, TTaggedQueryKey extends QueryKey> = TTaggedQueryKey extends DataTag<unknown, unknown, infer TaggedError> ? TaggedError extends UnsetMarker ? TError : TaggedError : TError;
470
- type QueryFunction<T = unknown, TQueryKey extends QueryKey = QueryKey, TPageParam = never> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>;
471
- type StaleTime = number | 'static';
472
- type StaleTimeFunction<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = StaleTime | ((query: Query<TQueryFnData, TError, TData, TQueryKey>) => StaleTime);
473
- type Enabled<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = boolean | ((query: Query<TQueryFnData, TError, TData, TQueryKey>) => boolean);
474
- type QueryPersister<T = unknown, TQueryKey extends QueryKey = QueryKey, TPageParam = never> = [TPageParam] extends [never] ? (queryFn: QueryFunction<T, TQueryKey, never>, context: QueryFunctionContext<TQueryKey>, query: Query) => T | Promise<T> : (queryFn: QueryFunction<T, TQueryKey, TPageParam>, context: QueryFunctionContext<TQueryKey>, query: Query) => T | Promise<T>;
475
- type QueryFunctionContext<TQueryKey extends QueryKey = QueryKey, TPageParam = never> = [TPageParam] extends [never] ? {
476
- client: QueryClient;
477
- queryKey: TQueryKey;
478
- signal: AbortSignal;
479
- meta: QueryMeta | undefined;
480
- pageParam?: unknown;
481
- /**
482
- * @deprecated
483
- * if you want access to the direction, you can add it to the pageParam
484
- */
485
- direction?: unknown;
486
- } : {
487
- client: QueryClient;
488
- queryKey: TQueryKey;
489
- signal: AbortSignal;
490
- pageParam: TPageParam;
491
- /**
492
- * @deprecated
493
- * if you want access to the direction, you can add it to the pageParam
494
- */
495
- direction: FetchDirection;
496
- meta: QueryMeta | undefined;
497
- };
498
- type InitialDataFunction<T> = () => T | undefined;
499
- type NonFunctionGuard<T> = T extends Function ? never : T;
500
- type PlaceholderDataFunction<TQueryFnData = unknown, TError = DefaultError, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = (previousData: TQueryData | undefined, previousQuery: Query<TQueryFnData, TError, TQueryData, TQueryKey> | undefined) => TQueryData | undefined;
501
- type QueryKeyHashFunction<TQueryKey extends QueryKey> = (queryKey: TQueryKey) => string;
502
- type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (lastPage: TQueryFnData, allPages: Array<TQueryFnData>, lastPageParam: TPageParam, allPageParams: Array<TPageParam>) => TPageParam | undefined | null;
503
- interface InfiniteData<TData, TPageParam = unknown> {
504
- pages: Array<TData>;
505
- pageParams: Array<TPageParam>;
506
- }
507
- type QueryMeta = Register extends {
508
- queryMeta: infer TQueryMeta;
509
- } ? TQueryMeta extends Record<string, unknown> ? TQueryMeta : Record<string, unknown> : Record<string, unknown>;
510
- type NetworkMode = 'online' | 'always' | 'offlineFirst';
511
- type NotifyOnChangeProps = Array<keyof InfiniteQueryObserverResult> | 'all' | undefined | (() => Array<keyof InfiniteQueryObserverResult> | 'all' | undefined);
512
- interface QueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> {
513
- /**
514
- * If `false`, failed queries will not retry by default.
515
- * If `true`, failed queries will retry infinitely., failureCount: num
516
- * If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number.
517
- * If set to a function `(failureCount, error) => boolean` failed queries will retry until the function returns false.
518
- */
519
- retry?: RetryValue<TError>;
520
- retryDelay?: RetryDelayValue<TError>;
521
- networkMode?: NetworkMode;
522
- /**
523
- * The time in milliseconds that unused/inactive cache data remains in memory.
524
- * When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration.
525
- * When different garbage collection times are specified, the longest one will be used.
526
- * Setting it to `Infinity` will disable garbage collection.
527
- */
528
- gcTime?: number;
529
- queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam> | SkipToken;
530
- persister?: QueryPersister<NoInfer<TQueryFnData>, NoInfer<TQueryKey>, NoInfer<TPageParam>>;
531
- queryHash?: string;
532
- queryKey?: TQueryKey;
533
- queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>;
534
- initialData?: TData | InitialDataFunction<TData>;
535
- initialDataUpdatedAt?: number | (() => number | undefined);
536
- behavior?: QueryBehavior<TQueryFnData, TError, TData, TQueryKey>;
537
- /**
538
- * Set this to `false` to disable structural sharing between query results.
539
- * Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom structural sharing logic.
540
- * Defaults to `true`.
541
- */
542
- structuralSharing?: boolean | ((oldData: unknown | undefined, newData: unknown) => unknown);
543
- _defaulted?: boolean;
544
- /**
545
- * Additional payload to be stored on each query.
546
- * Use this property to pass information that can be used in other places.
547
- */
548
- meta?: QueryMeta;
549
- /**
550
- * Maximum number of pages to store in the data of an infinite query.
551
- */
552
- maxPages?: number;
553
- }
554
- interface InitialPageParam<TPageParam = unknown> {
555
- initialPageParam: TPageParam;
556
- }
557
- type ThrowOnError<TQueryFnData, TError, TQueryData, TQueryKey extends QueryKey> = boolean | ((error: TError, query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean);
558
- interface QueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends WithRequired<QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey, TPageParam>, 'queryKey'> {
559
- /**
560
- * Set this to `false` or a function that returns `false` to disable automatic refetching when the query mounts or changes query keys.
561
- * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
562
- * Accepts a boolean or function that returns a boolean.
563
- * Defaults to `true`.
564
- */
565
- enabled?: Enabled<TQueryFnData, TError, TQueryData, TQueryKey>;
566
- /**
567
- * The time in milliseconds after data is considered stale.
568
- * If set to `Infinity`, the data will never be considered stale.
569
- * If set to a function, the function will be executed with the query to compute a `staleTime`.
570
- * Defaults to `0`.
571
- */
572
- staleTime?: StaleTimeFunction<TQueryFnData, TError, TQueryData, TQueryKey>;
573
- /**
574
- * If set to a number, the query will continuously refetch at this frequency in milliseconds.
575
- * If set to a function, the function will be executed with the latest data and query to compute a frequency
576
- * Defaults to `false`.
577
- */
578
- refetchInterval?: number | false | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => number | false | undefined);
579
- /**
580
- * If set to `true`, the query will continue to refetch while their tab/window is in the background.
581
- * Defaults to `false`.
582
- */
583
- refetchIntervalInBackground?: boolean;
584
- /**
585
- * If set to `true`, the query will refetch on window focus if the data is stale.
586
- * If set to `false`, the query will not refetch on window focus.
587
- * If set to `'always'`, the query will always refetch on window focus.
588
- * If set to a function, the function will be executed with the latest data and query to compute the value.
589
- * Defaults to `true`.
590
- */
591
- refetchOnWindowFocus?: boolean | 'always' | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | 'always');
592
- /**
593
- * If set to `true`, the query will refetch on reconnect if the data is stale.
594
- * If set to `false`, the query will not refetch on reconnect.
595
- * If set to `'always'`, the query will always refetch on reconnect.
596
- * If set to a function, the function will be executed with the latest data and query to compute the value.
597
- * Defaults to the value of `networkOnline` (`true`)
598
- */
599
- refetchOnReconnect?: boolean | 'always' | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | 'always');
600
- /**
601
- * If set to `true`, the query will refetch on mount if the data is stale.
602
- * If set to `false`, will disable additional instances of a query to trigger background refetch.
603
- * If set to `'always'`, the query will always refetch on mount.
604
- * If set to a function, the function will be executed with the latest data and query to compute the value
605
- * Defaults to `true`.
606
- */
607
- refetchOnMount?: boolean | 'always' | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | 'always');
608
- /**
609
- * If set to `false`, the query will not be retried on mount if it contains an error.
610
- * Defaults to `true`.
611
- */
612
- retryOnMount?: boolean;
613
- /**
614
- * If set, the component will only re-render if any of the listed properties change.
615
- * When set to `['data', 'error']`, the component will only re-render when the `data` or `error` properties change.
616
- * When set to `'all'`, the component will re-render whenever a query is updated.
617
- * When set to a function, the function will be executed to compute the list of properties.
618
- * By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.
619
- */
620
- notifyOnChangeProps?: NotifyOnChangeProps;
621
- /**
622
- * Whether errors should be thrown instead of setting the `error` property.
623
- * If set to `true` or `suspense` is `true`, all errors will be thrown to the error boundary.
624
- * If set to `false` and `suspense` is `false`, errors are returned as state.
625
- * If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (`true`) or return the error as state (`false`).
626
- * Defaults to `false`.
627
- */
628
- throwOnError?: ThrowOnError<TQueryFnData, TError, TQueryData, TQueryKey>;
629
- /**
630
- * This option can be used to transform or select a part of the data returned by the query function.
631
- */
632
- select?: (data: TQueryData) => TData;
633
- /**
634
- * If set to `true`, the query will suspend when `status === 'pending'`
635
- * and throw errors when `status === 'error'`.
636
- * Defaults to `false`.
637
- */
638
- suspense?: boolean;
639
- /**
640
- * If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `loading` data and no initialData has been provided.
641
- */
642
- placeholderData?: NonFunctionGuard<TQueryData> | PlaceholderDataFunction<NonFunctionGuard<TQueryData>, TError, NonFunctionGuard<TQueryData>, TQueryKey>;
643
- _optimisticResults?: 'optimistic' | 'isRestoring';
644
- /**
645
- * Enable prefetching during rendering
646
- */
647
- experimental_prefetchInRender?: boolean;
648
- }
649
- type WithRequired<TTarget, TKey extends keyof TTarget> = TTarget & { [_ in TKey]: {} };
650
- type DefaultedQueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = WithRequired<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'throwOnError' | 'refetchOnReconnect' | 'queryHash'>;
651
- interface FetchQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends WithRequired<QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'queryKey'> {
652
- initialPageParam?: never;
653
- /**
654
- * The time in milliseconds after data is considered stale.
655
- * If the data is fresh it will be returned from the cache.
656
- */
657
- staleTime?: StaleTimeFunction<TQueryFnData, TError, TData, TQueryKey>;
658
- }
659
- interface EnsureQueryDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> {
660
- revalidateIfStale?: boolean;
661
- }
662
- type EnsureInfiniteQueryDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & {
663
- revalidateIfStale?: boolean;
664
- };
665
- type FetchInfiniteQueryPages<TQueryFnData = unknown, TPageParam = unknown> = {
666
- pages?: never;
667
- } | {
668
- pages: number;
669
- getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>;
670
- };
671
- type FetchInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = Omit<FetchQueryOptions<TQueryFnData, TError, InfiniteData<TData, TPageParam>, TQueryKey, TPageParam>, 'initialPageParam'> & InitialPageParam<TPageParam> & FetchInfiniteQueryPages<TQueryFnData, TPageParam>;
672
- interface ResultOptions {
673
- throwOnError?: boolean;
674
- }
675
- interface RefetchOptions extends ResultOptions {
676
- /**
677
- * If set to `true`, a currently running request will be cancelled before a new request is made
678
- *
679
- * If set to `false`, no refetch will be made if there is already a request running.
680
- *
681
- * Defaults to `true`.
682
- */
683
- cancelRefetch?: boolean;
684
- }
685
- interface InvalidateQueryFilters<TQueryKey extends QueryKey = QueryKey> extends QueryFilters<TQueryKey> {
686
- refetchType?: QueryTypeFilter | 'none';
687
- }
688
- interface RefetchQueryFilters<TQueryKey extends QueryKey = QueryKey> extends QueryFilters<TQueryKey> {}
689
- interface InvalidateOptions extends RefetchOptions {}
690
- interface ResetOptions extends RefetchOptions {}
691
- interface FetchNextPageOptions extends ResultOptions {
692
- /**
693
- * If set to `true`, calling `fetchNextPage` repeatedly will invoke `queryFn` every time,
694
- * whether the previous invocation has resolved or not. Also, the result from previous invocations will be ignored.
695
- *
696
- * If set to `false`, calling `fetchNextPage` repeatedly won't have any effect until the first invocation has resolved.
697
- *
698
- * Defaults to `true`.
699
- */
700
- cancelRefetch?: boolean;
701
- }
702
- interface FetchPreviousPageOptions extends ResultOptions {
703
- /**
704
- * If set to `true`, calling `fetchPreviousPage` repeatedly will invoke `queryFn` every time,
705
- * whether the previous invocation has resolved or not. Also, the result from previous invocations will be ignored.
706
- *
707
- * If set to `false`, calling `fetchPreviousPage` repeatedly won't have any effect until the first invocation has resolved.
708
- *
709
- * Defaults to `true`.
710
- */
711
- cancelRefetch?: boolean;
712
- }
713
- type QueryStatus = 'pending' | 'error' | 'success';
714
- type FetchStatus = 'fetching' | 'paused' | 'idle';
715
- interface QueryObserverBaseResult<TData = unknown, TError = DefaultError> {
716
- /**
717
- * The last successfully resolved data for the query.
718
- */
719
- data: TData | undefined;
720
- /**
721
- * The timestamp for when the query most recently returned the `status` as `"success"`.
722
- */
723
- dataUpdatedAt: number;
724
- /**
725
- * The error object for the query, if an error was thrown.
726
- * - Defaults to `null`.
727
- */
728
- error: TError | null;
729
- /**
730
- * The timestamp for when the query most recently returned the `status` as `"error"`.
731
- */
732
- errorUpdatedAt: number;
733
- /**
734
- * The failure count for the query.
735
- * - Incremented every time the query fails.
736
- * - Reset to `0` when the query succeeds.
737
- */
738
- failureCount: number;
739
- /**
740
- * The failure reason for the query retry.
741
- * - Reset to `null` when the query succeeds.
742
- */
743
- failureReason: TError | null;
744
- /**
745
- * The sum of all errors.
746
- */
747
- errorUpdateCount: number;
748
- /**
749
- * A derived boolean from the `status` variable, provided for convenience.
750
- * - `true` if the query attempt resulted in an error.
751
- */
752
- isError: boolean;
753
- /**
754
- * Will be `true` if the query has been fetched.
755
- */
756
- isFetched: boolean;
757
- /**
758
- * Will be `true` if the query has been fetched after the component mounted.
759
- * - This property can be used to not show any previously cached data.
760
- */
761
- isFetchedAfterMount: boolean;
762
- /**
763
- * A derived boolean from the `fetchStatus` variable, provided for convenience.
764
- * - `true` whenever the `queryFn` is executing, which includes initial `pending` as well as background refetch.
765
- */
766
- isFetching: boolean;
767
- /**
768
- * Is `true` whenever the first fetch for a query is in-flight.
769
- * - Is the same as `isFetching && isPending`.
770
- */
771
- isLoading: boolean;
772
- /**
773
- * Will be `pending` if there's no cached data and no query attempt was finished yet.
774
- */
775
- isPending: boolean;
776
- /**
777
- * Will be `true` if the query failed while fetching for the first time.
778
- */
779
- isLoadingError: boolean;
780
- /**
781
- * @deprecated `isInitialLoading` is being deprecated in favor of `isLoading`
782
- * and will be removed in the next major version.
783
- */
784
- isInitialLoading: boolean;
785
- /**
786
- * A derived boolean from the `fetchStatus` variable, provided for convenience.
787
- * - The query wanted to fetch, but has been `paused`.
788
- */
789
- isPaused: boolean;
790
- /**
791
- * Will be `true` if the data shown is the placeholder data.
792
- */
793
- isPlaceholderData: boolean;
794
- /**
795
- * Will be `true` if the query failed while refetching.
796
- */
797
- isRefetchError: boolean;
798
- /**
799
- * Is `true` whenever a background refetch is in-flight, which _does not_ include initial `pending`.
800
- * - Is the same as `isFetching && !isPending`.
801
- */
802
- isRefetching: boolean;
803
- /**
804
- * Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.
805
- */
806
- isStale: boolean;
807
- /**
808
- * A derived boolean from the `status` variable, provided for convenience.
809
- * - `true` if the query has received a response with no errors and is ready to display its data.
810
- */
811
- isSuccess: boolean;
812
- /**
813
- * `true` if this observer is enabled, `false` otherwise.
814
- */
815
- isEnabled: boolean;
816
- /**
817
- * A function to manually refetch the query.
818
- */
819
- refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>>;
820
- /**
821
- * The status of the query.
822
- * - Will be:
823
- * - `pending` if there's no cached data and no query attempt was finished yet.
824
- * - `error` if the query attempt resulted in an error.
825
- * - `success` if the query has received a response with no errors and is ready to display its data.
826
- */
827
- status: QueryStatus;
828
- /**
829
- * The fetch status of the query.
830
- * - `fetching`: Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetch.
831
- * - `paused`: The query wanted to fetch, but has been `paused`.
832
- * - `idle`: The query is not fetching.
833
- * - See [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information.
834
- */
835
- fetchStatus: FetchStatus;
836
- /**
837
- * A stable promise that will be resolved with the data of the query.
838
- * Requires the `experimental_prefetchInRender` feature flag to be enabled.
839
- * @example
840
- *
841
- * ### Enabling the feature flag
842
- * ```ts
843
- * const client = new QueryClient({
844
- * defaultOptions: {
845
- * queries: {
846
- * experimental_prefetchInRender: true,
847
- * },
848
- * },
849
- * })
850
- * ```
851
- *
852
- * ### Usage
853
- * ```tsx
854
- * import { useQuery } from '@tanstack/react-query'
855
- * import React from 'react'
856
- * import { fetchTodos, type Todo } from './api'
857
- *
858
- * function TodoList({ query }: { query: UseQueryResult<Todo[], Error> }) {
859
- * const data = React.use(query.promise)
860
- *
861
- * return (
862
- * <ul>
863
- * {data.map(todo => (
864
- * <li key={todo.id}>{todo.title}</li>
865
- * ))}
866
- * </ul>
867
- * )
868
- * }
869
- *
870
- * export function App() {
871
- * const query = useQuery({ queryKey: ['todos'], queryFn: fetchTodos })
872
- *
873
- * return (
874
- * <>
875
- * <h1>Todos</h1>
876
- * <React.Suspense fallback={<div>Loading...</div>}>
877
- * <TodoList query={query} />
878
- * </React.Suspense>
879
- * </>
880
- * )
881
- * }
882
- * ```
883
- */
884
- promise: Promise<TData>;
885
- }
886
- interface QueryObserverPendingResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
887
- data: undefined;
888
- error: null;
889
- isError: false;
890
- isPending: true;
891
- isLoadingError: false;
892
- isRefetchError: false;
893
- isSuccess: false;
894
- isPlaceholderData: false;
895
- status: 'pending';
896
- }
897
- interface QueryObserverLoadingResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
898
- data: undefined;
899
- error: null;
900
- isError: false;
901
- isPending: true;
902
- isLoading: true;
903
- isLoadingError: false;
904
- isRefetchError: false;
905
- isSuccess: false;
906
- isPlaceholderData: false;
907
- status: 'pending';
908
- }
909
- interface QueryObserverLoadingErrorResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
910
- data: undefined;
911
- error: TError;
912
- isError: true;
913
- isPending: false;
914
- isLoading: false;
915
- isLoadingError: true;
916
- isRefetchError: false;
917
- isSuccess: false;
918
- isPlaceholderData: false;
919
- status: 'error';
920
- }
921
- interface QueryObserverRefetchErrorResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
922
- data: TData;
923
- error: TError;
924
- isError: true;
925
- isPending: false;
926
- isLoading: false;
927
- isLoadingError: false;
928
- isRefetchError: true;
929
- isSuccess: false;
930
- isPlaceholderData: false;
931
- status: 'error';
932
- }
933
- interface QueryObserverSuccessResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
934
- data: TData;
935
- error: null;
936
- isError: false;
937
- isPending: false;
938
- isLoading: false;
939
- isLoadingError: false;
940
- isRefetchError: false;
941
- isSuccess: true;
942
- isPlaceholderData: false;
943
- status: 'success';
944
- }
945
- interface QueryObserverPlaceholderResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
946
- data: TData;
947
- isError: false;
948
- error: null;
949
- isPending: false;
950
- isLoading: false;
951
- isLoadingError: false;
952
- isRefetchError: false;
953
- isSuccess: true;
954
- isPlaceholderData: true;
955
- status: 'success';
956
- }
957
- type DefinedQueryObserverResult<TData = unknown, TError = DefaultError> = QueryObserverRefetchErrorResult<TData, TError> | QueryObserverSuccessResult<TData, TError>;
958
- type QueryObserverResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError> | QueryObserverLoadingErrorResult<TData, TError> | QueryObserverLoadingResult<TData, TError> | QueryObserverPendingResult<TData, TError> | QueryObserverPlaceholderResult<TData, TError>;
959
- interface InfiniteQueryObserverBaseResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
960
- /**
961
- * This function allows you to fetch the next "page" of results.
962
- */
963
- fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>;
964
- /**
965
- * This function allows you to fetch the previous "page" of results.
966
- */
967
- fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>;
968
- /**
969
- * Will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).
970
- */
971
- hasNextPage: boolean;
972
- /**
973
- * Will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).
974
- */
975
- hasPreviousPage: boolean;
976
- /**
977
- * Will be `true` if the query failed while fetching the next page.
978
- */
979
- isFetchNextPageError: boolean;
980
- /**
981
- * Will be `true` while fetching the next page with `fetchNextPage`.
982
- */
983
- isFetchingNextPage: boolean;
984
- /**
985
- * Will be `true` if the query failed while fetching the previous page.
986
- */
987
- isFetchPreviousPageError: boolean;
988
- /**
989
- * Will be `true` while fetching the previous page with `fetchPreviousPage`.
990
- */
991
- isFetchingPreviousPage: boolean;
992
- }
993
- interface InfiniteQueryObserverPendingResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
994
- data: undefined;
995
- error: null;
996
- isError: false;
997
- isPending: true;
998
- isLoadingError: false;
999
- isRefetchError: false;
1000
- isFetchNextPageError: false;
1001
- isFetchPreviousPageError: false;
1002
- isSuccess: false;
1003
- isPlaceholderData: false;
1004
- status: 'pending';
1005
- }
1006
- interface InfiniteQueryObserverLoadingResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
1007
- data: undefined;
1008
- error: null;
1009
- isError: false;
1010
- isPending: true;
1011
- isLoading: true;
1012
- isLoadingError: false;
1013
- isRefetchError: false;
1014
- isFetchNextPageError: false;
1015
- isFetchPreviousPageError: false;
1016
- isSuccess: false;
1017
- isPlaceholderData: false;
1018
- status: 'pending';
1019
- }
1020
- interface InfiniteQueryObserverLoadingErrorResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
1021
- data: undefined;
1022
- error: TError;
1023
- isError: true;
1024
- isPending: false;
1025
- isLoading: false;
1026
- isLoadingError: true;
1027
- isRefetchError: false;
1028
- isFetchNextPageError: false;
1029
- isFetchPreviousPageError: false;
1030
- isSuccess: false;
1031
- isPlaceholderData: false;
1032
- status: 'error';
1033
- }
1034
- interface InfiniteQueryObserverRefetchErrorResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
1035
- data: TData;
1036
- error: TError;
1037
- isError: true;
1038
- isPending: false;
1039
- isLoading: false;
1040
- isLoadingError: false;
1041
- isRefetchError: true;
1042
- isSuccess: false;
1043
- isPlaceholderData: false;
1044
- status: 'error';
1045
- }
1046
- interface InfiniteQueryObserverSuccessResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
1047
- data: TData;
1048
- error: null;
1049
- isError: false;
1050
- isPending: false;
1051
- isLoading: false;
1052
- isLoadingError: false;
1053
- isRefetchError: false;
1054
- isFetchNextPageError: false;
1055
- isFetchPreviousPageError: false;
1056
- isSuccess: true;
1057
- isPlaceholderData: false;
1058
- status: 'success';
1059
- }
1060
- interface InfiniteQueryObserverPlaceholderResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
1061
- data: TData;
1062
- isError: false;
1063
- error: null;
1064
- isPending: false;
1065
- isLoading: false;
1066
- isLoadingError: false;
1067
- isRefetchError: false;
1068
- isSuccess: true;
1069
- isPlaceholderData: true;
1070
- isFetchNextPageError: false;
1071
- isFetchPreviousPageError: false;
1072
- status: 'success';
1073
- }
1074
- type DefinedInfiniteQueryObserverResult<TData = unknown, TError = DefaultError> = InfiniteQueryObserverRefetchErrorResult<TData, TError> | InfiniteQueryObserverSuccessResult<TData, TError>;
1075
- type InfiniteQueryObserverResult<TData = unknown, TError = DefaultError> = DefinedInfiniteQueryObserverResult<TData, TError> | InfiniteQueryObserverLoadingErrorResult<TData, TError> | InfiniteQueryObserverLoadingResult<TData, TError> | InfiniteQueryObserverPendingResult<TData, TError> | InfiniteQueryObserverPlaceholderResult<TData, TError>;
1076
- type MutationKey = Register extends {
1077
- mutationKey: infer TMutationKey;
1078
- } ? TMutationKey extends ReadonlyArray<unknown> ? TMutationKey : TMutationKey extends Array<unknown> ? TMutationKey : ReadonlyArray<unknown> : ReadonlyArray<unknown>;
1079
- type MutationStatus = 'idle' | 'pending' | 'success' | 'error';
1080
- type MutationScope = {
1081
- id: string;
1082
- };
1083
- type MutationMeta = Register extends {
1084
- mutationMeta: infer TMutationMeta;
1085
- } ? TMutationMeta extends Record<string, unknown> ? TMutationMeta : Record<string, unknown> : Record<string, unknown>;
1086
- type MutationFunctionContext = {
1087
- client: QueryClient;
1088
- meta: MutationMeta | undefined;
1089
- mutationKey?: MutationKey;
1090
- };
1091
- type MutationFunction<TData = unknown, TVariables = unknown> = (variables: TVariables, context: MutationFunctionContext) => Promise<TData>;
1092
- interface MutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> {
1093
- mutationFn?: MutationFunction<TData, TVariables>;
1094
- mutationKey?: MutationKey;
1095
- onMutate?: (variables: TVariables, context: MutationFunctionContext) => Promise<TOnMutateResult> | TOnMutateResult;
1096
- onSuccess?: (data: TData, variables: TVariables, onMutateResult: TOnMutateResult, context: MutationFunctionContext) => Promise<unknown> | unknown;
1097
- onError?: (error: TError, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => Promise<unknown> | unknown;
1098
- onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => Promise<unknown> | unknown;
1099
- retry?: RetryValue<TError>;
1100
- retryDelay?: RetryDelayValue<TError>;
1101
- networkMode?: NetworkMode;
1102
- gcTime?: number;
1103
- _defaulted?: boolean;
1104
- meta?: MutationMeta;
1105
- scope?: MutationScope;
1106
- }
1107
- interface MutationObserverOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationOptions<TData, TError, TVariables, TOnMutateResult> {
1108
- throwOnError?: boolean | ((error: TError) => boolean);
1109
- }
1110
- interface MutateOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> {
1111
- onSuccess?: (data: TData, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => void;
1112
- onError?: (error: TError, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => void;
1113
- onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => void;
1114
- }
1115
- type MutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TOnMutateResult>) => Promise<TData>;
1116
- interface MutationObserverBaseResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationState<TData, TError, TVariables, TOnMutateResult> {
1117
- /**
1118
- * The last successfully resolved data for the mutation.
1119
- */
1120
- data: TData | undefined;
1121
- /**
1122
- * The variables object passed to the `mutationFn`.
1123
- */
1124
- variables: TVariables | undefined;
1125
- /**
1126
- * The error object for the mutation, if an error was encountered.
1127
- * - Defaults to `null`.
1128
- */
1129
- error: TError | null;
1130
- /**
1131
- * A boolean variable derived from `status`.
1132
- * - `true` if the last mutation attempt resulted in an error.
1133
- */
1134
- isError: boolean;
1135
- /**
1136
- * A boolean variable derived from `status`.
1137
- * - `true` if the mutation is in its initial state prior to executing.
1138
- */
1139
- isIdle: boolean;
1140
- /**
1141
- * A boolean variable derived from `status`.
1142
- * - `true` if the mutation is currently executing.
1143
- */
1144
- isPending: boolean;
1145
- /**
1146
- * A boolean variable derived from `status`.
1147
- * - `true` if the last mutation attempt was successful.
1148
- */
1149
- isSuccess: boolean;
1150
- /**
1151
- * The status of the mutation.
1152
- * - Will be:
1153
- * - `idle` initial status prior to the mutation function executing.
1154
- * - `pending` if the mutation is currently executing.
1155
- * - `error` if the last mutation attempt resulted in an error.
1156
- * - `success` if the last mutation attempt was successful.
1157
- */
1158
- status: MutationStatus;
1159
- /**
1160
- * The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.
1161
- * @param variables - The variables object to pass to the `mutationFn`.
1162
- * @param options.onSuccess - This function will fire when the mutation is successful and will be passed the mutation's result.
1163
- * @param options.onError - This function will fire if the mutation encounters an error and will be passed the error.
1164
- * @param options.onSettled - This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error.
1165
- * @remarks
1166
- * - If you make multiple requests, `onSuccess` will fire only after the latest call you've made.
1167
- * - All the callback functions (`onSuccess`, `onError`, `onSettled`) are void functions, and the returned value will be ignored.
1168
- */
1169
- mutate: MutateFunction<TData, TError, TVariables, TOnMutateResult>;
1170
- /**
1171
- * A function to clean the mutation internal state (i.e., it resets the mutation to its initial state).
1172
- */
1173
- reset: () => void;
1174
- }
1175
- interface MutationObserverIdleResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
1176
- data: undefined;
1177
- variables: undefined;
1178
- error: null;
1179
- isError: false;
1180
- isIdle: true;
1181
- isPending: false;
1182
- isSuccess: false;
1183
- status: 'idle';
1184
- }
1185
- interface MutationObserverLoadingResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
1186
- data: undefined;
1187
- variables: TVariables;
1188
- error: null;
1189
- isError: false;
1190
- isIdle: false;
1191
- isPending: true;
1192
- isSuccess: false;
1193
- status: 'pending';
1194
- }
1195
- interface MutationObserverErrorResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
1196
- data: undefined;
1197
- error: TError;
1198
- variables: TVariables;
1199
- isError: true;
1200
- isIdle: false;
1201
- isPending: false;
1202
- isSuccess: false;
1203
- status: 'error';
1204
- }
1205
- interface MutationObserverSuccessResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
1206
- data: TData;
1207
- error: null;
1208
- variables: TVariables;
1209
- isError: false;
1210
- isIdle: false;
1211
- isPending: false;
1212
- isSuccess: true;
1213
- status: 'success';
1214
- }
1215
- 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>;
1216
- interface QueryClientConfig {
1217
- queryCache?: QueryCache;
1218
- mutationCache?: MutationCache;
1219
- defaultOptions?: DefaultOptions;
1220
- }
1221
- interface DefaultOptions<TError = DefaultError> {
1222
- queries?: OmitKeyof<QueryObserverOptions<unknown, TError>, 'suspense' | 'queryKey'>;
1223
- mutations?: MutationObserverOptions<unknown, TError, unknown, unknown>;
1224
- hydrate?: HydrateOptions['defaultOptions'];
1225
- dehydrate?: DehydrateOptions;
1226
- }
1227
- interface CancelOptions {
1228
- revert?: boolean;
1229
- silent?: boolean;
1230
- }
1231
- interface SetDataOptions {
1232
- updatedAt?: number;
1233
- }
1234
- type NotifyEventType = 'added' | 'removed' | 'updated' | 'observerAdded' | 'observerRemoved' | 'observerResultsUpdated' | 'observerOptionsUpdated';
1235
- interface NotifyEvent {
1236
- type: NotifyEventType;
1237
- }
1238
- type TransformerFn = (data: any) => any;
1239
- interface DehydrateOptions {
1240
- serializeData?: TransformerFn;
1241
- shouldDehydrateMutation?: (mutation: Mutation) => boolean;
1242
- shouldDehydrateQuery?: (query: Query) => boolean;
1243
- shouldRedactErrors?: (error: unknown) => boolean;
1244
- }
1245
- interface HydrateOptions {
1246
- defaultOptions?: {
1247
- deserializeData?: TransformerFn;
1248
- queries?: QueryOptions;
1249
- mutations?: MutationOptions<unknown, DefaultError, unknown, unknown>;
1250
- };
1251
- }
1252
- //#endregion
1253
- //#region src/lib.d.ts
1254
- type EdenMutationFn<I = any, T extends Record<number, unknown> = Record<number, unknown>> = (input: I) => Promise<Treaty.TreatyResponse<T>>;
1255
- type EdenQueryFn<T extends Record<number, unknown> = Record<number, unknown>> = () => Promise<Treaty.TreatyResponse<T>>;
1256
- declare function treatyMutationOptions<T extends EdenMutationFn, P extends Parameters<T>, R extends Awaited<ReturnType<T>>>(params: {
1257
- fn: T;
1258
- } & Omit<Parameters<typeof mutationOptions<R["data"], R["error"], P[0]>>[0], "mutationFn">): Omit<_tanstack_react_query0.UseMutationOptions<R["data"], R["error"], P[0], unknown>, "mutationKey">;
1259
- declare function treatyQueryOptions<T extends EdenQueryFn, R extends Awaited<ReturnType<T>>>(params: {
1260
- fn: T;
1261
- } & Omit<Parameters<typeof queryOptions<R["data"], R["error"]>>[0], "queryFn">): OmitKeyof<_tanstack_react_query0.UseQueryOptions<R["data"], R["error"], R["data"], readonly unknown[]>, "queryFn"> & {
1262
- queryFn?: QueryFunction<R["data"], readonly unknown[], never> | undefined;
1263
- } & {
1264
- queryKey: readonly unknown[] & {
1265
- [dataTagSymbol]: R["data"];
1266
- [dataTagErrorSymbol]: R["error"];
1267
- };
1268
- };
1269
- //#endregion
1270
- export { treatyMutationOptions, treatyQueryOptions };
1271
- //# sourceMappingURL=index.d.ts.map
2
+ import { UseMutationOptions, UseQueryOptions } from "@tanstack/react-query";
3
+ type EdenMutationFn<
4
+ TBody = any,
5
+ TOptions = any,
6
+ TResponse extends Record<number, unknown> = Record<number, unknown>
7
+ > = ((body: TBody, options: TOptions) => Promise<Treaty.TreatyResponse<TResponse>>);
8
+ type EdenQueryFn<TResponse extends Record<number, unknown> = Record<number, unknown>> = (() => Promise<Treaty.TreatyResponse<TResponse>>);
9
+ type InferMutationVariables<TFn extends EdenMutationFn> = (unknown extends Parameters<TFn>[0] ? Parameters<TFn>[1] : Parameters<TFn>[1] & {
10
+ body: Parameters<TFn>[0];
11
+ });
12
+ type InferMutationOptions<TFn extends EdenMutationFn> = (UseMutationOptions<Awaited<ReturnType<TFn>>["data"], Awaited<ReturnType<TFn>>["error"], InferMutationVariables<TFn>>);
13
+ type InferQueryOptions<TFn extends EdenQueryFn> = (UseQueryOptions<Awaited<ReturnType<TFn>>["data"], Awaited<ReturnType<TFn>>["error"]>);
14
+ declare function treatyMutationOptions<TFn extends EdenMutationFn>(fn: TFn, options?: Omit<InferMutationOptions<TFn>, "mutationFn">): InferMutationOptions<TFn>;
15
+ declare function treatyQueryOptions<TFn extends EdenQueryFn>(fn: TFn, options: Omit<InferQueryOptions<TFn>, "queryFn">): InferQueryOptions<TFn>;
16
+ export { treatyQueryOptions, treatyMutationOptions };