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