@tanstack/query-core 5.29.0 → 5.32.0
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.cjs +4 -4
- package/build/legacy/hydration.cjs.map +1 -1
- package/build/legacy/hydration.d.cts +2 -1
- package/build/legacy/hydration.d.ts +2 -1
- package/build/legacy/hydration.js +4 -4
- package/build/legacy/hydration.js.map +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 +31 -32
- 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 +32 -33
- package/build/legacy/mutation.js.map +1 -1
- package/build/legacy/mutationCache.cjs +43 -25
- 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 +43 -25
- package/build/legacy/mutationCache.js.map +1 -1
- package/build/legacy/mutationObserver.d.cts +1 -1
- package/build/legacy/mutationObserver.d.ts +1 -1
- package/build/legacy/queriesObserver.d.cts +1 -1
- package/build/legacy/queriesObserver.d.ts +1 -1
- package/build/legacy/query.cjs +18 -21
- package/build/legacy/query.cjs.map +1 -1
- package/build/legacy/query.d.cts +1 -1
- package/build/legacy/query.d.ts +1 -1
- package/build/legacy/query.js +18 -21
- package/build/legacy/query.js.map +1 -1
- package/build/legacy/queryCache.d.cts +1 -1
- package/build/legacy/queryCache.d.ts +1 -1
- package/build/legacy/queryClient.d.cts +1 -1
- package/build/legacy/queryClient.d.ts +1 -1
- package/build/legacy/queryObserver.d.cts +1 -1
- package/build/legacy/queryObserver.d.ts +1 -1
- package/build/legacy/retryer.cjs +16 -16
- package/build/legacy/retryer.cjs.map +1 -1
- package/build/legacy/retryer.d.cts +1 -1
- package/build/legacy/retryer.d.ts +1 -1
- package/build/legacy/retryer.js +16 -16
- package/build/legacy/retryer.js.map +1 -1
- package/build/legacy/{queryClient-K0zFyarY.d.ts → types-PcQm32IV.d.ts} +276 -266
- package/build/legacy/{queryClient--tFV-sQG.d.cts → types-eJX-7bPI.d.cts} +276 -266
- 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/utils.d.cts +1 -1
- package/build/legacy/utils.d.ts +1 -1
- package/build/modern/hydration.cjs +4 -4
- package/build/modern/hydration.cjs.map +1 -1
- package/build/modern/hydration.d.cts +2 -1
- package/build/modern/hydration.d.ts +2 -1
- package/build/modern/hydration.js +4 -4
- package/build/modern/hydration.js.map +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 +30 -30
- 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 +31 -31
- package/build/modern/mutation.js.map +1 -1
- package/build/modern/mutationCache.cjs +38 -23
- 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 +38 -23
- package/build/modern/mutationCache.js.map +1 -1
- package/build/modern/mutationObserver.d.cts +1 -1
- package/build/modern/mutationObserver.d.ts +1 -1
- package/build/modern/queriesObserver.d.cts +1 -1
- package/build/modern/queriesObserver.d.ts +1 -1
- package/build/modern/query.cjs +17 -19
- package/build/modern/query.cjs.map +1 -1
- package/build/modern/query.d.cts +1 -1
- package/build/modern/query.d.ts +1 -1
- package/build/modern/query.js +17 -19
- package/build/modern/query.js.map +1 -1
- package/build/modern/queryCache.d.cts +1 -1
- package/build/modern/queryCache.d.ts +1 -1
- package/build/modern/queryClient.d.cts +1 -1
- package/build/modern/queryClient.d.ts +1 -1
- package/build/modern/queryObserver.d.cts +1 -1
- package/build/modern/queryObserver.d.ts +1 -1
- package/build/modern/retryer.cjs +16 -16
- package/build/modern/retryer.cjs.map +1 -1
- package/build/modern/retryer.d.cts +1 -1
- package/build/modern/retryer.d.ts +1 -1
- package/build/modern/retryer.js +16 -16
- package/build/modern/retryer.js.map +1 -1
- package/build/modern/{queryClient-K0zFyarY.d.ts → types-PcQm32IV.d.ts} +276 -266
- package/build/modern/{queryClient--tFV-sQG.d.cts → types-eJX-7bPI.d.cts} +276 -266
- 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/utils.d.cts +1 -1
- package/build/modern/utils.d.ts +1 -1
- package/package.json +1 -1
- package/src/__tests__/hydration.test.tsx +34 -0
- package/src/__tests__/mutations.test.tsx +191 -0
- package/src/__tests__/queryClient.test.tsx +96 -4
- package/src/hydration.ts +8 -6
- package/src/mutation.ts +32 -33
- package/src/mutationCache.ts +54 -28
- package/src/query.ts +17 -18
- package/src/retryer.ts +24 -20
- package/src/types.ts +5 -0
|
@@ -1,19 +1,155 @@
|
|
|
1
1
|
import { Removable } from './removable.js';
|
|
2
2
|
import { Subscribable } from './subscribable.js';
|
|
3
3
|
|
|
4
|
-
type
|
|
5
|
-
|
|
4
|
+
type QueryObserverListener<TData, TError> = (result: QueryObserverResult<TData, TError>) => void;
|
|
5
|
+
interface NotifyOptions {
|
|
6
|
+
listeners?: boolean;
|
|
7
|
+
}
|
|
8
|
+
interface ObserverFetchOptions extends FetchOptions {
|
|
9
|
+
throwOnError?: boolean;
|
|
10
|
+
}
|
|
11
|
+
declare class QueryObserver<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends Subscribable<QueryObserverListener<TData, TError>> {
|
|
6
12
|
#private;
|
|
7
|
-
options:
|
|
8
|
-
constructor(client: QueryClient, options:
|
|
13
|
+
options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
|
|
14
|
+
constructor(client: QueryClient, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>);
|
|
9
15
|
protected bindMethods(): void;
|
|
10
|
-
|
|
16
|
+
protected onSubscribe(): void;
|
|
11
17
|
protected onUnsubscribe(): void;
|
|
12
|
-
|
|
13
|
-
|
|
18
|
+
shouldFetchOnReconnect(): boolean;
|
|
19
|
+
shouldFetchOnWindowFocus(): boolean;
|
|
20
|
+
destroy(): void;
|
|
21
|
+
setOptions(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, notifyOptions?: NotifyOptions): void;
|
|
22
|
+
getOptimisticResult(options: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
|
|
23
|
+
getCurrentResult(): QueryObserverResult<TData, TError>;
|
|
24
|
+
trackResult(result: QueryObserverResult<TData, TError>, onPropTracked?: (key: keyof QueryObserverResult) => void): QueryObserverResult<TData, TError>;
|
|
25
|
+
trackProp(key: keyof QueryObserverResult): void;
|
|
26
|
+
getCurrentQuery(): Query<TQueryFnData, TError, TQueryData, TQueryKey>;
|
|
27
|
+
refetch({ ...options }?: RefetchOptions): Promise<QueryObserverResult<TData, TError>>;
|
|
28
|
+
fetchOptimistic(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): Promise<QueryObserverResult<TData, TError>>;
|
|
29
|
+
protected fetch(fetchOptions: ObserverFetchOptions): Promise<QueryObserverResult<TData, TError>>;
|
|
30
|
+
protected createResult(query: Query<TQueryFnData, TError, TQueryData, TQueryKey>, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
|
|
31
|
+
updateResult(notifyOptions?: NotifyOptions): void;
|
|
32
|
+
onQueryUpdate(): void;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
interface QueryConfig<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
|
|
36
|
+
cache: QueryCache;
|
|
37
|
+
queryKey: TQueryKey;
|
|
38
|
+
queryHash: string;
|
|
39
|
+
options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
40
|
+
defaultOptions?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
41
|
+
state?: QueryState<TData, TError>;
|
|
42
|
+
}
|
|
43
|
+
interface QueryState<TData = unknown, TError = DefaultError> {
|
|
44
|
+
data: TData | undefined;
|
|
45
|
+
dataUpdateCount: number;
|
|
46
|
+
dataUpdatedAt: number;
|
|
47
|
+
error: TError | null;
|
|
48
|
+
errorUpdateCount: number;
|
|
49
|
+
errorUpdatedAt: number;
|
|
50
|
+
fetchFailureCount: number;
|
|
51
|
+
fetchFailureReason: TError | null;
|
|
52
|
+
fetchMeta: FetchMeta | null;
|
|
53
|
+
isInvalidated: boolean;
|
|
54
|
+
status: QueryStatus;
|
|
55
|
+
fetchStatus: FetchStatus;
|
|
56
|
+
}
|
|
57
|
+
interface FetchContext<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
|
|
58
|
+
fetchFn: () => unknown | Promise<unknown>;
|
|
59
|
+
fetchOptions?: FetchOptions;
|
|
60
|
+
signal: AbortSignal;
|
|
61
|
+
options: QueryOptions<TQueryFnData, TError, TData, any>;
|
|
62
|
+
queryKey: TQueryKey;
|
|
63
|
+
state: QueryState<TData, TError>;
|
|
64
|
+
}
|
|
65
|
+
interface QueryBehavior<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> {
|
|
66
|
+
onFetch: (context: FetchContext<TQueryFnData, TError, TData, TQueryKey>, query: Query) => void;
|
|
67
|
+
}
|
|
68
|
+
type FetchDirection = 'forward' | 'backward';
|
|
69
|
+
interface FetchMeta {
|
|
70
|
+
fetchMore?: {
|
|
71
|
+
direction: FetchDirection;
|
|
72
|
+
};
|
|
73
|
+
}
|
|
74
|
+
interface FetchOptions {
|
|
75
|
+
cancelRefetch?: boolean;
|
|
76
|
+
meta?: FetchMeta;
|
|
77
|
+
}
|
|
78
|
+
interface FailedAction$1<TError> {
|
|
79
|
+
type: 'failed';
|
|
80
|
+
failureCount: number;
|
|
81
|
+
error: TError;
|
|
82
|
+
}
|
|
83
|
+
interface FetchAction {
|
|
84
|
+
type: 'fetch';
|
|
85
|
+
meta?: FetchMeta;
|
|
86
|
+
}
|
|
87
|
+
interface SuccessAction$1<TData> {
|
|
88
|
+
data: TData | undefined;
|
|
89
|
+
type: 'success';
|
|
90
|
+
dataUpdatedAt?: number;
|
|
91
|
+
manual?: boolean;
|
|
92
|
+
}
|
|
93
|
+
interface ErrorAction$1<TError> {
|
|
94
|
+
type: 'error';
|
|
95
|
+
error: TError;
|
|
96
|
+
}
|
|
97
|
+
interface InvalidateAction {
|
|
98
|
+
type: 'invalidate';
|
|
99
|
+
}
|
|
100
|
+
interface PauseAction$1 {
|
|
101
|
+
type: 'pause';
|
|
102
|
+
}
|
|
103
|
+
interface ContinueAction$1 {
|
|
104
|
+
type: 'continue';
|
|
105
|
+
}
|
|
106
|
+
interface SetStateAction<TData, TError> {
|
|
107
|
+
type: 'setState';
|
|
108
|
+
state: Partial<QueryState<TData, TError>>;
|
|
109
|
+
setStateOptions?: SetStateOptions;
|
|
110
|
+
}
|
|
111
|
+
type Action$1<TData, TError> = ContinueAction$1 | ErrorAction$1<TError> | FailedAction$1<TError> | FetchAction | InvalidateAction | PauseAction$1 | SetStateAction<TData, TError> | SuccessAction$1<TData>;
|
|
112
|
+
interface SetStateOptions {
|
|
113
|
+
meta?: any;
|
|
114
|
+
}
|
|
115
|
+
declare class Query<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends Removable {
|
|
116
|
+
#private;
|
|
117
|
+
queryKey: TQueryKey;
|
|
118
|
+
queryHash: string;
|
|
119
|
+
options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
120
|
+
state: QueryState<TData, TError>;
|
|
121
|
+
isFetchingOptimistic?: boolean;
|
|
122
|
+
observers: Array<QueryObserver<any, any, any, any, any>>;
|
|
123
|
+
constructor(config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>);
|
|
124
|
+
get meta(): QueryMeta | undefined;
|
|
125
|
+
setOptions(options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>): void;
|
|
126
|
+
protected optionalRemove(): void;
|
|
127
|
+
setData(newData: TData, options?: SetDataOptions & {
|
|
128
|
+
manual: boolean;
|
|
129
|
+
}): TData;
|
|
130
|
+
setState(state: Partial<QueryState<TData, TError>>, setStateOptions?: SetStateOptions): void;
|
|
131
|
+
cancel(options?: CancelOptions): Promise<void>;
|
|
132
|
+
destroy(): void;
|
|
14
133
|
reset(): void;
|
|
15
|
-
|
|
134
|
+
isActive(): boolean;
|
|
135
|
+
isDisabled(): boolean;
|
|
136
|
+
isStale(): boolean;
|
|
137
|
+
isStaleByTime(staleTime?: number): boolean;
|
|
138
|
+
onFocus(): void;
|
|
139
|
+
onOnline(): void;
|
|
140
|
+
addObserver(observer: QueryObserver<any, any, any, any, any>): void;
|
|
141
|
+
removeObserver(observer: QueryObserver<any, any, any, any, any>): void;
|
|
142
|
+
getObserversCount(): number;
|
|
143
|
+
invalidate(): void;
|
|
144
|
+
fetch(options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>, fetchOptions?: FetchOptions): Promise<TData>;
|
|
16
145
|
}
|
|
146
|
+
declare function fetchState<TQueryFnData, TError, TData, TQueryKey extends QueryKey>(data: TData | undefined, options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>): {
|
|
147
|
+
readonly error?: null | undefined;
|
|
148
|
+
readonly status?: "pending" | undefined;
|
|
149
|
+
readonly fetchFailureCount: 0;
|
|
150
|
+
readonly fetchFailureReason: null;
|
|
151
|
+
readonly fetchStatus: "fetching" | "paused";
|
|
152
|
+
};
|
|
17
153
|
|
|
18
154
|
interface QueryFilters {
|
|
19
155
|
/**
|
|
@@ -98,6 +234,119 @@ declare function addToStart<T>(items: Array<T>, item: T, max?: number): Array<T>
|
|
|
98
234
|
declare const skipToken: unique symbol;
|
|
99
235
|
type SkipToken = typeof skipToken;
|
|
100
236
|
|
|
237
|
+
interface QueryCacheConfig {
|
|
238
|
+
onError?: (error: DefaultError, query: Query<unknown, unknown, unknown>) => void;
|
|
239
|
+
onSuccess?: (data: unknown, query: Query<unknown, unknown, unknown>) => void;
|
|
240
|
+
onSettled?: (data: unknown | undefined, error: DefaultError | null, query: Query<unknown, unknown, unknown>) => void;
|
|
241
|
+
}
|
|
242
|
+
interface NotifyEventQueryAdded extends NotifyEvent {
|
|
243
|
+
type: 'added';
|
|
244
|
+
query: Query<any, any, any, any>;
|
|
245
|
+
}
|
|
246
|
+
interface NotifyEventQueryRemoved extends NotifyEvent {
|
|
247
|
+
type: 'removed';
|
|
248
|
+
query: Query<any, any, any, any>;
|
|
249
|
+
}
|
|
250
|
+
interface NotifyEventQueryUpdated extends NotifyEvent {
|
|
251
|
+
type: 'updated';
|
|
252
|
+
query: Query<any, any, any, any>;
|
|
253
|
+
action: Action$1<any, any>;
|
|
254
|
+
}
|
|
255
|
+
interface NotifyEventQueryObserverAdded extends NotifyEvent {
|
|
256
|
+
type: 'observerAdded';
|
|
257
|
+
query: Query<any, any, any, any>;
|
|
258
|
+
observer: QueryObserver<any, any, any, any, any>;
|
|
259
|
+
}
|
|
260
|
+
interface NotifyEventQueryObserverRemoved extends NotifyEvent {
|
|
261
|
+
type: 'observerRemoved';
|
|
262
|
+
query: Query<any, any, any, any>;
|
|
263
|
+
observer: QueryObserver<any, any, any, any, any>;
|
|
264
|
+
}
|
|
265
|
+
interface NotifyEventQueryObserverResultsUpdated extends NotifyEvent {
|
|
266
|
+
type: 'observerResultsUpdated';
|
|
267
|
+
query: Query<any, any, any, any>;
|
|
268
|
+
}
|
|
269
|
+
interface NotifyEventQueryObserverOptionsUpdated extends NotifyEvent {
|
|
270
|
+
type: 'observerOptionsUpdated';
|
|
271
|
+
query: Query<any, any, any, any>;
|
|
272
|
+
observer: QueryObserver<any, any, any, any, any>;
|
|
273
|
+
}
|
|
274
|
+
type QueryCacheNotifyEvent = NotifyEventQueryAdded | NotifyEventQueryRemoved | NotifyEventQueryUpdated | NotifyEventQueryObserverAdded | NotifyEventQueryObserverRemoved | NotifyEventQueryObserverResultsUpdated | NotifyEventQueryObserverOptionsUpdated;
|
|
275
|
+
type QueryCacheListener = (event: QueryCacheNotifyEvent) => void;
|
|
276
|
+
interface QueryStore {
|
|
277
|
+
has: (queryHash: string) => boolean;
|
|
278
|
+
set: (queryHash: string, query: Query) => void;
|
|
279
|
+
get: (queryHash: string) => Query | undefined;
|
|
280
|
+
delete: (queryHash: string) => void;
|
|
281
|
+
values: () => IterableIterator<Query>;
|
|
282
|
+
}
|
|
283
|
+
declare class QueryCache extends Subscribable<QueryCacheListener> {
|
|
284
|
+
#private;
|
|
285
|
+
config: QueryCacheConfig;
|
|
286
|
+
constructor(config?: QueryCacheConfig);
|
|
287
|
+
build<TQueryFnData, TError, TData, TQueryKey extends QueryKey>(client: QueryClient, options: WithRequired<QueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey'>, state?: QueryState<TData, TError>): Query<TQueryFnData, TError, TData, TQueryKey>;
|
|
288
|
+
add(query: Query<any, any, any, any>): void;
|
|
289
|
+
remove(query: Query<any, any, any, any>): void;
|
|
290
|
+
clear(): void;
|
|
291
|
+
get<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryHash: string): Query<TQueryFnData, TError, TData, TQueryKey> | undefined;
|
|
292
|
+
getAll(): Array<Query>;
|
|
293
|
+
find<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData>(filters: WithRequired<QueryFilters, 'queryKey'>): Query<TQueryFnData, TError, TData> | undefined;
|
|
294
|
+
findAll(filters?: QueryFilters): Array<Query>;
|
|
295
|
+
notify(event: QueryCacheNotifyEvent): void;
|
|
296
|
+
onFocus(): void;
|
|
297
|
+
onOnline(): void;
|
|
298
|
+
}
|
|
299
|
+
|
|
300
|
+
declare class QueryClient {
|
|
301
|
+
#private;
|
|
302
|
+
constructor(config?: QueryClientConfig);
|
|
303
|
+
mount(): void;
|
|
304
|
+
unmount(): void;
|
|
305
|
+
isFetching(filters?: QueryFilters): number;
|
|
306
|
+
isMutating(filters?: MutationFilters): number;
|
|
307
|
+
getQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue> ? TaggedValue : TQueryFnData>(queryKey: TTaggedQueryKey): TInferredQueryFnData | undefined;
|
|
308
|
+
ensureQueryData<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>;
|
|
309
|
+
getQueriesData<TQueryFnData = unknown>(filters: QueryFilters): Array<[QueryKey, TQueryFnData | undefined]>;
|
|
310
|
+
setQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue> ? TaggedValue : TQueryFnData>(queryKey: TTaggedQueryKey, updater: Updater<NoInfer<TInferredQueryFnData> | undefined, NoInfer<TInferredQueryFnData> | undefined>, options?: SetDataOptions): TInferredQueryFnData | undefined;
|
|
311
|
+
setQueriesData<TQueryFnData>(filters: QueryFilters, updater: Updater<TQueryFnData | undefined, TQueryFnData | undefined>, options?: SetDataOptions): Array<[QueryKey, TQueryFnData | undefined]>;
|
|
312
|
+
getQueryState<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue> ? TaggedValue : TQueryFnData>(queryKey: TTaggedQueryKey): QueryState<TInferredQueryFnData, TError> | undefined;
|
|
313
|
+
removeQueries(filters?: QueryFilters): void;
|
|
314
|
+
resetQueries(filters?: QueryFilters, options?: ResetOptions): Promise<void>;
|
|
315
|
+
cancelQueries(filters?: QueryFilters, cancelOptions?: CancelOptions): Promise<void>;
|
|
316
|
+
invalidateQueries(filters?: InvalidateQueryFilters, options?: InvalidateOptions): Promise<void>;
|
|
317
|
+
refetchQueries(filters?: RefetchQueryFilters, options?: RefetchOptions): Promise<void>;
|
|
318
|
+
fetchQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<TData>;
|
|
319
|
+
prefetchQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
|
|
320
|
+
fetchInfiniteQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<InfiniteData<TData, TPageParam>>;
|
|
321
|
+
prefetchInfiniteQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<void>;
|
|
322
|
+
resumePausedMutations(): Promise<unknown>;
|
|
323
|
+
getQueryCache(): QueryCache;
|
|
324
|
+
getMutationCache(): MutationCache;
|
|
325
|
+
getDefaultOptions(): DefaultOptions;
|
|
326
|
+
setDefaultOptions(options: DefaultOptions): void;
|
|
327
|
+
setQueryDefaults(queryKey: QueryKey, options: Partial<OmitKeyof<QueryObserverOptions<unknown, any, any, any>, 'queryKey'>>): void;
|
|
328
|
+
getQueryDefaults(queryKey: QueryKey): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'>;
|
|
329
|
+
setMutationDefaults(mutationKey: MutationKey, options: OmitKeyof<MutationObserverOptions<any, any, any, any>, 'mutationKey'>): void;
|
|
330
|
+
getMutationDefaults(mutationKey: MutationKey): MutationObserverOptions<any, any, any, any>;
|
|
331
|
+
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>;
|
|
332
|
+
defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(options?: T): T;
|
|
333
|
+
clear(): void;
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
type MutationObserverListener<TData, TError, TVariables, TContext> = (result: MutationObserverResult<TData, TError, TVariables, TContext>) => void;
|
|
337
|
+
declare class MutationObserver<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends Subscribable<MutationObserverListener<TData, TError, TVariables, TContext>> {
|
|
338
|
+
#private;
|
|
339
|
+
options: MutationObserverOptions<TData, TError, TVariables, TContext>;
|
|
340
|
+
constructor(client: QueryClient, options: MutationObserverOptions<TData, TError, TVariables, TContext>);
|
|
341
|
+
protected bindMethods(): void;
|
|
342
|
+
setOptions(options: MutationObserverOptions<TData, TError, TVariables, TContext>): void;
|
|
343
|
+
protected onUnsubscribe(): void;
|
|
344
|
+
onMutationUpdate(action: Action<TData, TError, TVariables, TContext>): void;
|
|
345
|
+
getCurrentResult(): MutationObserverResult<TData, TError, TVariables, TContext>;
|
|
346
|
+
reset(): void;
|
|
347
|
+
mutate(variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>): Promise<TData>;
|
|
348
|
+
}
|
|
349
|
+
|
|
101
350
|
interface MutationCacheConfig {
|
|
102
351
|
onError?: (error: DefaultError, variables: unknown, context: unknown, mutation: Mutation<unknown, unknown, unknown>) => Promise<unknown> | unknown;
|
|
103
352
|
onSuccess?: (data: unknown, variables: unknown, context: unknown, mutation: Mutation<unknown, unknown, unknown>) => Promise<unknown> | unknown;
|
|
@@ -130,7 +379,7 @@ interface NotifyEventMutationObserverOptionsUpdated extends NotifyEvent {
|
|
|
130
379
|
interface NotifyEventMutationUpdated extends NotifyEvent {
|
|
131
380
|
type: 'updated';
|
|
132
381
|
mutation: Mutation<any, any, any, any>;
|
|
133
|
-
action: Action
|
|
382
|
+
action: Action<any, any, any, any>;
|
|
134
383
|
}
|
|
135
384
|
type MutationCacheNotifyEvent = NotifyEventMutationAdded | NotifyEventMutationRemoved | NotifyEventMutationObserverAdded | NotifyEventMutationObserverRemoved | NotifyEventMutationObserverOptionsUpdated | NotifyEventMutationUpdated;
|
|
136
385
|
type MutationCacheListener = (event: MutationCacheNotifyEvent) => void;
|
|
@@ -141,6 +390,8 @@ declare class MutationCache extends Subscribable<MutationCacheListener> {
|
|
|
141
390
|
build<TData, TError, TVariables, TContext>(client: QueryClient, options: MutationOptions<TData, TError, TVariables, TContext>, state?: MutationState<TData, TError, TVariables, TContext>): Mutation<TData, TError, TVariables, TContext>;
|
|
142
391
|
add(mutation: Mutation<any, any, any, any>): void;
|
|
143
392
|
remove(mutation: Mutation<any, any, any, any>): void;
|
|
393
|
+
canRun(mutation: Mutation<any, any, any, any>): boolean;
|
|
394
|
+
runNext(mutation: Mutation<any, any, any, any>): Promise<unknown>;
|
|
144
395
|
clear(): void;
|
|
145
396
|
getAll(): Array<Mutation>;
|
|
146
397
|
find<TData = unknown, TError = DefaultError, TVariables = any, TContext = unknown>(filters: MutationFilters): Mutation<TData, TError, TVariables, TContext> | undefined;
|
|
@@ -153,7 +404,6 @@ interface MutationConfig<TData, TError, TVariables, TContext> {
|
|
|
153
404
|
mutationId: number;
|
|
154
405
|
mutationCache: MutationCache;
|
|
155
406
|
options: MutationOptions<TData, TError, TVariables, TContext>;
|
|
156
|
-
defaultOptions?: MutationOptions<TData, TError, TVariables, TContext>;
|
|
157
407
|
state?: MutationState<TData, TError, TVariables, TContext>;
|
|
158
408
|
}
|
|
159
409
|
interface MutationState<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> {
|
|
@@ -167,38 +417,39 @@ interface MutationState<TData = unknown, TError = DefaultError, TVariables = voi
|
|
|
167
417
|
variables: TVariables | undefined;
|
|
168
418
|
submittedAt: number;
|
|
169
419
|
}
|
|
170
|
-
interface FailedAction
|
|
420
|
+
interface FailedAction<TError> {
|
|
171
421
|
type: 'failed';
|
|
172
422
|
failureCount: number;
|
|
173
423
|
error: TError | null;
|
|
174
424
|
}
|
|
175
425
|
interface PendingAction<TVariables, TContext> {
|
|
176
426
|
type: 'pending';
|
|
427
|
+
isPaused: boolean;
|
|
177
428
|
variables?: TVariables;
|
|
178
429
|
context?: TContext;
|
|
179
430
|
}
|
|
180
|
-
interface SuccessAction
|
|
431
|
+
interface SuccessAction<TData> {
|
|
181
432
|
type: 'success';
|
|
182
433
|
data: TData;
|
|
183
434
|
}
|
|
184
|
-
interface ErrorAction
|
|
435
|
+
interface ErrorAction<TError> {
|
|
185
436
|
type: 'error';
|
|
186
437
|
error: TError;
|
|
187
438
|
}
|
|
188
|
-
interface PauseAction
|
|
439
|
+
interface PauseAction {
|
|
189
440
|
type: 'pause';
|
|
190
441
|
}
|
|
191
|
-
interface ContinueAction
|
|
442
|
+
interface ContinueAction {
|
|
192
443
|
type: 'continue';
|
|
193
444
|
}
|
|
194
|
-
type Action
|
|
445
|
+
type Action<TData, TError, TVariables, TContext> = ContinueAction | ErrorAction<TError> | FailedAction<TError> | PendingAction<TVariables, TContext> | PauseAction | SuccessAction<TData>;
|
|
195
446
|
declare class Mutation<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends Removable {
|
|
196
447
|
#private;
|
|
197
448
|
state: MutationState<TData, TError, TVariables, TContext>;
|
|
198
449
|
options: MutationOptions<TData, TError, TVariables, TContext>;
|
|
199
450
|
readonly mutationId: number;
|
|
200
451
|
constructor(config: MutationConfig<TData, TError, TVariables, TContext>);
|
|
201
|
-
setOptions(options
|
|
452
|
+
setOptions(options: MutationOptions<TData, TError, TVariables, TContext>): void;
|
|
202
453
|
get meta(): MutationMeta | undefined;
|
|
203
454
|
addObserver(observer: MutationObserver<any, any, any, any>): void;
|
|
204
455
|
removeObserver(observer: MutationObserver<any, any, any, any>): void;
|
|
@@ -219,6 +470,7 @@ interface RetryerConfig<TData = unknown, TError = DefaultError> {
|
|
|
219
470
|
retry?: RetryValue<TError>;
|
|
220
471
|
retryDelay?: RetryDelayValue<TError>;
|
|
221
472
|
networkMode: NetworkMode | undefined;
|
|
473
|
+
canRun: () => boolean;
|
|
222
474
|
}
|
|
223
475
|
interface Retryer<TData = unknown> {
|
|
224
476
|
promise: Promise<TData>;
|
|
@@ -226,6 +478,8 @@ interface Retryer<TData = unknown> {
|
|
|
226
478
|
continue: () => Promise<unknown>;
|
|
227
479
|
cancelRetry: () => void;
|
|
228
480
|
continueRetry: () => void;
|
|
481
|
+
canStart: () => boolean;
|
|
482
|
+
start: () => Promise<TData>;
|
|
229
483
|
}
|
|
230
484
|
type RetryValue<TError> = boolean | number | ShouldRetryFunction<TError>;
|
|
231
485
|
type ShouldRetryFunction<TError = DefaultError> = (failureCount: number, error: TError) => boolean;
|
|
@@ -625,6 +879,9 @@ type DefinedInfiniteQueryObserverResult<TData = unknown, TError = DefaultError>
|
|
|
625
879
|
type InfiniteQueryObserverResult<TData = unknown, TError = DefaultError> = DefinedInfiniteQueryObserverResult<TData, TError> | InfiniteQueryObserverLoadingErrorResult<TData, TError> | InfiniteQueryObserverLoadingResult<TData, TError> | InfiniteQueryObserverPendingResult<TData, TError>;
|
|
626
880
|
type MutationKey = ReadonlyArray<unknown>;
|
|
627
881
|
type MutationStatus = 'idle' | 'pending' | 'success' | 'error';
|
|
882
|
+
type MutationScope = {
|
|
883
|
+
id: string;
|
|
884
|
+
};
|
|
628
885
|
type MutationMeta = Register extends {
|
|
629
886
|
mutationMeta: infer TMutationMeta;
|
|
630
887
|
} ? TMutationMeta extends Record<string, unknown> ? TMutationMeta : Record<string, unknown> : Record<string, unknown>;
|
|
@@ -642,6 +899,7 @@ interface MutationOptions<TData = unknown, TError = DefaultError, TVariables = v
|
|
|
642
899
|
gcTime?: number;
|
|
643
900
|
_defaulted?: boolean;
|
|
644
901
|
meta?: MutationMeta;
|
|
902
|
+
scope?: MutationScope;
|
|
645
903
|
}
|
|
646
904
|
interface MutationObserverOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends MutationOptions<TData, TError, TVariables, TContext> {
|
|
647
905
|
throwOnError?: boolean | ((error: TError) => boolean);
|
|
@@ -722,252 +980,4 @@ interface NotifyEvent {
|
|
|
722
980
|
type: NotifyEventType;
|
|
723
981
|
}
|
|
724
982
|
|
|
725
|
-
type
|
|
726
|
-
interface NotifyOptions {
|
|
727
|
-
listeners?: boolean;
|
|
728
|
-
}
|
|
729
|
-
interface ObserverFetchOptions extends FetchOptions {
|
|
730
|
-
throwOnError?: boolean;
|
|
731
|
-
}
|
|
732
|
-
declare class QueryObserver<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends Subscribable<QueryObserverListener<TData, TError>> {
|
|
733
|
-
#private;
|
|
734
|
-
options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
|
|
735
|
-
constructor(client: QueryClient, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>);
|
|
736
|
-
protected bindMethods(): void;
|
|
737
|
-
protected onSubscribe(): void;
|
|
738
|
-
protected onUnsubscribe(): void;
|
|
739
|
-
shouldFetchOnReconnect(): boolean;
|
|
740
|
-
shouldFetchOnWindowFocus(): boolean;
|
|
741
|
-
destroy(): void;
|
|
742
|
-
setOptions(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, notifyOptions?: NotifyOptions): void;
|
|
743
|
-
getOptimisticResult(options: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
|
|
744
|
-
getCurrentResult(): QueryObserverResult<TData, TError>;
|
|
745
|
-
trackResult(result: QueryObserverResult<TData, TError>, onPropTracked?: (key: keyof QueryObserverResult) => void): QueryObserverResult<TData, TError>;
|
|
746
|
-
trackProp(key: keyof QueryObserverResult): void;
|
|
747
|
-
getCurrentQuery(): Query<TQueryFnData, TError, TQueryData, TQueryKey>;
|
|
748
|
-
refetch({ ...options }?: RefetchOptions): Promise<QueryObserverResult<TData, TError>>;
|
|
749
|
-
fetchOptimistic(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): Promise<QueryObserverResult<TData, TError>>;
|
|
750
|
-
protected fetch(fetchOptions: ObserverFetchOptions): Promise<QueryObserverResult<TData, TError>>;
|
|
751
|
-
protected createResult(query: Query<TQueryFnData, TError, TQueryData, TQueryKey>, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
|
|
752
|
-
updateResult(notifyOptions?: NotifyOptions): void;
|
|
753
|
-
onQueryUpdate(): void;
|
|
754
|
-
}
|
|
755
|
-
|
|
756
|
-
interface QueryConfig<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
|
|
757
|
-
cache: QueryCache;
|
|
758
|
-
queryKey: TQueryKey;
|
|
759
|
-
queryHash: string;
|
|
760
|
-
options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
761
|
-
defaultOptions?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
762
|
-
state?: QueryState<TData, TError>;
|
|
763
|
-
}
|
|
764
|
-
interface QueryState<TData = unknown, TError = DefaultError> {
|
|
765
|
-
data: TData | undefined;
|
|
766
|
-
dataUpdateCount: number;
|
|
767
|
-
dataUpdatedAt: number;
|
|
768
|
-
error: TError | null;
|
|
769
|
-
errorUpdateCount: number;
|
|
770
|
-
errorUpdatedAt: number;
|
|
771
|
-
fetchFailureCount: number;
|
|
772
|
-
fetchFailureReason: TError | null;
|
|
773
|
-
fetchMeta: FetchMeta | null;
|
|
774
|
-
isInvalidated: boolean;
|
|
775
|
-
status: QueryStatus;
|
|
776
|
-
fetchStatus: FetchStatus;
|
|
777
|
-
}
|
|
778
|
-
interface FetchContext<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
|
|
779
|
-
fetchFn: () => unknown | Promise<unknown>;
|
|
780
|
-
fetchOptions?: FetchOptions;
|
|
781
|
-
signal: AbortSignal;
|
|
782
|
-
options: QueryOptions<TQueryFnData, TError, TData, any>;
|
|
783
|
-
queryKey: TQueryKey;
|
|
784
|
-
state: QueryState<TData, TError>;
|
|
785
|
-
}
|
|
786
|
-
interface QueryBehavior<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> {
|
|
787
|
-
onFetch: (context: FetchContext<TQueryFnData, TError, TData, TQueryKey>, query: Query) => void;
|
|
788
|
-
}
|
|
789
|
-
type FetchDirection = 'forward' | 'backward';
|
|
790
|
-
interface FetchMeta {
|
|
791
|
-
fetchMore?: {
|
|
792
|
-
direction: FetchDirection;
|
|
793
|
-
};
|
|
794
|
-
}
|
|
795
|
-
interface FetchOptions {
|
|
796
|
-
cancelRefetch?: boolean;
|
|
797
|
-
meta?: FetchMeta;
|
|
798
|
-
}
|
|
799
|
-
interface FailedAction<TError> {
|
|
800
|
-
type: 'failed';
|
|
801
|
-
failureCount: number;
|
|
802
|
-
error: TError;
|
|
803
|
-
}
|
|
804
|
-
interface FetchAction {
|
|
805
|
-
type: 'fetch';
|
|
806
|
-
meta?: FetchMeta;
|
|
807
|
-
}
|
|
808
|
-
interface SuccessAction<TData> {
|
|
809
|
-
data: TData | undefined;
|
|
810
|
-
type: 'success';
|
|
811
|
-
dataUpdatedAt?: number;
|
|
812
|
-
manual?: boolean;
|
|
813
|
-
}
|
|
814
|
-
interface ErrorAction<TError> {
|
|
815
|
-
type: 'error';
|
|
816
|
-
error: TError;
|
|
817
|
-
}
|
|
818
|
-
interface InvalidateAction {
|
|
819
|
-
type: 'invalidate';
|
|
820
|
-
}
|
|
821
|
-
interface PauseAction {
|
|
822
|
-
type: 'pause';
|
|
823
|
-
}
|
|
824
|
-
interface ContinueAction {
|
|
825
|
-
type: 'continue';
|
|
826
|
-
}
|
|
827
|
-
interface SetStateAction<TData, TError> {
|
|
828
|
-
type: 'setState';
|
|
829
|
-
state: Partial<QueryState<TData, TError>>;
|
|
830
|
-
setStateOptions?: SetStateOptions;
|
|
831
|
-
}
|
|
832
|
-
type Action<TData, TError> = ContinueAction | ErrorAction<TError> | FailedAction<TError> | FetchAction | InvalidateAction | PauseAction | SetStateAction<TData, TError> | SuccessAction<TData>;
|
|
833
|
-
interface SetStateOptions {
|
|
834
|
-
meta?: any;
|
|
835
|
-
}
|
|
836
|
-
declare class Query<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends Removable {
|
|
837
|
-
#private;
|
|
838
|
-
queryKey: TQueryKey;
|
|
839
|
-
queryHash: string;
|
|
840
|
-
options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
841
|
-
state: QueryState<TData, TError>;
|
|
842
|
-
isFetchingOptimistic?: boolean;
|
|
843
|
-
constructor(config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>);
|
|
844
|
-
get meta(): QueryMeta | undefined;
|
|
845
|
-
setOptions(options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>): void;
|
|
846
|
-
protected optionalRemove(): void;
|
|
847
|
-
setData(newData: TData, options?: SetDataOptions & {
|
|
848
|
-
manual: boolean;
|
|
849
|
-
}): TData;
|
|
850
|
-
setState(state: Partial<QueryState<TData, TError>>, setStateOptions?: SetStateOptions): void;
|
|
851
|
-
cancel(options?: CancelOptions): Promise<void>;
|
|
852
|
-
destroy(): void;
|
|
853
|
-
reset(): void;
|
|
854
|
-
isActive(): boolean;
|
|
855
|
-
isDisabled(): boolean;
|
|
856
|
-
isStale(): boolean;
|
|
857
|
-
isStaleByTime(staleTime?: number): boolean;
|
|
858
|
-
onFocus(): void;
|
|
859
|
-
onOnline(): void;
|
|
860
|
-
addObserver(observer: QueryObserver<any, any, any, any, any>): void;
|
|
861
|
-
removeObserver(observer: QueryObserver<any, any, any, any, any>): void;
|
|
862
|
-
getObserversCount(): number;
|
|
863
|
-
invalidate(): void;
|
|
864
|
-
fetch(options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>, fetchOptions?: FetchOptions): Promise<TData>;
|
|
865
|
-
}
|
|
866
|
-
declare function fetchState<TQueryFnData, TError, TData, TQueryKey extends QueryKey>(data: TData | undefined, options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>): {
|
|
867
|
-
readonly error?: null | undefined;
|
|
868
|
-
readonly status?: "pending" | undefined;
|
|
869
|
-
readonly fetchFailureCount: 0;
|
|
870
|
-
readonly fetchFailureReason: null;
|
|
871
|
-
readonly fetchStatus: "fetching" | "paused";
|
|
872
|
-
};
|
|
873
|
-
|
|
874
|
-
interface QueryCacheConfig {
|
|
875
|
-
onError?: (error: DefaultError, query: Query<unknown, unknown, unknown>) => void;
|
|
876
|
-
onSuccess?: (data: unknown, query: Query<unknown, unknown, unknown>) => void;
|
|
877
|
-
onSettled?: (data: unknown | undefined, error: DefaultError | null, query: Query<unknown, unknown, unknown>) => void;
|
|
878
|
-
}
|
|
879
|
-
interface NotifyEventQueryAdded extends NotifyEvent {
|
|
880
|
-
type: 'added';
|
|
881
|
-
query: Query<any, any, any, any>;
|
|
882
|
-
}
|
|
883
|
-
interface NotifyEventQueryRemoved extends NotifyEvent {
|
|
884
|
-
type: 'removed';
|
|
885
|
-
query: Query<any, any, any, any>;
|
|
886
|
-
}
|
|
887
|
-
interface NotifyEventQueryUpdated extends NotifyEvent {
|
|
888
|
-
type: 'updated';
|
|
889
|
-
query: Query<any, any, any, any>;
|
|
890
|
-
action: Action<any, any>;
|
|
891
|
-
}
|
|
892
|
-
interface NotifyEventQueryObserverAdded extends NotifyEvent {
|
|
893
|
-
type: 'observerAdded';
|
|
894
|
-
query: Query<any, any, any, any>;
|
|
895
|
-
observer: QueryObserver<any, any, any, any, any>;
|
|
896
|
-
}
|
|
897
|
-
interface NotifyEventQueryObserverRemoved extends NotifyEvent {
|
|
898
|
-
type: 'observerRemoved';
|
|
899
|
-
query: Query<any, any, any, any>;
|
|
900
|
-
observer: QueryObserver<any, any, any, any, any>;
|
|
901
|
-
}
|
|
902
|
-
interface NotifyEventQueryObserverResultsUpdated extends NotifyEvent {
|
|
903
|
-
type: 'observerResultsUpdated';
|
|
904
|
-
query: Query<any, any, any, any>;
|
|
905
|
-
}
|
|
906
|
-
interface NotifyEventQueryObserverOptionsUpdated extends NotifyEvent {
|
|
907
|
-
type: 'observerOptionsUpdated';
|
|
908
|
-
query: Query<any, any, any, any>;
|
|
909
|
-
observer: QueryObserver<any, any, any, any, any>;
|
|
910
|
-
}
|
|
911
|
-
type QueryCacheNotifyEvent = NotifyEventQueryAdded | NotifyEventQueryRemoved | NotifyEventQueryUpdated | NotifyEventQueryObserverAdded | NotifyEventQueryObserverRemoved | NotifyEventQueryObserverResultsUpdated | NotifyEventQueryObserverOptionsUpdated;
|
|
912
|
-
type QueryCacheListener = (event: QueryCacheNotifyEvent) => void;
|
|
913
|
-
interface QueryStore {
|
|
914
|
-
has: (queryHash: string) => boolean;
|
|
915
|
-
set: (queryHash: string, query: Query) => void;
|
|
916
|
-
get: (queryHash: string) => Query | undefined;
|
|
917
|
-
delete: (queryHash: string) => void;
|
|
918
|
-
values: () => IterableIterator<Query>;
|
|
919
|
-
}
|
|
920
|
-
declare class QueryCache extends Subscribable<QueryCacheListener> {
|
|
921
|
-
#private;
|
|
922
|
-
config: QueryCacheConfig;
|
|
923
|
-
constructor(config?: QueryCacheConfig);
|
|
924
|
-
build<TQueryFnData, TError, TData, TQueryKey extends QueryKey>(client: QueryClient, options: WithRequired<QueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey'>, state?: QueryState<TData, TError>): Query<TQueryFnData, TError, TData, TQueryKey>;
|
|
925
|
-
add(query: Query<any, any, any, any>): void;
|
|
926
|
-
remove(query: Query<any, any, any, any>): void;
|
|
927
|
-
clear(): void;
|
|
928
|
-
get<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryHash: string): Query<TQueryFnData, TError, TData, TQueryKey> | undefined;
|
|
929
|
-
getAll(): Array<Query>;
|
|
930
|
-
find<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData>(filters: WithRequired<QueryFilters, 'queryKey'>): Query<TQueryFnData, TError, TData> | undefined;
|
|
931
|
-
findAll(filters?: QueryFilters): Array<Query>;
|
|
932
|
-
notify(event: QueryCacheNotifyEvent): void;
|
|
933
|
-
onFocus(): void;
|
|
934
|
-
onOnline(): void;
|
|
935
|
-
}
|
|
936
|
-
|
|
937
|
-
declare class QueryClient {
|
|
938
|
-
#private;
|
|
939
|
-
constructor(config?: QueryClientConfig);
|
|
940
|
-
mount(): void;
|
|
941
|
-
unmount(): void;
|
|
942
|
-
isFetching(filters?: QueryFilters): number;
|
|
943
|
-
isMutating(filters?: MutationFilters): number;
|
|
944
|
-
getQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue> ? TaggedValue : TQueryFnData>(queryKey: TTaggedQueryKey): TInferredQueryFnData | undefined;
|
|
945
|
-
ensureQueryData<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>;
|
|
946
|
-
getQueriesData<TQueryFnData = unknown>(filters: QueryFilters): Array<[QueryKey, TQueryFnData | undefined]>;
|
|
947
|
-
setQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue> ? TaggedValue : TQueryFnData>(queryKey: TTaggedQueryKey, updater: Updater<NoInfer<TInferredQueryFnData> | undefined, NoInfer<TInferredQueryFnData> | undefined>, options?: SetDataOptions): TInferredQueryFnData | undefined;
|
|
948
|
-
setQueriesData<TQueryFnData>(filters: QueryFilters, updater: Updater<TQueryFnData | undefined, TQueryFnData | undefined>, options?: SetDataOptions): Array<[QueryKey, TQueryFnData | undefined]>;
|
|
949
|
-
getQueryState<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue> ? TaggedValue : TQueryFnData>(queryKey: TTaggedQueryKey): QueryState<TInferredQueryFnData, TError> | undefined;
|
|
950
|
-
removeQueries(filters?: QueryFilters): void;
|
|
951
|
-
resetQueries(filters?: QueryFilters, options?: ResetOptions): Promise<void>;
|
|
952
|
-
cancelQueries(filters?: QueryFilters, cancelOptions?: CancelOptions): Promise<void>;
|
|
953
|
-
invalidateQueries(filters?: InvalidateQueryFilters, options?: InvalidateOptions): Promise<void>;
|
|
954
|
-
refetchQueries(filters?: RefetchQueryFilters, options?: RefetchOptions): Promise<void>;
|
|
955
|
-
fetchQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<TData>;
|
|
956
|
-
prefetchQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
|
|
957
|
-
fetchInfiniteQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<InfiniteData<TData, TPageParam>>;
|
|
958
|
-
prefetchInfiniteQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<void>;
|
|
959
|
-
resumePausedMutations(): Promise<unknown>;
|
|
960
|
-
getQueryCache(): QueryCache;
|
|
961
|
-
getMutationCache(): MutationCache;
|
|
962
|
-
getDefaultOptions(): DefaultOptions;
|
|
963
|
-
setDefaultOptions(options: DefaultOptions): void;
|
|
964
|
-
setQueryDefaults(queryKey: QueryKey, options: Partial<OmitKeyof<QueryObserverOptions<unknown, any, any, any>, 'queryKey'>>): void;
|
|
965
|
-
getQueryDefaults(queryKey: QueryKey): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'>;
|
|
966
|
-
setMutationDefaults(mutationKey: MutationKey, options: OmitKeyof<MutationObserverOptions<any, any, any, any>, 'mutationKey'>): void;
|
|
967
|
-
getMutationDefaults(mutationKey: MutationKey): MutationObserverOptions<any, any, any, any>;
|
|
968
|
-
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>;
|
|
969
|
-
defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(options?: T): T;
|
|
970
|
-
clear(): void;
|
|
971
|
-
}
|
|
972
|
-
|
|
973
|
-
export { type DefaultedInfiniteQueryObserverOptions as $, type QueryKeyHashFunction as A, type GetNextPageParamFunction as B, CancelledError as C, type DefaultError as D, type InfiniteData as E, type QueryMeta as F, type GetPreviousPageParamFunction as G, type NetworkMode as H, type InitialDataFunction as I, type NotifyOnChangeProps as J, type QueryOptions as K, type InitialPageParam as L, MutationCache as M, type NoInfer as N, type OmitKeyof as O, type PlaceholderDataFunction as P, QueryCache as Q, type Register as R, type SkipToken as S, type InfiniteQueryPageParamsOptions as T, type Updater as U, type ThrowOnError as V, type QueryObserverOptions as W, type WithRequired as X, type Optional as Y, type DefaultedQueryObserverOptions as Z, type InfiniteQueryObserverOptions as _, type QueryCacheNotifyEvent as a, replaceData as a$, type FetchQueryOptions as a0, type EnsureQueryDataOptions as a1, type FetchInfiniteQueryOptions as a2, type ResultOptions as a3, type RefetchOptions as a4, type InvalidateQueryFilters as a5, type RefetchQueryFilters as a6, type InvalidateOptions as a7, type ResetOptions as a8, type FetchNextPageOptions as a9, type MutateFunction as aA, type MutationObserverBaseResult as aB, type MutationObserverIdleResult as aC, type MutationObserverLoadingResult as aD, type MutationObserverErrorResult as aE, type MutationObserverSuccessResult as aF, type MutationObserverResult as aG, type QueryClientConfig as aH, type DefaultOptions as aI, type CancelOptions as aJ, type SetDataOptions as aK, type NotifyEventType as aL, type NotifyEvent as aM, type QueryBehavior as aN, type ObserverFetchOptions as aO, type NotifyOptions as aP, type QueryTypeFilter as aQ, noop as aR, functionalUpdate as aS, isValidTimeout as aT, timeUntilStale as aU, hashQueryKeyByOptions as aV, partialMatchKey as aW, shallowEqualObjects as aX, isPlainArray as aY, isPlainObject as aZ, sleep as a_, type FetchPreviousPageOptions as aa, type QueryStatus as ab, type FetchStatus as ac, type QueryObserverBaseResult as ad, type QueryObserverPendingResult as ae, type QueryObserverLoadingResult as af, type QueryObserverLoadingErrorResult as ag, type QueryObserverRefetchErrorResult as ah, type QueryObserverSuccessResult as ai, type DefinedQueryObserverResult as aj, type QueryObserverResult as ak, type InfiniteQueryObserverBaseResult as al, type InfiniteQueryObserverPendingResult as am, type InfiniteQueryObserverLoadingResult as an, type InfiniteQueryObserverLoadingErrorResult as ao, type InfiniteQueryObserverRefetchErrorResult as ap, type InfiniteQueryObserverSuccessResult as aq, type DefinedInfiniteQueryObserverResult as ar, type InfiniteQueryObserverResult as as, type MutationKey as at, type MutationStatus as au, type MutationMeta as av, type MutationFunction as aw, type MutationOptions as ax, type MutationObserverOptions as ay, type MutateOptions as az, QueryClient as b, addToEnd as b0, addToStart as b1, type Action$1 as b2, getDefaultState as b3, type Retryer as b4, type RetryValue as b5, type RetryDelayValue as b6, canFetch as b7, createRetryer as b8, type FetchContext as b9, type FetchDirection as ba, type FetchMeta as bb, type FetchOptions as bc, type Action as bd, type SetStateOptions as be, fetchState as bf, type QueryStore as bg, QueryObserver as c, type MutationCacheNotifyEvent as d, MutationObserver as e, matchMutation as f, type MutationFilters as g, hashKey as h, isServer as i, type QueryFilters as j, keepPreviousData as k, isCancelledError as l, matchQuery as m, type QueryState as n, Query as o, Mutation as p, type MutationState as q, replaceEqualDeep as r, skipToken as s, type QueryKey as t, dataTagSymbol as u, type DataTag as v, type QueryFunction as w, type QueryPersister as x, type QueryFunctionContext as y, type QueriesPlaceholderDataFunction as z };
|
|
983
|
+
export { type DefaultedInfiniteQueryObserverOptions as $, type QueryKeyHashFunction as A, type GetNextPageParamFunction as B, CancelledError as C, type DefaultError as D, type InfiniteData as E, type QueryMeta as F, type GetPreviousPageParamFunction as G, type NetworkMode as H, type InitialDataFunction as I, type NotifyOnChangeProps as J, type QueryOptions as K, type InitialPageParam as L, MutationCache as M, type NoInfer as N, type OmitKeyof as O, type PlaceholderDataFunction as P, QueryCache as Q, type Register as R, type SkipToken as S, type InfiniteQueryPageParamsOptions as T, type Updater as U, type ThrowOnError as V, type QueryObserverOptions as W, type WithRequired as X, type Optional as Y, type DefaultedQueryObserverOptions as Z, type InfiniteQueryObserverOptions as _, type QueryCacheNotifyEvent as a, isValidTimeout as a$, type FetchQueryOptions as a0, type EnsureQueryDataOptions as a1, type FetchInfiniteQueryOptions as a2, type ResultOptions as a3, type RefetchOptions as a4, type InvalidateQueryFilters as a5, type RefetchQueryFilters as a6, type InvalidateOptions as a7, type ResetOptions as a8, type FetchNextPageOptions as a9, type MutateOptions as aA, type MutateFunction as aB, type MutationObserverBaseResult as aC, type MutationObserverIdleResult as aD, type MutationObserverLoadingResult as aE, type MutationObserverErrorResult as aF, type MutationObserverSuccessResult as aG, type MutationObserverResult as aH, type QueryClientConfig as aI, type DefaultOptions as aJ, type CancelOptions as aK, type SetDataOptions as aL, type NotifyEventType as aM, type NotifyEvent as aN, type QueryBehavior as aO, type ObserverFetchOptions as aP, type NotifyOptions as aQ, type FetchContext as aR, type FetchDirection as aS, type FetchMeta as aT, type FetchOptions as aU, type Action$1 as aV, type SetStateOptions as aW, fetchState as aX, type QueryTypeFilter as aY, noop as aZ, functionalUpdate as a_, type FetchPreviousPageOptions as aa, type QueryStatus as ab, type FetchStatus as ac, type QueryObserverBaseResult as ad, type QueryObserverPendingResult as ae, type QueryObserverLoadingResult as af, type QueryObserverLoadingErrorResult as ag, type QueryObserverRefetchErrorResult as ah, type QueryObserverSuccessResult as ai, type DefinedQueryObserverResult as aj, type QueryObserverResult as ak, type InfiniteQueryObserverBaseResult as al, type InfiniteQueryObserverPendingResult as am, type InfiniteQueryObserverLoadingResult as an, type InfiniteQueryObserverLoadingErrorResult as ao, type InfiniteQueryObserverRefetchErrorResult as ap, type InfiniteQueryObserverSuccessResult as aq, type DefinedInfiniteQueryObserverResult as ar, type InfiniteQueryObserverResult as as, type MutationKey as at, type MutationStatus as au, type MutationScope as av, type MutationMeta as aw, type MutationFunction as ax, type MutationOptions as ay, type MutationObserverOptions as az, QueryClient as b, timeUntilStale as b0, hashQueryKeyByOptions as b1, partialMatchKey as b2, shallowEqualObjects as b3, isPlainArray as b4, isPlainObject as b5, sleep as b6, replaceData as b7, addToEnd as b8, addToStart as b9, type QueryStore as ba, type Action as bb, getDefaultState as bc, type Retryer as bd, type RetryValue as be, type RetryDelayValue as bf, canFetch as bg, createRetryer as bh, QueryObserver as c, type MutationCacheNotifyEvent as d, MutationObserver as e, matchMutation as f, type MutationFilters as g, hashKey as h, isServer as i, type QueryFilters as j, keepPreviousData as k, isCancelledError as l, matchQuery as m, type QueryState as n, Query as o, Mutation as p, type MutationState as q, replaceEqualDeep as r, skipToken as s, type QueryKey as t, dataTagSymbol as u, type DataTag as v, type QueryFunction as w, type QueryPersister as x, type QueryFunctionContext as y, type QueriesPlaceholderDataFunction as z };
|