@tanstack/query-core 5.94.4 → 5.94.5

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.
Files changed (295) hide show
  1. package/build/legacy/_tsup-dts-rollup.d.cts +2229 -0
  2. package/build/legacy/_tsup-dts-rollup.d.ts +2229 -0
  3. package/build/legacy/chunk-PXG64RU4.js +25 -0
  4. package/build/legacy/chunk-PXG64RU4.js.map +1 -0
  5. package/build/legacy/environmentManager.cjs +48 -0
  6. package/build/legacy/environmentManager.cjs.map +1 -0
  7. package/build/legacy/environmentManager.d.cts +2 -0
  8. package/build/legacy/environmentManager.d.ts +2 -0
  9. package/build/legacy/environmentManager.js +25 -0
  10. package/build/legacy/environmentManager.js.map +1 -0
  11. package/build/legacy/focusManager.cjs +107 -0
  12. package/build/legacy/focusManager.cjs.map +1 -0
  13. package/build/legacy/focusManager.d.cts +2 -0
  14. package/build/legacy/focusManager.d.ts +2 -0
  15. package/build/legacy/focusManager.js +80 -0
  16. package/build/legacy/focusManager.js.map +1 -0
  17. package/build/legacy/hydration.cjs +178 -0
  18. package/build/legacy/hydration.cjs.map +1 -0
  19. package/build/legacy/hydration.d.cts +7 -0
  20. package/build/legacy/hydration.d.ts +7 -0
  21. package/build/legacy/hydration.js +152 -0
  22. package/build/legacy/hydration.js.map +1 -0
  23. package/build/legacy/index.cjs +113 -0
  24. package/build/legacy/index.cjs.map +1 -0
  25. package/build/legacy/index.d.cts +142 -0
  26. package/build/legacy/index.d.ts +142 -0
  27. package/build/legacy/index.js +75 -0
  28. package/build/legacy/index.js.map +1 -0
  29. package/build/legacy/infiniteQueryBehavior.cjs +146 -0
  30. package/build/legacy/infiniteQueryBehavior.cjs.map +1 -0
  31. package/build/legacy/infiniteQueryBehavior.d.cts +3 -0
  32. package/build/legacy/infiniteQueryBehavior.d.ts +3 -0
  33. package/build/legacy/infiniteQueryBehavior.js +126 -0
  34. package/build/legacy/infiniteQueryBehavior.js.map +1 -0
  35. package/build/legacy/infiniteQueryObserver.cjs +93 -0
  36. package/build/legacy/infiniteQueryObserver.cjs.map +1 -0
  37. package/build/legacy/infiniteQueryObserver.d.cts +1 -0
  38. package/build/legacy/infiniteQueryObserver.d.ts +1 -0
  39. package/build/legacy/infiniteQueryObserver.js +74 -0
  40. package/build/legacy/infiniteQueryObserver.js.map +1 -0
  41. package/build/legacy/mutation.cjs +333 -0
  42. package/build/legacy/mutation.cjs.map +1 -0
  43. package/build/legacy/mutation.d.cts +4 -0
  44. package/build/legacy/mutation.d.ts +4 -0
  45. package/build/legacy/mutation.js +306 -0
  46. package/build/legacy/mutation.js.map +1 -0
  47. package/build/legacy/mutationCache.cjs +170 -0
  48. package/build/legacy/mutationCache.cjs.map +1 -0
  49. package/build/legacy/mutationCache.d.cts +2 -0
  50. package/build/legacy/mutationCache.d.ts +2 -0
  51. package/build/legacy/mutationCache.js +137 -0
  52. package/build/legacy/mutationCache.js.map +1 -0
  53. package/build/legacy/mutationObserver.cjs +190 -0
  54. package/build/legacy/mutationObserver.cjs.map +1 -0
  55. package/build/legacy/mutationObserver.d.cts +1 -0
  56. package/build/legacy/mutationObserver.d.ts +1 -0
  57. package/build/legacy/mutationObserver.js +164 -0
  58. package/build/legacy/mutationObserver.js.map +1 -0
  59. package/build/legacy/notifyManager.cjs +113 -0
  60. package/build/legacy/notifyManager.cjs.map +1 -0
  61. package/build/legacy/notifyManager.d.cts +3 -0
  62. package/build/legacy/notifyManager.d.ts +3 -0
  63. package/build/legacy/notifyManager.js +88 -0
  64. package/build/legacy/notifyManager.js.map +1 -0
  65. package/build/legacy/onlineManager.cjs +96 -0
  66. package/build/legacy/onlineManager.cjs.map +1 -0
  67. package/build/legacy/onlineManager.d.cts +2 -0
  68. package/build/legacy/onlineManager.d.ts +2 -0
  69. package/build/legacy/onlineManager.js +69 -0
  70. package/build/legacy/onlineManager.js.map +1 -0
  71. package/build/legacy/queriesObserver.cjs +260 -0
  72. package/build/legacy/queriesObserver.cjs.map +1 -0
  73. package/build/legacy/queriesObserver.d.cts +2 -0
  74. package/build/legacy/queriesObserver.d.ts +2 -0
  75. package/build/legacy/queriesObserver.js +234 -0
  76. package/build/legacy/queriesObserver.js.map +1 -0
  77. package/build/legacy/query.cjs +487 -0
  78. package/build/legacy/query.cjs.map +1 -0
  79. package/build/legacy/query.d.cts +10 -0
  80. package/build/legacy/query.d.ts +10 -0
  81. package/build/legacy/query.js +468 -0
  82. package/build/legacy/query.js.map +1 -0
  83. package/build/legacy/queryCache.cjs +131 -0
  84. package/build/legacy/queryCache.cjs.map +1 -0
  85. package/build/legacy/queryCache.d.cts +3 -0
  86. package/build/legacy/queryCache.d.ts +3 -0
  87. package/build/legacy/queryCache.js +105 -0
  88. package/build/legacy/queryCache.js.map +1 -0
  89. package/build/legacy/queryClient.cjs +349 -0
  90. package/build/legacy/queryClient.cjs.map +1 -0
  91. package/build/legacy/queryClient.d.cts +1 -0
  92. package/build/legacy/queryClient.d.ts +1 -0
  93. package/build/legacy/queryClient.js +324 -0
  94. package/build/legacy/queryClient.js.map +1 -0
  95. package/build/legacy/queryObserver.cjs +516 -0
  96. package/build/legacy/queryObserver.cjs.map +1 -0
  97. package/build/legacy/queryObserver.d.cts +1 -0
  98. package/build/legacy/queryObserver.d.ts +1 -0
  99. package/build/legacy/queryObserver.js +498 -0
  100. package/build/legacy/queryObserver.js.map +1 -0
  101. package/build/legacy/removable.cjs +70 -0
  102. package/build/legacy/removable.cjs.map +1 -0
  103. package/build/legacy/removable.d.cts +1 -0
  104. package/build/legacy/removable.d.ts +1 -0
  105. package/build/legacy/removable.js +44 -0
  106. package/build/legacy/removable.js.map +1 -0
  107. package/build/legacy/retryer.cjs +166 -0
  108. package/build/legacy/retryer.cjs.map +1 -0
  109. package/build/legacy/retryer.d.cts +7 -0
  110. package/build/legacy/retryer.d.ts +7 -0
  111. package/build/legacy/retryer.js +140 -0
  112. package/build/legacy/retryer.js.map +1 -0
  113. package/build/legacy/streamedQuery.cjs +80 -0
  114. package/build/legacy/streamedQuery.cjs.map +1 -0
  115. package/build/legacy/streamedQuery.d.cts +1 -0
  116. package/build/legacy/streamedQuery.d.ts +1 -0
  117. package/build/legacy/streamedQuery.js +57 -0
  118. package/build/legacy/streamedQuery.js.map +1 -0
  119. package/build/legacy/subscribable.cjs +51 -0
  120. package/build/legacy/subscribable.cjs.map +1 -0
  121. package/build/legacy/subscribable.d.cts +1 -0
  122. package/build/legacy/subscribable.d.ts +1 -0
  123. package/build/legacy/subscribable.js +28 -0
  124. package/build/legacy/subscribable.js.map +1 -0
  125. package/build/legacy/thenable.cjs +76 -0
  126. package/build/legacy/thenable.cjs.map +1 -0
  127. package/build/legacy/thenable.d.cts +6 -0
  128. package/build/legacy/thenable.d.ts +6 -0
  129. package/build/legacy/thenable.js +52 -0
  130. package/build/legacy/thenable.js.map +1 -0
  131. package/build/legacy/timeoutManager.cjs +110 -0
  132. package/build/legacy/timeoutManager.cjs.map +1 -0
  133. package/build/legacy/timeoutManager.d.cts +7 -0
  134. package/build/legacy/timeoutManager.d.ts +7 -0
  135. package/build/legacy/timeoutManager.js +81 -0
  136. package/build/legacy/timeoutManager.js.map +1 -0
  137. package/build/legacy/types.cjs +37 -0
  138. package/build/legacy/types.cjs.map +1 -0
  139. package/build/legacy/types.d.cts +95 -0
  140. package/build/legacy/types.d.ts +95 -0
  141. package/build/legacy/types.js +12 -0
  142. package/build/legacy/types.js.map +1 -0
  143. package/build/legacy/utils.cjs +330 -0
  144. package/build/legacy/utils.cjs.map +1 -0
  145. package/build/legacy/utils.d.cts +30 -0
  146. package/build/legacy/utils.d.ts +30 -0
  147. package/build/legacy/utils.js +283 -0
  148. package/build/legacy/utils.js.map +1 -0
  149. package/build/modern/_tsup-dts-rollup.d.cts +2229 -0
  150. package/build/modern/_tsup-dts-rollup.d.ts +2229 -0
  151. package/build/modern/environmentManager.cjs +48 -0
  152. package/build/modern/environmentManager.cjs.map +1 -0
  153. package/build/modern/environmentManager.d.cts +2 -0
  154. package/build/modern/environmentManager.d.ts +2 -0
  155. package/build/modern/environmentManager.js +23 -0
  156. package/build/modern/environmentManager.js.map +1 -0
  157. package/build/modern/focusManager.cjs +93 -0
  158. package/build/modern/focusManager.cjs.map +1 -0
  159. package/build/modern/focusManager.d.cts +2 -0
  160. package/build/modern/focusManager.d.ts +2 -0
  161. package/build/modern/focusManager.js +67 -0
  162. package/build/modern/focusManager.js.map +1 -0
  163. package/build/modern/hydration.cjs +173 -0
  164. package/build/modern/hydration.cjs.map +1 -0
  165. package/build/modern/hydration.d.cts +7 -0
  166. package/build/modern/hydration.d.ts +7 -0
  167. package/build/modern/hydration.js +145 -0
  168. package/build/modern/hydration.js.map +1 -0
  169. package/build/modern/index.cjs +113 -0
  170. package/build/modern/index.cjs.map +1 -0
  171. package/build/modern/index.d.cts +142 -0
  172. package/build/modern/index.d.ts +142 -0
  173. package/build/modern/index.js +73 -0
  174. package/build/modern/index.js.map +1 -0
  175. package/build/modern/infiniteQueryBehavior.cjs +142 -0
  176. package/build/modern/infiniteQueryBehavior.cjs.map +1 -0
  177. package/build/modern/infiniteQueryBehavior.d.cts +3 -0
  178. package/build/modern/infiniteQueryBehavior.d.ts +3 -0
  179. package/build/modern/infiniteQueryBehavior.js +120 -0
  180. package/build/modern/infiniteQueryBehavior.js.map +1 -0
  181. package/build/modern/infiniteQueryObserver.cjs +92 -0
  182. package/build/modern/infiniteQueryObserver.cjs.map +1 -0
  183. package/build/modern/infiniteQueryObserver.d.cts +1 -0
  184. package/build/modern/infiniteQueryObserver.d.ts +1 -0
  185. package/build/modern/infiniteQueryObserver.js +71 -0
  186. package/build/modern/infiniteQueryObserver.js.map +1 -0
  187. package/build/modern/mutation.cjs +307 -0
  188. package/build/modern/mutation.cjs.map +1 -0
  189. package/build/modern/mutation.d.cts +4 -0
  190. package/build/modern/mutation.d.ts +4 -0
  191. package/build/modern/mutation.js +281 -0
  192. package/build/modern/mutation.js.map +1 -0
  193. package/build/modern/mutationCache.cjs +149 -0
  194. package/build/modern/mutationCache.cjs.map +1 -0
  195. package/build/modern/mutationCache.d.cts +2 -0
  196. package/build/modern/mutationCache.d.ts +2 -0
  197. package/build/modern/mutationCache.js +124 -0
  198. package/build/modern/mutationCache.js.map +1 -0
  199. package/build/modern/mutationObserver.cjs +165 -0
  200. package/build/modern/mutationObserver.cjs.map +1 -0
  201. package/build/modern/mutationObserver.d.cts +1 -0
  202. package/build/modern/mutationObserver.d.ts +1 -0
  203. package/build/modern/mutationObserver.js +140 -0
  204. package/build/modern/mutationObserver.js.map +1 -0
  205. package/build/modern/notifyManager.cjs +113 -0
  206. package/build/modern/notifyManager.cjs.map +1 -0
  207. package/build/modern/notifyManager.d.cts +3 -0
  208. package/build/modern/notifyManager.d.ts +3 -0
  209. package/build/modern/notifyManager.js +86 -0
  210. package/build/modern/notifyManager.js.map +1 -0
  211. package/build/modern/onlineManager.cjs +83 -0
  212. package/build/modern/onlineManager.cjs.map +1 -0
  213. package/build/modern/onlineManager.d.cts +2 -0
  214. package/build/modern/onlineManager.d.ts +2 -0
  215. package/build/modern/onlineManager.js +57 -0
  216. package/build/modern/onlineManager.js.map +1 -0
  217. package/build/modern/queriesObserver.cjs +237 -0
  218. package/build/modern/queriesObserver.cjs.map +1 -0
  219. package/build/modern/queriesObserver.d.cts +2 -0
  220. package/build/modern/queriesObserver.d.ts +2 -0
  221. package/build/modern/queriesObserver.js +212 -0
  222. package/build/modern/queriesObserver.js.map +1 -0
  223. package/build/modern/query.cjs +461 -0
  224. package/build/modern/query.cjs.map +1 -0
  225. package/build/modern/query.d.cts +10 -0
  226. package/build/modern/query.d.ts +10 -0
  227. package/build/modern/query.js +443 -0
  228. package/build/modern/query.js.map +1 -0
  229. package/build/modern/queryCache.cjs +122 -0
  230. package/build/modern/queryCache.cjs.map +1 -0
  231. package/build/modern/queryCache.d.cts +3 -0
  232. package/build/modern/queryCache.d.ts +3 -0
  233. package/build/modern/queryCache.js +97 -0
  234. package/build/modern/queryCache.js.map +1 -0
  235. package/build/modern/queryClient.cjs +322 -0
  236. package/build/modern/queryClient.cjs.map +1 -0
  237. package/build/modern/queryClient.d.cts +1 -0
  238. package/build/modern/queryClient.d.ts +1 -0
  239. package/build/modern/queryClient.js +305 -0
  240. package/build/modern/queryClient.js.map +1 -0
  241. package/build/modern/queryObserver.cjs +489 -0
  242. package/build/modern/queryObserver.cjs.map +1 -0
  243. package/build/modern/queryObserver.d.cts +1 -0
  244. package/build/modern/queryObserver.d.ts +1 -0
  245. package/build/modern/queryObserver.js +472 -0
  246. package/build/modern/queryObserver.js.map +1 -0
  247. package/build/modern/removable.cjs +59 -0
  248. package/build/modern/removable.cjs.map +1 -0
  249. package/build/modern/removable.d.cts +1 -0
  250. package/build/modern/removable.d.ts +1 -0
  251. package/build/modern/removable.js +34 -0
  252. package/build/modern/removable.js.map +1 -0
  253. package/build/modern/retryer.cjs +162 -0
  254. package/build/modern/retryer.cjs.map +1 -0
  255. package/build/modern/retryer.d.cts +7 -0
  256. package/build/modern/retryer.d.ts +7 -0
  257. package/build/modern/retryer.js +134 -0
  258. package/build/modern/retryer.js.map +1 -0
  259. package/build/modern/streamedQuery.cjs +80 -0
  260. package/build/modern/streamedQuery.cjs.map +1 -0
  261. package/build/modern/streamedQuery.d.cts +1 -0
  262. package/build/modern/streamedQuery.d.ts +1 -0
  263. package/build/modern/streamedQuery.js +55 -0
  264. package/build/modern/streamedQuery.js.map +1 -0
  265. package/build/modern/subscribable.cjs +51 -0
  266. package/build/modern/subscribable.cjs.map +1 -0
  267. package/build/modern/subscribable.d.cts +1 -0
  268. package/build/modern/subscribable.d.ts +1 -0
  269. package/build/modern/subscribable.js +26 -0
  270. package/build/modern/subscribable.js.map +1 -0
  271. package/build/modern/thenable.cjs +75 -0
  272. package/build/modern/thenable.cjs.map +1 -0
  273. package/build/modern/thenable.d.cts +6 -0
  274. package/build/modern/thenable.d.ts +6 -0
  275. package/build/modern/thenable.js +49 -0
  276. package/build/modern/thenable.js.map +1 -0
  277. package/build/modern/timeoutManager.cjs +98 -0
  278. package/build/modern/timeoutManager.cjs.map +1 -0
  279. package/build/modern/timeoutManager.d.cts +7 -0
  280. package/build/modern/timeoutManager.d.ts +7 -0
  281. package/build/modern/timeoutManager.js +70 -0
  282. package/build/modern/timeoutManager.js.map +1 -0
  283. package/build/modern/types.cjs +37 -0
  284. package/build/modern/types.cjs.map +1 -0
  285. package/build/modern/types.d.cts +95 -0
  286. package/build/modern/types.d.ts +95 -0
  287. package/build/modern/types.js +10 -0
  288. package/build/modern/types.js.map +1 -0
  289. package/build/modern/utils.cjs +330 -0
  290. package/build/modern/utils.cjs.map +1 -0
  291. package/build/modern/utils.d.cts +30 -0
  292. package/build/modern/utils.d.ts +30 -0
  293. package/build/modern/utils.js +281 -0
  294. package/build/modern/utils.js.map +1 -0
  295. package/package.json +1 -1
@@ -0,0 +1,2229 @@
1
+ import type { MockInstance } from 'vitest';
2
+ import { Options } from 'tsup';
3
+ import { UserConfig } from 'vite';
4
+
5
+ export declare type Action<TData, TError, TVariables, TOnMutateResult> = ContinueAction_2 | ErrorAction_2<TError> | FailedAction_2<TError> | PendingAction<TVariables, TOnMutateResult> | PauseAction_2 | SuccessAction_2<TData>;
6
+
7
+ export declare type Action_alias_1<TData, TError> = ContinueAction | ErrorAction<TError> | FailedAction<TError> | FetchAction | InvalidateAction | PauseAction | SetStateAction<TData, TError> | SuccessAction<TData>;
8
+
9
+ export declare function addConsumeAwareSignal<T>(object: T, getSignal: () => AbortSignal, onCancelled: VoidFunction): T & {
10
+ signal: AbortSignal;
11
+ };
12
+
13
+ export declare function addToEnd<T>(items: Array<T>, item: T, max?: number): Array<T>;
14
+
15
+ export declare function addToStart<T>(items: Array<T>, item: T, max?: number): Array<T>;
16
+
17
+ declare type AnyDataTag = {
18
+ [dataTagSymbol]: any;
19
+ [dataTagErrorSymbol]: any;
20
+ };
21
+ export { AnyDataTag }
22
+ export { AnyDataTag as AnyDataTag_alias_1 }
23
+
24
+ declare type BaseStreamedQueryParams<TQueryFnData, TQueryKey extends QueryKey> = {
25
+ streamFn: (context: QueryFunctionContext<TQueryKey>) => AsyncIterable<TQueryFnData> | Promise<AsyncIterable<TQueryFnData>>;
26
+ refetchMode?: 'append' | 'reset' | 'replace';
27
+ };
28
+
29
+ declare type BatchCallsCallback<T extends Array<unknown>> = (...args: T) => void;
30
+
31
+ declare type BatchNotifyFunction = (callback: () => void) => void;
32
+
33
+ declare class CancelledError extends Error {
34
+ revert?: boolean;
35
+ silent?: boolean;
36
+ constructor(options?: CancelOptions);
37
+ }
38
+ export { CancelledError }
39
+ export { CancelledError as CancelledError_alias_1 }
40
+
41
+ declare interface CancelOptions {
42
+ revert?: boolean;
43
+ silent?: boolean;
44
+ }
45
+ export { CancelOptions }
46
+ export { CancelOptions as CancelOptions_alias_1 }
47
+
48
+ export declare function canFetch(networkMode: NetworkMode | undefined): boolean;
49
+
50
+ declare type CombineFn<TCombinedResult> = (result: Array<QueryObserverResult>) => TCombinedResult;
51
+
52
+ declare interface ContinueAction {
53
+ type: 'continue';
54
+ }
55
+
56
+ declare interface ContinueAction_2 {
57
+ type: 'continue';
58
+ }
59
+
60
+ export declare function createNotifyManager(): {
61
+ readonly batch: <T>(callback: () => T) => T;
62
+ /**
63
+ * All calls to the wrapped function will be batched.
64
+ */
65
+ readonly batchCalls: <T extends Array<unknown>>(callback: BatchCallsCallback<T>) => BatchCallsCallback<T>;
66
+ readonly schedule: (callback: NotifyCallback) => void;
67
+ /**
68
+ * Use this method to set a custom notify function.
69
+ * This can be used to for example wrap notifications with `React.act` while running tests.
70
+ */
71
+ readonly setNotifyFunction: (fn: NotifyFunction) => void;
72
+ /**
73
+ * Use this method to set a custom function to batch notifications together into a single tick.
74
+ * By default React Query will use the batch function provided by ReactDOM or React Native.
75
+ */
76
+ readonly setBatchNotifyFunction: (fn: BatchNotifyFunction) => void;
77
+ readonly setScheduler: (fn: ScheduleFunction) => void;
78
+ };
79
+
80
+ export declare function createRetryer<TData = unknown, TError = DefaultError>(config: RetryerConfig<TData, TError>): Retryer<TData>;
81
+
82
+ declare type DataTag<TType, TValue, TError = UnsetMarker> = TType extends AnyDataTag ? TType : TType & {
83
+ [dataTagSymbol]: TValue;
84
+ [dataTagErrorSymbol]: TError;
85
+ };
86
+ export { DataTag }
87
+ export { DataTag as DataTag_alias_1 }
88
+
89
+ declare const dataTagErrorSymbol: unique symbol;
90
+
91
+ declare type dataTagErrorSymbol = typeof dataTagErrorSymbol;
92
+ export { dataTagErrorSymbol }
93
+ export { dataTagErrorSymbol as dataTagErrorSymbol_alias_1 }
94
+
95
+ declare const dataTagSymbol: unique symbol;
96
+
97
+ declare type dataTagSymbol = typeof dataTagSymbol;
98
+ export { dataTagSymbol }
99
+ export { dataTagSymbol as dataTagSymbol_alias_1 }
100
+
101
+ export declare const default_alias: any[];
102
+
103
+ export declare const default_alias_1: any[];
104
+
105
+ export declare const default_alias_2: Options | Options[] | ((overrideOptions: Options) => Options | Options[] | Promise<Options | Options[]>);
106
+
107
+ export declare const default_alias_3: UserConfig;
108
+
109
+ declare type DefaultedInfiniteQueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = WithRequired<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'throwOnError' | 'refetchOnReconnect' | 'queryHash'>;
110
+ export { DefaultedInfiniteQueryObserverOptions }
111
+ export { DefaultedInfiniteQueryObserverOptions as DefaultedInfiniteQueryObserverOptions_alias_1 }
112
+
113
+ declare type DefaultedQueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = WithRequired<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'throwOnError' | 'refetchOnReconnect' | 'queryHash'>;
114
+ export { DefaultedQueryObserverOptions }
115
+ export { DefaultedQueryObserverOptions as DefaultedQueryObserverOptions_alias_1 }
116
+
117
+ declare type DefaultError = Register extends {
118
+ defaultError: infer TError;
119
+ } ? TError : Error;
120
+ export { DefaultError }
121
+ export { DefaultError as DefaultError_alias_1 }
122
+
123
+ declare interface DefaultOptions<TError = DefaultError> {
124
+ queries?: OmitKeyof<QueryObserverOptions<unknown, TError>, 'suspense' | 'queryKey'>;
125
+ mutations?: MutationObserverOptions<unknown, TError, unknown, unknown>;
126
+ hydrate?: HydrateOptions['defaultOptions'];
127
+ dehydrate?: DehydrateOptions;
128
+ }
129
+ export { DefaultOptions }
130
+ export { DefaultOptions as DefaultOptions_alias_1 }
131
+
132
+ declare const defaultScheduler: ScheduleFunction;
133
+ export { defaultScheduler }
134
+ export { defaultScheduler as defaultScheduler_alias_1 }
135
+
136
+ declare function defaultShouldDehydrateMutation(mutation: Mutation): boolean;
137
+ export { defaultShouldDehydrateMutation }
138
+ export { defaultShouldDehydrateMutation as defaultShouldDehydrateMutation_alias_1 }
139
+
140
+ declare function defaultShouldDehydrateQuery(query: Query): boolean;
141
+ export { defaultShouldDehydrateQuery }
142
+ export { defaultShouldDehydrateQuery as defaultShouldDehydrateQuery_alias_1 }
143
+
144
+ export declare const defaultTimeoutProvider: TimeoutProvider<ReturnType<typeof setTimeout>>;
145
+
146
+ declare type DefinedInfiniteQueryObserverResult<TData = unknown, TError = DefaultError> = InfiniteQueryObserverRefetchErrorResult<TData, TError> | InfiniteQueryObserverSuccessResult<TData, TError>;
147
+ export { DefinedInfiniteQueryObserverResult }
148
+ export { DefinedInfiniteQueryObserverResult as DefinedInfiniteQueryObserverResult_alias_1 }
149
+
150
+ declare type DefinedQueryObserverResult<TData = unknown, TError = DefaultError> = QueryObserverRefetchErrorResult<TData, TError> | QueryObserverSuccessResult<TData, TError>;
151
+ export { DefinedQueryObserverResult }
152
+ export { DefinedQueryObserverResult as DefinedQueryObserverResult_alias_1 }
153
+
154
+ declare function dehydrate(client: QueryClient, options?: DehydrateOptions): DehydratedState;
155
+ export { dehydrate }
156
+ export { dehydrate as dehydrate_alias_1 }
157
+
158
+ declare interface DehydratedMutation {
159
+ mutationKey?: MutationKey;
160
+ state: MutationState;
161
+ meta?: MutationMeta;
162
+ scope?: MutationScope;
163
+ }
164
+
165
+ declare interface DehydratedQuery {
166
+ queryHash: string;
167
+ queryKey: QueryKey;
168
+ state: QueryState;
169
+ promise?: Promise<unknown>;
170
+ meta?: QueryMeta;
171
+ dehydratedAt?: number;
172
+ }
173
+
174
+ declare interface DehydratedState {
175
+ mutations: Array<DehydratedMutation>;
176
+ queries: Array<DehydratedQuery>;
177
+ }
178
+ export { DehydratedState }
179
+ export { DehydratedState as DehydratedState_alias_1 }
180
+
181
+ declare interface DehydrateOptions {
182
+ serializeData?: TransformerFn;
183
+ shouldDehydrateMutation?: (mutation: Mutation) => boolean;
184
+ shouldDehydrateQuery?: (query: Query) => boolean;
185
+ shouldRedactErrors?: (error: unknown) => boolean;
186
+ }
187
+ export { DehydrateOptions }
188
+ export { DehydrateOptions as DehydrateOptions_alias_1 }
189
+
190
+ declare type DistributiveOmit<TObject, TKey extends keyof TObject> = TObject extends any ? Omit<TObject, TKey> : never;
191
+ export { DistributiveOmit }
192
+ export { DistributiveOmit as DistributiveOmit_alias_1 }
193
+
194
+ declare type DropLast<T extends ReadonlyArray<unknown>> = T extends readonly [
195
+ ...infer R,
196
+ unknown
197
+ ] ? readonly [...R] : never;
198
+
199
+ declare type Enabled<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = boolean | ((query: Query<TQueryFnData, TError, TData, TQueryKey>) => boolean);
200
+ export { Enabled }
201
+ export { Enabled as Enabled_alias_1 }
202
+
203
+ declare type EnsureInfiniteQueryDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & {
204
+ revalidateIfStale?: boolean;
205
+ };
206
+ export { EnsureInfiniteQueryDataOptions }
207
+ export { EnsureInfiniteQueryDataOptions as EnsureInfiniteQueryDataOptions_alias_1 }
208
+
209
+ declare interface EnsureQueryDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> {
210
+ revalidateIfStale?: boolean;
211
+ }
212
+ export { EnsureQueryDataOptions }
213
+ export { EnsureQueryDataOptions as EnsureQueryDataOptions_alias_1 }
214
+
215
+ export declare function ensureQueryFn<TQueryFnData = unknown, TQueryKey extends QueryKey = QueryKey>(options: {
216
+ queryFn?: QueryFunction<TQueryFnData, TQueryKey> | SkipToken;
217
+ queryHash?: string;
218
+ }, fetchOptions?: FetchOptions<TQueryFnData>): QueryFunction<TQueryFnData, TQueryKey>;
219
+
220
+ /**
221
+ * Manages environment detection used by TanStack Query internals.
222
+ */
223
+ declare const environmentManager: {
224
+ /**
225
+ * Returns whether the current runtime should be treated as a server environment.
226
+ */
227
+ isServer(): boolean;
228
+ /**
229
+ * Overrides the server check globally.
230
+ */
231
+ setIsServer(isServerValue: IsServerValue): void;
232
+ };
233
+ export { environmentManager }
234
+ export { environmentManager as environmentManager_alias_1 }
235
+
236
+ declare interface ErrorAction<TError> {
237
+ type: 'error';
238
+ error: TError;
239
+ }
240
+
241
+ declare interface ErrorAction_2<TError> {
242
+ type: 'error';
243
+ error: TError;
244
+ }
245
+
246
+ export declare function executeMutation<TVariables>(queryClient: QueryClient, options: MutationOptions<any, any, TVariables, any>, variables: TVariables): Promise<any>;
247
+
248
+ declare interface FailedAction<TError> {
249
+ type: 'failed';
250
+ failureCount: number;
251
+ error: TError;
252
+ }
253
+
254
+ declare interface FailedAction_2<TError> {
255
+ type: 'failed';
256
+ failureCount: number;
257
+ error: TError | null;
258
+ }
259
+
260
+ declare interface FetchAction {
261
+ type: 'fetch';
262
+ meta?: FetchMeta;
263
+ }
264
+
265
+ export declare interface FetchContext<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
266
+ fetchFn: () => unknown | Promise<unknown>;
267
+ fetchOptions?: FetchOptions;
268
+ signal: AbortSignal;
269
+ options: QueryOptions<TQueryFnData, TError, TData, any>;
270
+ client: QueryClient;
271
+ queryKey: TQueryKey;
272
+ state: QueryState<TData, TError>;
273
+ }
274
+
275
+ export declare type FetchDirection = 'forward' | 'backward';
276
+
277
+ declare 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>;
278
+ export { FetchInfiniteQueryOptions }
279
+ export { FetchInfiniteQueryOptions as FetchInfiniteQueryOptions_alias_1 }
280
+
281
+ declare type FetchInfiniteQueryPages<TQueryFnData = unknown, TPageParam = unknown> = {
282
+ pages?: never;
283
+ } | {
284
+ pages: number;
285
+ getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>;
286
+ };
287
+
288
+ export declare interface FetchMeta {
289
+ fetchMore?: {
290
+ direction: FetchDirection;
291
+ };
292
+ }
293
+
294
+ declare interface FetchNextPageOptions extends ResultOptions {
295
+ /**
296
+ * If set to `true`, calling `fetchNextPage` repeatedly will invoke `queryFn` every time,
297
+ * whether the previous invocation has resolved or not. Also, the result from previous invocations will be ignored.
298
+ *
299
+ * If set to `false`, calling `fetchNextPage` repeatedly won't have any effect until the first invocation has resolved.
300
+ *
301
+ * Defaults to `true`.
302
+ */
303
+ cancelRefetch?: boolean;
304
+ }
305
+ export { FetchNextPageOptions }
306
+ export { FetchNextPageOptions as FetchNextPageOptions_alias_1 }
307
+
308
+ export declare interface FetchOptions<TData = unknown> {
309
+ cancelRefetch?: boolean;
310
+ meta?: FetchMeta;
311
+ initialPromise?: Promise<TData>;
312
+ }
313
+
314
+ declare interface FetchPreviousPageOptions extends ResultOptions {
315
+ /**
316
+ * If set to `true`, calling `fetchPreviousPage` repeatedly will invoke `queryFn` every time,
317
+ * whether the previous invocation has resolved or not. Also, the result from previous invocations will be ignored.
318
+ *
319
+ * If set to `false`, calling `fetchPreviousPage` repeatedly won't have any effect until the first invocation has resolved.
320
+ *
321
+ * Defaults to `true`.
322
+ */
323
+ cancelRefetch?: boolean;
324
+ }
325
+ export { FetchPreviousPageOptions }
326
+ export { FetchPreviousPageOptions as FetchPreviousPageOptions_alias_1 }
327
+
328
+ declare interface FetchQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends WithRequired<QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'queryKey'> {
329
+ initialPageParam?: never;
330
+ /**
331
+ * The time in milliseconds after data is considered stale.
332
+ * If the data is fresh it will be returned from the cache.
333
+ */
334
+ staleTime?: StaleTimeFunction<TQueryFnData, TError, TData, TQueryKey>;
335
+ }
336
+ export { FetchQueryOptions }
337
+ export { FetchQueryOptions as FetchQueryOptions_alias_1 }
338
+
339
+ export declare function fetchState<TQueryFnData, TError, TData, TQueryKey extends QueryKey>(data: TData | undefined, options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>): {
340
+ readonly error?: null | undefined;
341
+ readonly status?: "pending" | undefined;
342
+ readonly fetchFailureCount: 0;
343
+ readonly fetchFailureReason: null;
344
+ readonly fetchStatus: "fetching" | "paused";
345
+ };
346
+
347
+ declare type FetchStatus = 'fetching' | 'paused' | 'idle';
348
+ export { FetchStatus }
349
+ export { FetchStatus as FetchStatus_alias_1 }
350
+
351
+ export declare class FocusManager extends Subscribable<Listener> {
352
+ #private;
353
+ constructor();
354
+ protected onSubscribe(): void;
355
+ protected onUnsubscribe(): void;
356
+ setEventListener(setup: SetupFn): void;
357
+ setFocused(focused?: boolean): void;
358
+ onFocus(): void;
359
+ isFocused(): boolean;
360
+ }
361
+
362
+ declare const focusManager: FocusManager;
363
+ export { focusManager }
364
+ export { focusManager as focusManager_alias_1 }
365
+
366
+ /**
367
+ * Thenable types which matches React's types for promises
368
+ *
369
+ * React seemingly uses `.status`, `.value` and `.reason` properties on a promises to optimistically unwrap data from promises
370
+ *
371
+ * @see https://github.com/facebook/react/blob/main/packages/shared/ReactTypes.js#L112-L138
372
+ * @see https://github.com/facebook/react/blob/4f604941569d2e8947ce1460a0b2997e835f37b9/packages/react-debug-tools/src/ReactDebugHooks.js#L224-L227
373
+ */
374
+ declare interface Fulfilled<T> {
375
+ status: 'fulfilled';
376
+ value: T;
377
+ }
378
+
379
+ export declare type FulfilledThenable<T> = Promise<T> & Fulfilled<T>;
380
+
381
+ export declare function functionalUpdate<TInput, TOutput>(updater: Updater<TInput, TOutput>, input: TInput): TOutput;
382
+
383
+ export declare function getDefaultState<TData, TError, TVariables, TOnMutateResult>(): MutationState<TData, TError, TVariables, TOnMutateResult>;
384
+
385
+ declare type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (lastPage: TQueryFnData, allPages: Array<TQueryFnData>, lastPageParam: TPageParam, allPageParams: Array<TPageParam>) => TPageParam | undefined | null;
386
+ export { GetNextPageParamFunction }
387
+ export { GetNextPageParamFunction as GetNextPageParamFunction_alias_1 }
388
+
389
+ declare type GetPreviousPageParamFunction<TPageParam, TQueryFnData = unknown> = (firstPage: TQueryFnData, allPages: Array<TQueryFnData>, firstPageParam: TPageParam, allPageParams: Array<TPageParam>) => TPageParam | undefined | null;
390
+ export { GetPreviousPageParamFunction }
391
+ export { GetPreviousPageParamFunction as GetPreviousPageParamFunction_alias_1 }
392
+
393
+ /**
394
+ * Default query & mutation keys hash function.
395
+ * Hashes the value into a stable hash.
396
+ */
397
+ declare function hashKey(queryKey: QueryKey | MutationKey): string;
398
+ export { hashKey }
399
+ export { hashKey as hashKey_alias_1 }
400
+
401
+ export declare function hashQueryKeyByOptions<TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Pick<QueryOptions<any, any, any, any>, 'queryKeyHashFn'>): string;
402
+
403
+ /**
404
+ * Checks if there is a next page.
405
+ */
406
+ export declare function hasNextPage(options: InfiniteQueryPageParamsOptions<any, any>, data?: InfiniteData<unknown>): boolean;
407
+
408
+ /**
409
+ * Checks if there is a previous page.
410
+ */
411
+ export declare function hasPreviousPage(options: InfiniteQueryPageParamsOptions<any, any>, data?: InfiniteData<unknown>): boolean;
412
+
413
+ declare function hydrate(client: QueryClient, dehydratedState: unknown, options?: HydrateOptions): void;
414
+ export { hydrate }
415
+ export { hydrate as hydrate_alias_1 }
416
+
417
+ declare interface HydrateOptions {
418
+ defaultOptions?: {
419
+ deserializeData?: TransformerFn;
420
+ queries?: QueryOptions;
421
+ mutations?: MutationOptions<unknown, DefaultError, unknown, unknown>;
422
+ };
423
+ }
424
+ export { HydrateOptions }
425
+ export { HydrateOptions as HydrateOptions_alias_1 }
426
+
427
+ declare type InferDataFromTag<TQueryFnData, TTaggedQueryKey extends QueryKey> = TTaggedQueryKey extends DataTag<unknown, infer TaggedValue, unknown> ? TaggedValue : TQueryFnData;
428
+ export { InferDataFromTag }
429
+ export { InferDataFromTag as InferDataFromTag_alias_1 }
430
+
431
+ declare type InferErrorFromTag<TError, TTaggedQueryKey extends QueryKey> = TTaggedQueryKey extends DataTag<unknown, unknown, infer TaggedError> ? TaggedError extends UnsetMarker ? TError : TaggedError : TError;
432
+ export { InferErrorFromTag }
433
+ export { InferErrorFromTag as InferErrorFromTag_alias_1 }
434
+
435
+ declare interface InfiniteData<TData, TPageParam = unknown> {
436
+ pages: Array<TData>;
437
+ pageParams: Array<TPageParam>;
438
+ }
439
+ export { InfiniteData }
440
+ export { InfiniteData as InfiniteData_alias_1 }
441
+
442
+ export declare function infiniteQueryBehavior<TQueryFnData, TError, TData, TPageParam>(pages?: number): QueryBehavior<TQueryFnData, TError, InfiniteData<TData, TPageParam>>;
443
+
444
+ declare class InfiniteQueryObserver<TQueryFnData = unknown, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends QueryObserver<TQueryFnData, TError, TData, InfiniteData<TQueryFnData, TPageParam>, TQueryKey> {
445
+ subscribe: Subscribable<InfiniteQueryObserverListener<TData, TError>>['subscribe'];
446
+ getCurrentResult: ReplaceReturnType<QueryObserver<TQueryFnData, TError, TData, InfiniteData<TQueryFnData, TPageParam>, TQueryKey>['getCurrentResult'], InfiniteQueryObserverResult<TData, TError>>;
447
+ protected fetch: ReplaceReturnType<QueryObserver<TQueryFnData, TError, TData, InfiniteData<TQueryFnData, TPageParam>, TQueryKey>['fetch'], Promise<InfiniteQueryObserverResult<TData, TError>>>;
448
+ constructor(client: QueryClient, options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>);
449
+ protected bindMethods(): void;
450
+ setOptions(options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): void;
451
+ getOptimisticResult(options: DefaultedInfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): InfiniteQueryObserverResult<TData, TError>;
452
+ fetchNextPage(options?: FetchNextPageOptions): Promise<InfiniteQueryObserverResult<TData, TError>>;
453
+ fetchPreviousPage(options?: FetchPreviousPageOptions): Promise<InfiniteQueryObserverResult<TData, TError>>;
454
+ protected createResult(query: Query<TQueryFnData, TError, InfiniteData<TQueryFnData, TPageParam>, TQueryKey>, options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): InfiniteQueryObserverResult<TData, TError>;
455
+ }
456
+ export { InfiniteQueryObserver }
457
+ export { InfiniteQueryObserver as InfiniteQueryObserver_alias_1 }
458
+
459
+ declare interface InfiniteQueryObserverBaseResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
460
+ /**
461
+ * This function allows you to fetch the next "page" of results.
462
+ */
463
+ fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>;
464
+ /**
465
+ * This function allows you to fetch the previous "page" of results.
466
+ */
467
+ fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>;
468
+ /**
469
+ * Will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).
470
+ */
471
+ hasNextPage: boolean;
472
+ /**
473
+ * Will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).
474
+ */
475
+ hasPreviousPage: boolean;
476
+ /**
477
+ * Will be `true` if the query failed while fetching the next page.
478
+ */
479
+ isFetchNextPageError: boolean;
480
+ /**
481
+ * Will be `true` while fetching the next page with `fetchNextPage`.
482
+ */
483
+ isFetchingNextPage: boolean;
484
+ /**
485
+ * Will be `true` if the query failed while fetching the previous page.
486
+ */
487
+ isFetchPreviousPageError: boolean;
488
+ /**
489
+ * Will be `true` while fetching the previous page with `fetchPreviousPage`.
490
+ */
491
+ isFetchingPreviousPage: boolean;
492
+ }
493
+ export { InfiniteQueryObserverBaseResult }
494
+ export { InfiniteQueryObserverBaseResult as InfiniteQueryObserverBaseResult_alias_1 }
495
+
496
+ declare type InfiniteQueryObserverListener<TData, TError> = (result: InfiniteQueryObserverResult<TData, TError>) => void;
497
+
498
+ declare interface InfiniteQueryObserverLoadingErrorResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
499
+ data: undefined;
500
+ error: TError;
501
+ isError: true;
502
+ isPending: false;
503
+ isLoading: false;
504
+ isLoadingError: true;
505
+ isRefetchError: false;
506
+ isFetchNextPageError: false;
507
+ isFetchPreviousPageError: false;
508
+ isSuccess: false;
509
+ isPlaceholderData: false;
510
+ status: 'error';
511
+ }
512
+ export { InfiniteQueryObserverLoadingErrorResult }
513
+ export { InfiniteQueryObserverLoadingErrorResult as InfiniteQueryObserverLoadingErrorResult_alias_1 }
514
+
515
+ declare interface InfiniteQueryObserverLoadingResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
516
+ data: undefined;
517
+ error: null;
518
+ isError: false;
519
+ isPending: true;
520
+ isLoading: true;
521
+ isLoadingError: false;
522
+ isRefetchError: false;
523
+ isFetchNextPageError: false;
524
+ isFetchPreviousPageError: false;
525
+ isSuccess: false;
526
+ isPlaceholderData: false;
527
+ status: 'pending';
528
+ }
529
+ export { InfiniteQueryObserverLoadingResult }
530
+ export { InfiniteQueryObserverLoadingResult as InfiniteQueryObserverLoadingResult_alias_1 }
531
+
532
+ declare 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> {
533
+ }
534
+ export { InfiniteQueryObserverOptions }
535
+ export { InfiniteQueryObserverOptions as InfiniteQueryObserverOptions_alias_1 }
536
+
537
+ declare interface InfiniteQueryObserverPendingResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
538
+ data: undefined;
539
+ error: null;
540
+ isError: false;
541
+ isPending: true;
542
+ isLoadingError: false;
543
+ isRefetchError: false;
544
+ isFetchNextPageError: false;
545
+ isFetchPreviousPageError: false;
546
+ isSuccess: false;
547
+ isPlaceholderData: false;
548
+ status: 'pending';
549
+ }
550
+ export { InfiniteQueryObserverPendingResult }
551
+ export { InfiniteQueryObserverPendingResult as InfiniteQueryObserverPendingResult_alias_1 }
552
+
553
+ declare interface InfiniteQueryObserverPlaceholderResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
554
+ data: TData;
555
+ isError: false;
556
+ error: null;
557
+ isPending: false;
558
+ isLoading: false;
559
+ isLoadingError: false;
560
+ isRefetchError: false;
561
+ isSuccess: true;
562
+ isPlaceholderData: true;
563
+ isFetchNextPageError: false;
564
+ isFetchPreviousPageError: false;
565
+ status: 'success';
566
+ }
567
+ export { InfiniteQueryObserverPlaceholderResult }
568
+ export { InfiniteQueryObserverPlaceholderResult as InfiniteQueryObserverPlaceholderResult_alias_1 }
569
+
570
+ declare interface InfiniteQueryObserverRefetchErrorResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
571
+ data: TData;
572
+ error: TError;
573
+ isError: true;
574
+ isPending: false;
575
+ isLoading: false;
576
+ isLoadingError: false;
577
+ isRefetchError: true;
578
+ isSuccess: false;
579
+ isPlaceholderData: false;
580
+ status: 'error';
581
+ }
582
+ export { InfiniteQueryObserverRefetchErrorResult }
583
+ export { InfiniteQueryObserverRefetchErrorResult as InfiniteQueryObserverRefetchErrorResult_alias_1 }
584
+
585
+ declare type InfiniteQueryObserverResult<TData = unknown, TError = DefaultError> = DefinedInfiniteQueryObserverResult<TData, TError> | InfiniteQueryObserverLoadingErrorResult<TData, TError> | InfiniteQueryObserverLoadingResult<TData, TError> | InfiniteQueryObserverPendingResult<TData, TError> | InfiniteQueryObserverPlaceholderResult<TData, TError>;
586
+ export { InfiniteQueryObserverResult }
587
+ export { InfiniteQueryObserverResult as InfiniteQueryObserverResult_alias_1 }
588
+
589
+ declare interface InfiniteQueryObserverSuccessResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
590
+ data: TData;
591
+ error: null;
592
+ isError: false;
593
+ isPending: false;
594
+ isLoading: false;
595
+ isLoadingError: false;
596
+ isRefetchError: false;
597
+ isFetchNextPageError: false;
598
+ isFetchPreviousPageError: false;
599
+ isSuccess: true;
600
+ isPlaceholderData: false;
601
+ status: 'success';
602
+ }
603
+ export { InfiniteQueryObserverSuccessResult }
604
+ export { InfiniteQueryObserverSuccessResult as InfiniteQueryObserverSuccessResult_alias_1 }
605
+
606
+ declare interface InfiniteQueryPageParamsOptions<TQueryFnData = unknown, TPageParam = unknown> extends InitialPageParam<TPageParam> {
607
+ /**
608
+ * This function can be set to automatically get the previous cursor for infinite queries.
609
+ * The result will also be used to determine the value of `hasPreviousPage`.
610
+ */
611
+ getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TQueryFnData>;
612
+ /**
613
+ * This function can be set to automatically get the next cursor for infinite queries.
614
+ * The result will also be used to determine the value of `hasNextPage`.
615
+ */
616
+ getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>;
617
+ }
618
+ export { InfiniteQueryPageParamsOptions }
619
+ export { InfiniteQueryPageParamsOptions as InfiniteQueryPageParamsOptions_alias_1 }
620
+
621
+ declare type InitialDataFunction<T> = () => T | undefined;
622
+ export { InitialDataFunction }
623
+ export { InitialDataFunction as InitialDataFunction_alias_1 }
624
+
625
+ declare interface InitialPageParam<TPageParam = unknown> {
626
+ initialPageParam: TPageParam;
627
+ }
628
+ export { InitialPageParam }
629
+ export { InitialPageParam as InitialPageParam_alias_1 }
630
+
631
+ declare interface InvalidateAction {
632
+ type: 'invalidate';
633
+ }
634
+
635
+ declare interface InvalidateOptions extends RefetchOptions {
636
+ }
637
+ export { InvalidateOptions }
638
+ export { InvalidateOptions as InvalidateOptions_alias_1 }
639
+
640
+ declare interface InvalidateQueryFilters<TQueryKey extends QueryKey = QueryKey> extends QueryFilters<TQueryKey> {
641
+ refetchType?: QueryTypeFilter | 'none';
642
+ }
643
+ export { InvalidateQueryFilters }
644
+ export { InvalidateQueryFilters as InvalidateQueryFilters_alias_1 }
645
+
646
+ /**
647
+ * @deprecated Use instanceof `CancelledError` instead.
648
+ */
649
+ declare function isCancelledError(value: any): value is CancelledError;
650
+ export { isCancelledError }
651
+ export { isCancelledError as isCancelledError_alias_1 }
652
+
653
+ export declare function isPlainArray(value: unknown): value is Array<unknown>;
654
+
655
+ export declare function isPlainObject(o: any): o is Record<PropertyKey, unknown>;
656
+
657
+ /** @deprecated
658
+ * use `environmentManager.isServer()` instead.
659
+ */
660
+ declare const isServer: boolean;
661
+ export { isServer }
662
+ export { isServer as isServer_alias_1 }
663
+
664
+ export declare type IsServerValue = () => boolean;
665
+
666
+ export declare function isValidTimeout(value: unknown): value is number;
667
+
668
+ declare function keepPreviousData<T>(previousData: T | undefined): T | undefined;
669
+ export { keepPreviousData }
670
+ export { keepPreviousData as keepPreviousData_alias_1 }
671
+
672
+ /**
673
+ * @param {Object} opts - Options for building configurations.
674
+ * @param {string[]} opts.entry - The entry array.
675
+ * @returns {import('tsup').Options}
676
+ */
677
+ export declare function legacyConfig(opts: {
678
+ entry: string[];
679
+ }): Options;
680
+
681
+ declare type Listener = (focused: boolean) => void;
682
+
683
+ declare type Listener_2 = (online: boolean) => void;
684
+
685
+ /**
686
+ * Wrapping `setTimeout` is awkward from a typing perspective because platform
687
+ * typings may extend the return type of `setTimeout`. For example, NodeJS
688
+ * typings add `NodeJS.Timeout`; but a non-default `timeoutManager` may not be
689
+ * able to return such a type.
690
+ */
691
+ declare type ManagedTimerId = number | {
692
+ [Symbol.toPrimitive]: () => number;
693
+ };
694
+ export { ManagedTimerId }
695
+ export { ManagedTimerId as ManagedTimerId_alias_1 }
696
+
697
+ declare function matchMutation(filters: MutationFilters, mutation: Mutation<any, any>): boolean;
698
+ export { matchMutation }
699
+ export { matchMutation as matchMutation_alias_1 }
700
+
701
+ declare function matchQuery(filters: QueryFilters, query: Query<any, any, any, any>): boolean;
702
+ export { matchQuery }
703
+ export { matchQuery as matchQuery_alias_1 }
704
+
705
+ export declare function mockOnlineManagerIsOnline(value: boolean): MockInstance<() => boolean>;
706
+
707
+ /**
708
+ * @param {Object} opts - Options for building configurations.
709
+ * @param {string[]} opts.entry - The entry array.
710
+ * @returns {import('tsup').Options}
711
+ */
712
+ export declare function modernConfig(opts: {
713
+ entry: string[];
714
+ }): Options;
715
+
716
+ declare type MutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TOnMutateResult>) => Promise<TData>;
717
+ export { MutateFunction }
718
+ export { MutateFunction as MutateFunction_alias_1 }
719
+
720
+ declare interface MutateOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> {
721
+ onSuccess?: (data: TData, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => void;
722
+ onError?: (error: TError, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => void;
723
+ onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => void;
724
+ }
725
+ export { MutateOptions }
726
+ export { MutateOptions as MutateOptions_alias_1 }
727
+
728
+ declare class Mutation<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> extends Removable {
729
+ #private;
730
+ state: MutationState<TData, TError, TVariables, TOnMutateResult>;
731
+ options: MutationOptions<TData, TError, TVariables, TOnMutateResult>;
732
+ readonly mutationId: number;
733
+ constructor(config: MutationConfig<TData, TError, TVariables, TOnMutateResult>);
734
+ setOptions(options: MutationOptions<TData, TError, TVariables, TOnMutateResult>): void;
735
+ get meta(): MutationMeta | undefined;
736
+ addObserver(observer: MutationObserver_2<any, any, any, any>): void;
737
+ removeObserver(observer: MutationObserver_2<any, any, any, any>): void;
738
+ protected optionalRemove(): void;
739
+ continue(): Promise<unknown>;
740
+ execute(variables: TVariables): Promise<TData>;
741
+ }
742
+ export { Mutation }
743
+ export { Mutation as Mutation_alias_1 }
744
+
745
+ declare class MutationCache extends Subscribable<MutationCacheListener> {
746
+ #private;
747
+ config: MutationCacheConfig;
748
+ constructor(config?: MutationCacheConfig);
749
+ build<TData, TError, TVariables, TOnMutateResult>(client: QueryClient, options: MutationOptions<TData, TError, TVariables, TOnMutateResult>, state?: MutationState<TData, TError, TVariables, TOnMutateResult>): Mutation<TData, TError, TVariables, TOnMutateResult>;
750
+ add(mutation: Mutation<any, any, any, any>): void;
751
+ remove(mutation: Mutation<any, any, any, any>): void;
752
+ canRun(mutation: Mutation<any, any, any, any>): boolean;
753
+ runNext(mutation: Mutation<any, any, any, any>): Promise<unknown>;
754
+ clear(): void;
755
+ getAll(): Array<Mutation>;
756
+ find<TData = unknown, TError = DefaultError, TVariables = any, TOnMutateResult = unknown>(filters: MutationFilters): Mutation<TData, TError, TVariables, TOnMutateResult> | undefined;
757
+ findAll(filters?: MutationFilters): Array<Mutation>;
758
+ notify(event: MutationCacheNotifyEvent): void;
759
+ resumePausedMutations(): Promise<unknown>;
760
+ }
761
+ export { MutationCache }
762
+ export { MutationCache as MutationCache_alias_1 }
763
+
764
+ declare interface MutationCacheConfig {
765
+ onError?: (error: DefaultError, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
766
+ onSuccess?: (data: unknown, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
767
+ onMutate?: (variables: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
768
+ onSettled?: (data: unknown | undefined, error: DefaultError | null, variables: unknown, onMutateResult: unknown, mutation: Mutation<unknown, unknown, unknown>, context: MutationFunctionContext) => Promise<unknown> | unknown;
769
+ }
770
+
771
+ declare type MutationCacheListener = (event: MutationCacheNotifyEvent) => void;
772
+
773
+ declare type MutationCacheNotifyEvent = NotifyEventMutationAdded | NotifyEventMutationRemoved | NotifyEventMutationObserverAdded | NotifyEventMutationObserverRemoved | NotifyEventMutationObserverOptionsUpdated | NotifyEventMutationUpdated;
774
+ export { MutationCacheNotifyEvent }
775
+ export { MutationCacheNotifyEvent as MutationCacheNotifyEvent_alias_1 }
776
+
777
+ declare interface MutationConfig<TData, TError, TVariables, TOnMutateResult> {
778
+ client: QueryClient;
779
+ mutationId: number;
780
+ mutationCache: MutationCache;
781
+ options: MutationOptions<TData, TError, TVariables, TOnMutateResult>;
782
+ state?: MutationState<TData, TError, TVariables, TOnMutateResult>;
783
+ }
784
+
785
+ declare interface MutationFilters<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> {
786
+ /**
787
+ * Match mutation key exactly
788
+ */
789
+ exact?: boolean;
790
+ /**
791
+ * Include mutations matching this predicate function
792
+ */
793
+ predicate?: (mutation: Mutation<TData, TError, TVariables, TOnMutateResult>) => boolean;
794
+ /**
795
+ * Include mutations matching this mutation key
796
+ */
797
+ mutationKey?: TuplePrefixes<MutationKey>;
798
+ /**
799
+ * Filter by mutation status
800
+ */
801
+ status?: MutationStatus;
802
+ }
803
+ export { MutationFilters }
804
+ export { MutationFilters as MutationFilters_alias_1 }
805
+
806
+ declare type MutationFunction<TData = unknown, TVariables = unknown> = (variables: TVariables, context: MutationFunctionContext) => Promise<TData>;
807
+ export { MutationFunction }
808
+ export { MutationFunction as MutationFunction_alias_1 }
809
+
810
+ declare type MutationFunctionContext = {
811
+ client: QueryClient;
812
+ meta: MutationMeta | undefined;
813
+ mutationKey?: MutationKey;
814
+ };
815
+ export { MutationFunctionContext }
816
+ export { MutationFunctionContext as MutationFunctionContext_alias_1 }
817
+
818
+ declare type MutationKey = Register extends {
819
+ mutationKey: infer TMutationKey;
820
+ } ? TMutationKey extends ReadonlyArray<unknown> ? TMutationKey : TMutationKey extends Array<unknown> ? TMutationKey : ReadonlyArray<unknown> : ReadonlyArray<unknown>;
821
+ export { MutationKey }
822
+ export { MutationKey as MutationKey_alias_1 }
823
+
824
+ declare type MutationMeta = Register extends {
825
+ mutationMeta: infer TMutationMeta;
826
+ } ? TMutationMeta extends Record<string, unknown> ? TMutationMeta : Record<string, unknown> : Record<string, unknown>;
827
+ export { MutationMeta }
828
+ export { MutationMeta as MutationMeta_alias_1 }
829
+
830
+ declare class MutationObserver_2<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends Subscribable<MutationObserverListener<TData, TError, TVariables, TOnMutateResult>> {
831
+ #private;
832
+ options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>;
833
+ constructor(client: QueryClient, options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>);
834
+ protected bindMethods(): void;
835
+ setOptions(options: MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>): void;
836
+ protected onUnsubscribe(): void;
837
+ onMutationUpdate(action: Action<TData, TError, TVariables, TOnMutateResult>): void;
838
+ getCurrentResult(): MutationObserverResult<TData, TError, TVariables, TOnMutateResult>;
839
+ reset(): void;
840
+ mutate(variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TOnMutateResult>): Promise<TData>;
841
+ }
842
+ export { MutationObserver_2 as MutationObserver }
843
+ export { MutationObserver_2 as MutationObserver_alias_1 }
844
+
845
+ declare interface MutationObserverBaseResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationState<TData, TError, TVariables, TOnMutateResult> {
846
+ /**
847
+ * The last successfully resolved data for the mutation.
848
+ */
849
+ data: TData | undefined;
850
+ /**
851
+ * The variables object passed to the `mutationFn`.
852
+ */
853
+ variables: TVariables | undefined;
854
+ /**
855
+ * The error object for the mutation, if an error was encountered.
856
+ * - Defaults to `null`.
857
+ */
858
+ error: TError | null;
859
+ /**
860
+ * A boolean variable derived from `status`.
861
+ * - `true` if the last mutation attempt resulted in an error.
862
+ */
863
+ isError: boolean;
864
+ /**
865
+ * A boolean variable derived from `status`.
866
+ * - `true` if the mutation is in its initial state prior to executing.
867
+ */
868
+ isIdle: boolean;
869
+ /**
870
+ * A boolean variable derived from `status`.
871
+ * - `true` if the mutation is currently executing.
872
+ */
873
+ isPending: boolean;
874
+ /**
875
+ * A boolean variable derived from `status`.
876
+ * - `true` if the last mutation attempt was successful.
877
+ */
878
+ isSuccess: boolean;
879
+ /**
880
+ * The status of the mutation.
881
+ * - Will be:
882
+ * - `idle` initial status prior to the mutation function executing.
883
+ * - `pending` if the mutation is currently executing.
884
+ * - `error` if the last mutation attempt resulted in an error.
885
+ * - `success` if the last mutation attempt was successful.
886
+ */
887
+ status: MutationStatus;
888
+ /**
889
+ * The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.
890
+ * @param variables - The variables object to pass to the `mutationFn`.
891
+ * @param options.onSuccess - This function will fire when the mutation is successful and will be passed the mutation's result.
892
+ * @param options.onError - This function will fire if the mutation encounters an error and will be passed the error.
893
+ * @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.
894
+ * @remarks
895
+ * - If you make multiple requests, `onSuccess` will fire only after the latest call you've made.
896
+ * - All the callback functions (`onSuccess`, `onError`, `onSettled`) are void functions, and the returned value will be ignored.
897
+ */
898
+ mutate: MutateFunction<TData, TError, TVariables, TOnMutateResult>;
899
+ /**
900
+ * A function to clean the mutation internal state (i.e., it resets the mutation to its initial state).
901
+ */
902
+ reset: () => void;
903
+ }
904
+ export { MutationObserverBaseResult }
905
+ export { MutationObserverBaseResult as MutationObserverBaseResult_alias_1 }
906
+
907
+ declare interface MutationObserverErrorResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
908
+ data: undefined;
909
+ error: TError;
910
+ variables: TVariables;
911
+ isError: true;
912
+ isIdle: false;
913
+ isPending: false;
914
+ isSuccess: false;
915
+ status: 'error';
916
+ }
917
+ export { MutationObserverErrorResult }
918
+ export { MutationObserverErrorResult as MutationObserverErrorResult_alias_1 }
919
+
920
+ declare interface MutationObserverIdleResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
921
+ data: undefined;
922
+ variables: undefined;
923
+ error: null;
924
+ isError: false;
925
+ isIdle: true;
926
+ isPending: false;
927
+ isSuccess: false;
928
+ status: 'idle';
929
+ }
930
+ export { MutationObserverIdleResult }
931
+ export { MutationObserverIdleResult as MutationObserverIdleResult_alias_1 }
932
+
933
+ declare type MutationObserverListener<TData, TError, TVariables, TOnMutateResult> = (result: MutationObserverResult<TData, TError, TVariables, TOnMutateResult>) => void;
934
+
935
+ declare interface MutationObserverLoadingResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
936
+ data: undefined;
937
+ variables: TVariables;
938
+ error: null;
939
+ isError: false;
940
+ isIdle: false;
941
+ isPending: true;
942
+ isSuccess: false;
943
+ status: 'pending';
944
+ }
945
+ export { MutationObserverLoadingResult }
946
+ export { MutationObserverLoadingResult as MutationObserverLoadingResult_alias_1 }
947
+
948
+ declare interface MutationObserverOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationOptions<TData, TError, TVariables, TOnMutateResult> {
949
+ throwOnError?: boolean | ((error: TError) => boolean);
950
+ }
951
+ export { MutationObserverOptions }
952
+ export { MutationObserverOptions as MutationObserverOptions_alias_1 }
953
+
954
+ declare 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>;
955
+ export { MutationObserverResult }
956
+ export { MutationObserverResult as MutationObserverResult_alias_1 }
957
+
958
+ declare interface MutationObserverSuccessResult<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TOnMutateResult> {
959
+ data: TData;
960
+ error: null;
961
+ variables: TVariables;
962
+ isError: false;
963
+ isIdle: false;
964
+ isPending: false;
965
+ isSuccess: true;
966
+ status: 'success';
967
+ }
968
+ export { MutationObserverSuccessResult }
969
+ export { MutationObserverSuccessResult as MutationObserverSuccessResult_alias_1 }
970
+
971
+ declare interface MutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> {
972
+ mutationFn?: MutationFunction<TData, TVariables>;
973
+ mutationKey?: MutationKey;
974
+ onMutate?: (variables: TVariables, context: MutationFunctionContext) => Promise<TOnMutateResult> | TOnMutateResult;
975
+ onSuccess?: (data: TData, variables: TVariables, onMutateResult: TOnMutateResult, context: MutationFunctionContext) => Promise<unknown> | unknown;
976
+ onError?: (error: TError, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => Promise<unknown> | unknown;
977
+ onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, onMutateResult: TOnMutateResult | undefined, context: MutationFunctionContext) => Promise<unknown> | unknown;
978
+ retry?: RetryValue<TError>;
979
+ retryDelay?: RetryDelayValue<TError>;
980
+ networkMode?: NetworkMode;
981
+ gcTime?: number;
982
+ _defaulted?: boolean;
983
+ meta?: MutationMeta;
984
+ scope?: MutationScope;
985
+ }
986
+ export { MutationOptions }
987
+ export { MutationOptions as MutationOptions_alias_1 }
988
+
989
+ declare type MutationScope = {
990
+ id: string;
991
+ };
992
+ export { MutationScope }
993
+ export { MutationScope as MutationScope_alias_1 }
994
+
995
+ declare interface MutationState<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> {
996
+ context: TOnMutateResult | undefined;
997
+ data: TData | undefined;
998
+ error: TError | null;
999
+ failureCount: number;
1000
+ failureReason: TError | null;
1001
+ isPaused: boolean;
1002
+ status: MutationStatus;
1003
+ variables: TVariables | undefined;
1004
+ submittedAt: number;
1005
+ }
1006
+ export { MutationState }
1007
+ export { MutationState as MutationState_alias_1 }
1008
+
1009
+ declare type MutationStatus = 'idle' | 'pending' | 'success' | 'error';
1010
+ export { MutationStatus }
1011
+ export { MutationStatus as MutationStatus_alias_1 }
1012
+
1013
+ declare type NetworkMode = 'online' | 'always' | 'offlineFirst';
1014
+ export { NetworkMode }
1015
+ export { NetworkMode as NetworkMode_alias_1 }
1016
+
1017
+ declare type NoInfer_2<T> = [T][T extends any ? 0 : never];
1018
+ export { NoInfer_2 as NoInfer }
1019
+ export { NoInfer_2 as NoInfer_alias_1 }
1020
+
1021
+ declare type NonFunctionGuard<T> = T extends Function ? never : T;
1022
+
1023
+ declare type NonUndefinedGuard<T> = T extends undefined ? never : T;
1024
+ export { NonUndefinedGuard }
1025
+ export { NonUndefinedGuard as NonUndefinedGuard_alias_1 }
1026
+
1027
+ declare function noop(): void;
1028
+
1029
+ declare function noop(): undefined;
1030
+ export { noop }
1031
+ export { noop as noop_alias_1 }
1032
+
1033
+ declare type NotifyCallback = () => void;
1034
+
1035
+ declare interface NotifyEvent {
1036
+ type: NotifyEventType;
1037
+ }
1038
+ export { NotifyEvent }
1039
+ export { NotifyEvent as NotifyEvent_alias_1 }
1040
+
1041
+ declare interface NotifyEventMutationAdded extends NotifyEvent {
1042
+ type: 'added';
1043
+ mutation: Mutation<any, any, any, any>;
1044
+ }
1045
+
1046
+ declare interface NotifyEventMutationObserverAdded extends NotifyEvent {
1047
+ type: 'observerAdded';
1048
+ mutation: Mutation<any, any, any, any>;
1049
+ observer: MutationObserver_2<any, any, any>;
1050
+ }
1051
+
1052
+ declare interface NotifyEventMutationObserverOptionsUpdated extends NotifyEvent {
1053
+ type: 'observerOptionsUpdated';
1054
+ mutation?: Mutation<any, any, any, any>;
1055
+ observer: MutationObserver_2<any, any, any, any>;
1056
+ }
1057
+
1058
+ declare interface NotifyEventMutationObserverRemoved extends NotifyEvent {
1059
+ type: 'observerRemoved';
1060
+ mutation: Mutation<any, any, any, any>;
1061
+ observer: MutationObserver_2<any, any, any>;
1062
+ }
1063
+
1064
+ declare interface NotifyEventMutationRemoved extends NotifyEvent {
1065
+ type: 'removed';
1066
+ mutation: Mutation<any, any, any, any>;
1067
+ }
1068
+
1069
+ declare interface NotifyEventMutationUpdated extends NotifyEvent {
1070
+ type: 'updated';
1071
+ mutation: Mutation<any, any, any, any>;
1072
+ action: Action<any, any, any, any>;
1073
+ }
1074
+
1075
+ declare interface NotifyEventQueryAdded extends NotifyEvent {
1076
+ type: 'added';
1077
+ query: Query<any, any, any, any>;
1078
+ }
1079
+
1080
+ declare interface NotifyEventQueryObserverAdded extends NotifyEvent {
1081
+ type: 'observerAdded';
1082
+ query: Query<any, any, any, any>;
1083
+ observer: QueryObserver<any, any, any, any, any>;
1084
+ }
1085
+
1086
+ declare interface NotifyEventQueryObserverOptionsUpdated extends NotifyEvent {
1087
+ type: 'observerOptionsUpdated';
1088
+ query: Query<any, any, any, any>;
1089
+ observer: QueryObserver<any, any, any, any, any>;
1090
+ }
1091
+
1092
+ declare interface NotifyEventQueryObserverRemoved extends NotifyEvent {
1093
+ type: 'observerRemoved';
1094
+ query: Query<any, any, any, any>;
1095
+ observer: QueryObserver<any, any, any, any, any>;
1096
+ }
1097
+
1098
+ declare interface NotifyEventQueryObserverResultsUpdated extends NotifyEvent {
1099
+ type: 'observerResultsUpdated';
1100
+ query: Query<any, any, any, any>;
1101
+ }
1102
+
1103
+ declare interface NotifyEventQueryRemoved extends NotifyEvent {
1104
+ type: 'removed';
1105
+ query: Query<any, any, any, any>;
1106
+ }
1107
+
1108
+ declare interface NotifyEventQueryUpdated extends NotifyEvent {
1109
+ type: 'updated';
1110
+ query: Query<any, any, any, any>;
1111
+ action: Action_alias_1<any, any>;
1112
+ }
1113
+
1114
+ declare type NotifyEventType = 'added' | 'removed' | 'updated' | 'observerAdded' | 'observerRemoved' | 'observerResultsUpdated' | 'observerOptionsUpdated';
1115
+ export { NotifyEventType }
1116
+ export { NotifyEventType as NotifyEventType_alias_1 }
1117
+
1118
+ declare type NotifyFunction = (callback: () => void) => void;
1119
+
1120
+ declare const notifyManager: {
1121
+ readonly batch: <T>(callback: () => T) => T;
1122
+ /**
1123
+ * All calls to the wrapped function will be batched.
1124
+ */
1125
+ readonly batchCalls: <T extends Array<unknown>>(callback: BatchCallsCallback<T>) => BatchCallsCallback<T>;
1126
+ readonly schedule: (callback: NotifyCallback) => void;
1127
+ /**
1128
+ * Use this method to set a custom notify function.
1129
+ * This can be used to for example wrap notifications with `React.act` while running tests.
1130
+ */
1131
+ readonly setNotifyFunction: (fn: NotifyFunction) => void;
1132
+ /**
1133
+ * Use this method to set a custom function to batch notifications together into a single tick.
1134
+ * By default React Query will use the batch function provided by ReactDOM or React Native.
1135
+ */
1136
+ readonly setBatchNotifyFunction: (fn: BatchNotifyFunction) => void;
1137
+ readonly setScheduler: (fn: ScheduleFunction) => void;
1138
+ };
1139
+ export { notifyManager }
1140
+ export { notifyManager as notifyManager_alias_1 }
1141
+
1142
+ declare type NotifyOnChangeProps = Array<keyof InfiniteQueryObserverResult> | 'all' | undefined | (() => Array<keyof InfiniteQueryObserverResult> | 'all' | undefined);
1143
+ export { NotifyOnChangeProps }
1144
+ export { NotifyOnChangeProps as NotifyOnChangeProps_alias_1 }
1145
+
1146
+ declare interface ObserverFetchOptions extends FetchOptions {
1147
+ throwOnError?: boolean;
1148
+ }
1149
+
1150
+ declare 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>;
1151
+ export { OmitKeyof }
1152
+ export { OmitKeyof as OmitKeyof_alias_1 }
1153
+
1154
+ export declare class OnlineManager extends Subscribable<Listener_2> {
1155
+ #private;
1156
+ constructor();
1157
+ protected onSubscribe(): void;
1158
+ protected onUnsubscribe(): void;
1159
+ setEventListener(setup: SetupFn_2): void;
1160
+ setOnline(online: boolean): void;
1161
+ isOnline(): boolean;
1162
+ }
1163
+
1164
+ declare const onlineManager: OnlineManager;
1165
+ export { onlineManager }
1166
+ export { onlineManager as onlineManager_alias_1 }
1167
+
1168
+ declare type Override<TTargetA, TTargetB> = {
1169
+ [AKey in keyof TTargetA]: AKey extends keyof TTargetB ? TTargetB[AKey] : TTargetA[AKey];
1170
+ };
1171
+ export { Override }
1172
+ export { Override as Override_alias_1 }
1173
+
1174
+ /**
1175
+ * Checks if key `b` partially matches with key `a`.
1176
+ */
1177
+ declare function partialMatchKey(a: QueryKey, b: QueryKey): boolean;
1178
+ export { partialMatchKey }
1179
+ export { partialMatchKey as partialMatchKey_alias_1 }
1180
+
1181
+ declare interface PauseAction {
1182
+ type: 'pause';
1183
+ }
1184
+
1185
+ declare interface PauseAction_2 {
1186
+ type: 'pause';
1187
+ }
1188
+
1189
+ declare interface Pending<T> {
1190
+ status: 'pending';
1191
+ /**
1192
+ * Resolve the promise with a value.
1193
+ * Will remove the `resolve` and `reject` properties from the promise.
1194
+ */
1195
+ resolve: (value: T) => void;
1196
+ /**
1197
+ * Reject the promise with a reason.
1198
+ * Will remove the `resolve` and `reject` properties from the promise.
1199
+ */
1200
+ reject: (reason: unknown) => void;
1201
+ }
1202
+
1203
+ declare interface PendingAction<TVariables, TOnMutateResult> {
1204
+ type: 'pending';
1205
+ isPaused: boolean;
1206
+ variables?: TVariables;
1207
+ context?: TOnMutateResult;
1208
+ }
1209
+
1210
+ export declare type PendingThenable<T> = Promise<T> & Pending<T>;
1211
+
1212
+ export declare function pendingThenable<T>(): PendingThenable<T>;
1213
+
1214
+ declare type PlaceholderDataFunction<TQueryFnData = unknown, TError = DefaultError, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = (previousData: TQueryData | undefined, previousQuery: Query<TQueryFnData, TError, TQueryData, TQueryKey> | undefined) => TQueryData | undefined;
1215
+ export { PlaceholderDataFunction }
1216
+ export { PlaceholderDataFunction as PlaceholderDataFunction_alias_1 }
1217
+
1218
+ declare class QueriesObserver<TCombinedResult = Array<QueryObserverResult>> extends Subscribable<QueriesObserverListener> {
1219
+ #private;
1220
+ constructor(client: QueryClient, queries: Array<QueryObserverOptions<any, any, any, any, any>>, options?: QueriesObserverOptions<TCombinedResult>);
1221
+ protected onSubscribe(): void;
1222
+ protected onUnsubscribe(): void;
1223
+ destroy(): void;
1224
+ setQueries(queries: Array<QueryObserverOptions>, options?: QueriesObserverOptions<TCombinedResult>): void;
1225
+ getCurrentResult(): Array<QueryObserverResult>;
1226
+ getQueries(): Query<unknown, Error, unknown, readonly unknown[]>[];
1227
+ getObservers(): QueryObserver<unknown, Error, unknown, unknown, readonly unknown[]>[];
1228
+ getOptimisticResult(queries: Array<QueryObserverOptions>, combine: CombineFn<TCombinedResult> | undefined): [
1229
+ rawResult: Array<QueryObserverResult>,
1230
+ combineResult: (r?: Array<QueryObserverResult>) => TCombinedResult,
1231
+ trackResult: () => Array<QueryObserverResult>
1232
+ ];
1233
+ }
1234
+ export { QueriesObserver }
1235
+ export { QueriesObserver as QueriesObserver_alias_1 }
1236
+
1237
+ declare type QueriesObserverListener = (result: Array<QueryObserverResult>) => void;
1238
+
1239
+ declare interface QueriesObserverOptions<TCombinedResult = Array<QueryObserverResult>> {
1240
+ combine?: CombineFn<TCombinedResult>;
1241
+ }
1242
+ export { QueriesObserverOptions }
1243
+ export { QueriesObserverOptions as QueriesObserverOptions_alias_1 }
1244
+
1245
+ declare type QueriesPlaceholderDataFunction<TQueryData> = (previousData: undefined, previousQuery: undefined) => TQueryData | undefined;
1246
+ export { QueriesPlaceholderDataFunction }
1247
+ export { QueriesPlaceholderDataFunction as QueriesPlaceholderDataFunction_alias_1 }
1248
+
1249
+ declare class Query<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends Removable {
1250
+ #private;
1251
+ queryKey: TQueryKey;
1252
+ queryHash: string;
1253
+ options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
1254
+ state: QueryState<TData, TError>;
1255
+ observers: Array<QueryObserver<any, any, any, any, any>>;
1256
+ constructor(config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>);
1257
+ get meta(): QueryMeta | undefined;
1258
+ get promise(): Promise<TData> | undefined;
1259
+ setOptions(options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>): void;
1260
+ protected optionalRemove(): void;
1261
+ setData(newData: TData, options?: SetDataOptions & {
1262
+ manual: boolean;
1263
+ }): TData;
1264
+ setState(state: Partial<QueryState<TData, TError>>, setStateOptions?: SetStateOptions): void;
1265
+ cancel(options?: CancelOptions): Promise<void>;
1266
+ destroy(): void;
1267
+ get resetState(): QueryState<TData, TError>;
1268
+ reset(): void;
1269
+ isActive(): boolean;
1270
+ isDisabled(): boolean;
1271
+ isFetched(): boolean;
1272
+ isStatic(): boolean;
1273
+ isStale(): boolean;
1274
+ isStaleByTime(staleTime?: StaleTime): boolean;
1275
+ onFocus(): void;
1276
+ onOnline(): void;
1277
+ addObserver(observer: QueryObserver<any, any, any, any, any>): void;
1278
+ removeObserver(observer: QueryObserver<any, any, any, any, any>): void;
1279
+ getObserversCount(): number;
1280
+ invalidate(): void;
1281
+ fetch(options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>, fetchOptions?: FetchOptions<TQueryFnData>): Promise<TData>;
1282
+ }
1283
+ export { Query }
1284
+ export { Query as Query_alias_1 }
1285
+
1286
+ export declare interface QueryBehavior<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> {
1287
+ onFetch: (context: FetchContext<TQueryFnData, TError, TData, TQueryKey>, query: Query) => void;
1288
+ }
1289
+
1290
+ declare class QueryCache extends Subscribable<QueryCacheListener> {
1291
+ #private;
1292
+ config: QueryCacheConfig;
1293
+ constructor(config?: QueryCacheConfig);
1294
+ 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>;
1295
+ add(query: Query<any, any, any, any>): void;
1296
+ remove(query: Query<any, any, any, any>): void;
1297
+ clear(): void;
1298
+ get<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryHash: string): Query<TQueryFnData, TError, TData, TQueryKey> | undefined;
1299
+ getAll(): Array<Query>;
1300
+ find<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData>(filters: WithRequired<QueryFilters, 'queryKey'>): Query<TQueryFnData, TError, TData> | undefined;
1301
+ findAll(filters?: QueryFilters<any>): Array<Query>;
1302
+ notify(event: QueryCacheNotifyEvent): void;
1303
+ onFocus(): void;
1304
+ onOnline(): void;
1305
+ }
1306
+ export { QueryCache }
1307
+ export { QueryCache as QueryCache_alias_1 }
1308
+
1309
+ declare interface QueryCacheConfig {
1310
+ onError?: (error: DefaultError, query: Query<unknown, unknown, unknown>) => void;
1311
+ onSuccess?: (data: unknown, query: Query<unknown, unknown, unknown>) => void;
1312
+ onSettled?: (data: unknown | undefined, error: DefaultError | null, query: Query<unknown, unknown, unknown>) => void;
1313
+ }
1314
+
1315
+ declare type QueryCacheListener = (event: QueryCacheNotifyEvent) => void;
1316
+
1317
+ declare type QueryCacheNotifyEvent = NotifyEventQueryAdded | NotifyEventQueryRemoved | NotifyEventQueryUpdated | NotifyEventQueryObserverAdded | NotifyEventQueryObserverRemoved | NotifyEventQueryObserverResultsUpdated | NotifyEventQueryObserverOptionsUpdated;
1318
+ export { QueryCacheNotifyEvent }
1319
+ export { QueryCacheNotifyEvent as QueryCacheNotifyEvent_alias_1 }
1320
+
1321
+ declare class QueryClient {
1322
+ #private;
1323
+ constructor(config?: QueryClientConfig);
1324
+ mount(): void;
1325
+ unmount(): void;
1326
+ isFetching<TQueryFilters extends QueryFilters<any> = QueryFilters>(filters?: TQueryFilters): number;
1327
+ isMutating<TMutationFilters extends MutationFilters<any, any> = MutationFilters>(filters?: TMutationFilters): number;
1328
+ /**
1329
+ * Imperative (non-reactive) way to retrieve data for a QueryKey.
1330
+ * Should only be used in callbacks or functions where reading the latest data is necessary, e.g. for optimistic updates.
1331
+ *
1332
+ * Hint: Do not use this function inside a component, because it won't receive updates.
1333
+ * Use `useQuery` to create a `QueryObserver` that subscribes to changes.
1334
+ */
1335
+ getQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>>(queryKey: TTaggedQueryKey): TInferredQueryFnData | undefined;
1336
+ ensureQueryData<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>;
1337
+ getQueriesData<TQueryFnData = unknown, TQueryFilters extends QueryFilters<any> = QueryFilters>(filters: TQueryFilters): Array<[QueryKey, TQueryFnData | undefined]>;
1338
+ setQueryData<TQueryFnData = unknown, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>>(queryKey: TTaggedQueryKey, updater: Updater<NoInfer_2<TInferredQueryFnData> | undefined, NoInfer_2<TInferredQueryFnData> | undefined>, options?: SetDataOptions): NoInfer_2<TInferredQueryFnData> | undefined;
1339
+ setQueriesData<TQueryFnData, TQueryFilters extends QueryFilters<any> = QueryFilters>(filters: TQueryFilters, updater: Updater<NoInfer_2<TQueryFnData> | undefined, NoInfer_2<TQueryFnData> | undefined>, options?: SetDataOptions): Array<[QueryKey, TQueryFnData | undefined]>;
1340
+ getQueryState<TQueryFnData = unknown, TError = DefaultError, TTaggedQueryKey extends QueryKey = QueryKey, TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>, TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>>(queryKey: TTaggedQueryKey): QueryState<TInferredQueryFnData, TInferredError> | undefined;
1341
+ removeQueries<TTaggedQueryKey extends QueryKey = QueryKey>(filters?: QueryFilters<TTaggedQueryKey>): void;
1342
+ resetQueries<TTaggedQueryKey extends QueryKey = QueryKey>(filters?: QueryFilters<TTaggedQueryKey>, options?: ResetOptions): Promise<void>;
1343
+ cancelQueries<TTaggedQueryKey extends QueryKey = QueryKey>(filters?: QueryFilters<TTaggedQueryKey>, cancelOptions?: CancelOptions): Promise<void>;
1344
+ invalidateQueries<TTaggedQueryKey extends QueryKey = QueryKey>(filters?: InvalidateQueryFilters<TTaggedQueryKey>, options?: InvalidateOptions): Promise<void>;
1345
+ refetchQueries<TTaggedQueryKey extends QueryKey = QueryKey>(filters?: RefetchQueryFilters<TTaggedQueryKey>, options?: RefetchOptions): Promise<void>;
1346
+ fetchQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<TData>;
1347
+ prefetchQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
1348
+ fetchInfiniteQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<InfiniteData<TData, TPageParam>>;
1349
+ prefetchInfiniteQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<void>;
1350
+ ensureInfiniteQueryData<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: EnsureInfiniteQueryDataOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<InfiniteData<TData, TPageParam>>;
1351
+ resumePausedMutations(): Promise<unknown>;
1352
+ getQueryCache(): QueryCache;
1353
+ getMutationCache(): MutationCache;
1354
+ getDefaultOptions(): DefaultOptions;
1355
+ setDefaultOptions(options: DefaultOptions): void;
1356
+ setQueryDefaults<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData>(queryKey: QueryKey, options: Partial<OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData>, 'queryKey'>>): void;
1357
+ getQueryDefaults(queryKey: QueryKey): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'>;
1358
+ setMutationDefaults<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown>(mutationKey: MutationKey, options: OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>, 'mutationKey'>): void;
1359
+ getMutationDefaults(mutationKey: MutationKey): OmitKeyof<MutationObserverOptions<any, any, any, any>, 'mutationKey'>;
1360
+ 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>;
1361
+ defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(options?: T): T;
1362
+ clear(): void;
1363
+ }
1364
+ export { QueryClient }
1365
+ export { QueryClient as QueryClient_alias_1 }
1366
+
1367
+ declare interface QueryClientConfig {
1368
+ queryCache?: QueryCache;
1369
+ mutationCache?: MutationCache;
1370
+ defaultOptions?: DefaultOptions;
1371
+ }
1372
+ export { QueryClientConfig }
1373
+ export { QueryClientConfig as QueryClientConfig_alias_1 }
1374
+
1375
+ declare interface QueryConfig<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
1376
+ client: QueryClient;
1377
+ queryKey: TQueryKey;
1378
+ queryHash: string;
1379
+ options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
1380
+ defaultOptions?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
1381
+ state?: QueryState<TData, TError>;
1382
+ }
1383
+
1384
+ declare interface QueryFilters<TQueryKey extends QueryKey = QueryKey> {
1385
+ /**
1386
+ * Filter to active queries, inactive queries or all queries
1387
+ */
1388
+ type?: QueryTypeFilter;
1389
+ /**
1390
+ * Match query key exactly
1391
+ */
1392
+ exact?: boolean;
1393
+ /**
1394
+ * Include queries matching this predicate function
1395
+ */
1396
+ predicate?: (query: Query) => boolean;
1397
+ /**
1398
+ * Include queries matching this query key
1399
+ */
1400
+ queryKey?: TQueryKey | TuplePrefixes<TQueryKey>;
1401
+ /**
1402
+ * Include or exclude stale queries
1403
+ */
1404
+ stale?: boolean;
1405
+ /**
1406
+ * Include queries matching their fetchStatus
1407
+ */
1408
+ fetchStatus?: FetchStatus;
1409
+ }
1410
+ export { QueryFilters }
1411
+ export { QueryFilters as QueryFilters_alias_1 }
1412
+
1413
+ declare type QueryFunction<T = unknown, TQueryKey extends QueryKey = QueryKey, TPageParam = never> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>;
1414
+ export { QueryFunction }
1415
+ export { QueryFunction as QueryFunction_alias_1 }
1416
+
1417
+ declare type QueryFunctionContext<TQueryKey extends QueryKey = QueryKey, TPageParam = never> = [TPageParam] extends [never] ? {
1418
+ client: QueryClient;
1419
+ queryKey: TQueryKey;
1420
+ signal: AbortSignal;
1421
+ meta: QueryMeta | undefined;
1422
+ pageParam?: unknown;
1423
+ /**
1424
+ * @deprecated
1425
+ * if you want access to the direction, you can add it to the pageParam
1426
+ */
1427
+ direction?: unknown;
1428
+ } : {
1429
+ client: QueryClient;
1430
+ queryKey: TQueryKey;
1431
+ signal: AbortSignal;
1432
+ pageParam: TPageParam;
1433
+ /**
1434
+ * @deprecated
1435
+ * if you want access to the direction, you can add it to the pageParam
1436
+ */
1437
+ direction: FetchDirection;
1438
+ meta: QueryMeta | undefined;
1439
+ };
1440
+ export { QueryFunctionContext }
1441
+ export { QueryFunctionContext as QueryFunctionContext_alias_1 }
1442
+
1443
+ declare type QueryKey = Register extends {
1444
+ queryKey: infer TQueryKey;
1445
+ } ? TQueryKey extends ReadonlyArray<unknown> ? TQueryKey : TQueryKey extends Array<unknown> ? TQueryKey : ReadonlyArray<unknown> : ReadonlyArray<unknown>;
1446
+ export { QueryKey }
1447
+ export { QueryKey as QueryKey_alias_1 }
1448
+
1449
+ declare type QueryKeyHashFunction<TQueryKey extends QueryKey> = (queryKey: TQueryKey) => string;
1450
+ export { QueryKeyHashFunction }
1451
+ export { QueryKeyHashFunction as QueryKeyHashFunction_alias_1 }
1452
+
1453
+ declare type QueryMeta = Register extends {
1454
+ queryMeta: infer TQueryMeta;
1455
+ } ? TQueryMeta extends Record<string, unknown> ? TQueryMeta : Record<string, unknown> : Record<string, unknown>;
1456
+ export { QueryMeta }
1457
+ export { QueryMeta as QueryMeta_alias_1 }
1458
+
1459
+ declare class QueryObserver<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends Subscribable<QueryObserverListener<TData, TError>> {
1460
+ #private;
1461
+ options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
1462
+ constructor(client: QueryClient, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>);
1463
+ protected bindMethods(): void;
1464
+ protected onSubscribe(): void;
1465
+ protected onUnsubscribe(): void;
1466
+ shouldFetchOnReconnect(): boolean;
1467
+ shouldFetchOnWindowFocus(): boolean;
1468
+ destroy(): void;
1469
+ setOptions(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): void;
1470
+ getOptimisticResult(options: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
1471
+ getCurrentResult(): QueryObserverResult<TData, TError>;
1472
+ trackResult(result: QueryObserverResult<TData, TError>, onPropTracked?: (key: keyof QueryObserverResult) => void): QueryObserverResult<TData, TError>;
1473
+ trackProp(key: keyof QueryObserverResult): void;
1474
+ getCurrentQuery(): Query<TQueryFnData, TError, TQueryData, TQueryKey>;
1475
+ refetch({ ...options }?: RefetchOptions): Promise<QueryObserverResult<TData, TError>>;
1476
+ fetchOptimistic(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): Promise<QueryObserverResult<TData, TError>>;
1477
+ protected fetch(fetchOptions: ObserverFetchOptions): Promise<QueryObserverResult<TData, TError>>;
1478
+ protected createResult(query: Query<TQueryFnData, TError, TQueryData, TQueryKey>, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
1479
+ updateResult(): void;
1480
+ onQueryUpdate(): void;
1481
+ }
1482
+ export { QueryObserver }
1483
+ export { QueryObserver as QueryObserver_alias_1 }
1484
+
1485
+ declare interface QueryObserverBaseResult<TData = unknown, TError = DefaultError> {
1486
+ /**
1487
+ * The last successfully resolved data for the query.
1488
+ */
1489
+ data: TData | undefined;
1490
+ /**
1491
+ * The timestamp for when the query most recently returned the `status` as `"success"`.
1492
+ */
1493
+ dataUpdatedAt: number;
1494
+ /**
1495
+ * The error object for the query, if an error was thrown.
1496
+ * - Defaults to `null`.
1497
+ */
1498
+ error: TError | null;
1499
+ /**
1500
+ * The timestamp for when the query most recently returned the `status` as `"error"`.
1501
+ */
1502
+ errorUpdatedAt: number;
1503
+ /**
1504
+ * The failure count for the query.
1505
+ * - Incremented every time the query fails.
1506
+ * - Reset to `0` when the query succeeds.
1507
+ */
1508
+ failureCount: number;
1509
+ /**
1510
+ * The failure reason for the query retry.
1511
+ * - Reset to `null` when the query succeeds.
1512
+ */
1513
+ failureReason: TError | null;
1514
+ /**
1515
+ * The sum of all errors.
1516
+ */
1517
+ errorUpdateCount: number;
1518
+ /**
1519
+ * A derived boolean from the `status` variable, provided for convenience.
1520
+ * - `true` if the query attempt resulted in an error.
1521
+ */
1522
+ isError: boolean;
1523
+ /**
1524
+ * Will be `true` if the query has been fetched.
1525
+ */
1526
+ isFetched: boolean;
1527
+ /**
1528
+ * Will be `true` if the query has been fetched after the component mounted.
1529
+ * - This property can be used to not show any previously cached data.
1530
+ */
1531
+ isFetchedAfterMount: boolean;
1532
+ /**
1533
+ * A derived boolean from the `fetchStatus` variable, provided for convenience.
1534
+ * - `true` whenever the `queryFn` is executing, which includes initial `pending` as well as background refetch.
1535
+ */
1536
+ isFetching: boolean;
1537
+ /**
1538
+ * Is `true` whenever the first fetch for a query is in-flight.
1539
+ * - Is the same as `isFetching && isPending`.
1540
+ */
1541
+ isLoading: boolean;
1542
+ /**
1543
+ * Will be `pending` if there's no cached data and no query attempt was finished yet.
1544
+ */
1545
+ isPending: boolean;
1546
+ /**
1547
+ * Will be `true` if the query failed while fetching for the first time.
1548
+ */
1549
+ isLoadingError: boolean;
1550
+ /**
1551
+ * @deprecated `isInitialLoading` is being deprecated in favor of `isLoading`
1552
+ * and will be removed in the next major version.
1553
+ */
1554
+ isInitialLoading: boolean;
1555
+ /**
1556
+ * A derived boolean from the `fetchStatus` variable, provided for convenience.
1557
+ * - The query wanted to fetch, but has been `paused`.
1558
+ */
1559
+ isPaused: boolean;
1560
+ /**
1561
+ * Will be `true` if the data shown is the placeholder data.
1562
+ */
1563
+ isPlaceholderData: boolean;
1564
+ /**
1565
+ * Will be `true` if the query failed while refetching.
1566
+ */
1567
+ isRefetchError: boolean;
1568
+ /**
1569
+ * Is `true` whenever a background refetch is in-flight, which _does not_ include initial `pending`.
1570
+ * - Is the same as `isFetching && !isPending`.
1571
+ */
1572
+ isRefetching: boolean;
1573
+ /**
1574
+ * Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.
1575
+ */
1576
+ isStale: boolean;
1577
+ /**
1578
+ * A derived boolean from the `status` variable, provided for convenience.
1579
+ * - `true` if the query has received a response with no errors and is ready to display its data.
1580
+ */
1581
+ isSuccess: boolean;
1582
+ /**
1583
+ * `true` if this observer is enabled, `false` otherwise.
1584
+ */
1585
+ isEnabled: boolean;
1586
+ /**
1587
+ * A function to manually refetch the query.
1588
+ */
1589
+ refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>>;
1590
+ /**
1591
+ * The status of the query.
1592
+ * - Will be:
1593
+ * - `pending` if there's no cached data and no query attempt was finished yet.
1594
+ * - `error` if the query attempt resulted in an error.
1595
+ * - `success` if the query has received a response with no errors and is ready to display its data.
1596
+ */
1597
+ status: QueryStatus;
1598
+ /**
1599
+ * The fetch status of the query.
1600
+ * - `fetching`: Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetch.
1601
+ * - `paused`: The query wanted to fetch, but has been `paused`.
1602
+ * - `idle`: The query is not fetching.
1603
+ * - See [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information.
1604
+ */
1605
+ fetchStatus: FetchStatus;
1606
+ /**
1607
+ * A stable promise that will be resolved with the data of the query.
1608
+ * Requires the `experimental_prefetchInRender` feature flag to be enabled.
1609
+ * @example
1610
+ *
1611
+ * ### Enabling the feature flag
1612
+ * ```ts
1613
+ * const client = new QueryClient({
1614
+ * defaultOptions: {
1615
+ * queries: {
1616
+ * experimental_prefetchInRender: true,
1617
+ * },
1618
+ * },
1619
+ * })
1620
+ * ```
1621
+ *
1622
+ * ### Usage
1623
+ * ```tsx
1624
+ * import { useQuery } from '@tanstack/react-query'
1625
+ * import React from 'react'
1626
+ * import { fetchTodos, type Todo } from './api'
1627
+ *
1628
+ * function TodoList({ query }: { query: UseQueryResult<Todo[], Error> }) {
1629
+ * const data = React.use(query.promise)
1630
+ *
1631
+ * return (
1632
+ * <ul>
1633
+ * {data.map(todo => (
1634
+ * <li key={todo.id}>{todo.title}</li>
1635
+ * ))}
1636
+ * </ul>
1637
+ * )
1638
+ * }
1639
+ *
1640
+ * export function App() {
1641
+ * const query = useQuery({ queryKey: ['todos'], queryFn: fetchTodos })
1642
+ *
1643
+ * return (
1644
+ * <>
1645
+ * <h1>Todos</h1>
1646
+ * <React.Suspense fallback={<div>Loading...</div>}>
1647
+ * <TodoList query={query} />
1648
+ * </React.Suspense>
1649
+ * </>
1650
+ * )
1651
+ * }
1652
+ * ```
1653
+ */
1654
+ promise: Promise<TData>;
1655
+ }
1656
+ export { QueryObserverBaseResult }
1657
+ export { QueryObserverBaseResult as QueryObserverBaseResult_alias_1 }
1658
+
1659
+ declare type QueryObserverListener<TData, TError> = (result: QueryObserverResult<TData, TError>) => void;
1660
+
1661
+ declare interface QueryObserverLoadingErrorResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
1662
+ data: undefined;
1663
+ error: TError;
1664
+ isError: true;
1665
+ isPending: false;
1666
+ isLoading: false;
1667
+ isLoadingError: true;
1668
+ isRefetchError: false;
1669
+ isSuccess: false;
1670
+ isPlaceholderData: false;
1671
+ status: 'error';
1672
+ }
1673
+ export { QueryObserverLoadingErrorResult }
1674
+ export { QueryObserverLoadingErrorResult as QueryObserverLoadingErrorResult_alias_1 }
1675
+
1676
+ declare interface QueryObserverLoadingResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
1677
+ data: undefined;
1678
+ error: null;
1679
+ isError: false;
1680
+ isPending: true;
1681
+ isLoading: true;
1682
+ isLoadingError: false;
1683
+ isRefetchError: false;
1684
+ isSuccess: false;
1685
+ isPlaceholderData: false;
1686
+ status: 'pending';
1687
+ }
1688
+ export { QueryObserverLoadingResult }
1689
+ export { QueryObserverLoadingResult as QueryObserverLoadingResult_alias_1 }
1690
+
1691
+ declare 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'> {
1692
+ /**
1693
+ * Set this to `false` or a function that returns `false` to disable automatic refetching when the query mounts or changes query keys.
1694
+ * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
1695
+ * Accepts a boolean or function that returns a boolean.
1696
+ * Defaults to `true`.
1697
+ */
1698
+ enabled?: Enabled<TQueryFnData, TError, TQueryData, TQueryKey>;
1699
+ /**
1700
+ * The time in milliseconds after data is considered stale.
1701
+ * If set to `Infinity`, the data will never be considered stale.
1702
+ * If set to a function, the function will be executed with the query to compute a `staleTime`.
1703
+ * Defaults to `0`.
1704
+ */
1705
+ staleTime?: StaleTimeFunction<TQueryFnData, TError, TQueryData, TQueryKey>;
1706
+ /**
1707
+ * If set to a number, the query will continuously refetch at this frequency in milliseconds.
1708
+ * If set to a function, the function will be executed with the latest data and query to compute a frequency
1709
+ * Defaults to `false`.
1710
+ */
1711
+ refetchInterval?: number | false | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => number | false | undefined);
1712
+ /**
1713
+ * If set to `true`, the query will continue to refetch while their tab/window is in the background.
1714
+ * Defaults to `false`.
1715
+ */
1716
+ refetchIntervalInBackground?: boolean;
1717
+ /**
1718
+ * If set to `true`, the query will refetch on window focus if the data is stale.
1719
+ * If set to `false`, the query will not refetch on window focus.
1720
+ * If set to `'always'`, the query will always refetch on window focus.
1721
+ * If set to a function, the function will be executed with the latest data and query to compute the value.
1722
+ * Defaults to `true`.
1723
+ */
1724
+ refetchOnWindowFocus?: boolean | 'always' | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | 'always');
1725
+ /**
1726
+ * If set to `true`, the query will refetch on reconnect if the data is stale.
1727
+ * If set to `false`, the query will not refetch on reconnect.
1728
+ * If set to `'always'`, the query will always refetch on reconnect.
1729
+ * If set to a function, the function will be executed with the latest data and query to compute the value.
1730
+ * Defaults to the value of `networkOnline` (`true`)
1731
+ */
1732
+ refetchOnReconnect?: boolean | 'always' | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | 'always');
1733
+ /**
1734
+ * If set to `true`, the query will refetch on mount if the data is stale.
1735
+ * If set to `false`, will disable additional instances of a query to trigger background refetch.
1736
+ * If set to `'always'`, the query will always refetch on mount.
1737
+ * If set to a function, the function will be executed with the latest data and query to compute the value
1738
+ * Defaults to `true`.
1739
+ */
1740
+ refetchOnMount?: boolean | 'always' | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | 'always');
1741
+ /**
1742
+ * If set to `false`, the query will not be retried on mount if it contains an error.
1743
+ * Defaults to `true`.
1744
+ */
1745
+ retryOnMount?: boolean;
1746
+ /**
1747
+ * If set, the component will only re-render if any of the listed properties change.
1748
+ * When set to `['data', 'error']`, the component will only re-render when the `data` or `error` properties change.
1749
+ * When set to `'all'`, the component will re-render whenever a query is updated.
1750
+ * When set to a function, the function will be executed to compute the list of properties.
1751
+ * By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.
1752
+ */
1753
+ notifyOnChangeProps?: NotifyOnChangeProps;
1754
+ /**
1755
+ * Whether errors should be thrown instead of setting the `error` property.
1756
+ * If set to `true` or `suspense` is `true`, all errors will be thrown to the error boundary.
1757
+ * If set to `false` and `suspense` is `false`, errors are returned as state.
1758
+ * 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`).
1759
+ * Defaults to `false`.
1760
+ */
1761
+ throwOnError?: ThrowOnError<TQueryFnData, TError, TQueryData, TQueryKey>;
1762
+ /**
1763
+ * This option can be used to transform or select a part of the data returned by the query function.
1764
+ */
1765
+ select?: (data: TQueryData) => TData;
1766
+ /**
1767
+ * If set to `true`, the query will suspend when `status === 'pending'`
1768
+ * and throw errors when `status === 'error'`.
1769
+ * Defaults to `false`.
1770
+ */
1771
+ suspense?: boolean;
1772
+ /**
1773
+ * 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.
1774
+ */
1775
+ placeholderData?: NonFunctionGuard<TQueryData> | PlaceholderDataFunction<NonFunctionGuard<TQueryData>, TError, NonFunctionGuard<TQueryData>, TQueryKey>;
1776
+ _optimisticResults?: 'optimistic' | 'isRestoring';
1777
+ /**
1778
+ * Enable prefetching during rendering
1779
+ */
1780
+ experimental_prefetchInRender?: boolean;
1781
+ }
1782
+ export { QueryObserverOptions }
1783
+ export { QueryObserverOptions as QueryObserverOptions_alias_1 }
1784
+
1785
+ declare interface QueryObserverPendingResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
1786
+ data: undefined;
1787
+ error: null;
1788
+ isError: false;
1789
+ isPending: true;
1790
+ isLoadingError: false;
1791
+ isRefetchError: false;
1792
+ isSuccess: false;
1793
+ isPlaceholderData: false;
1794
+ status: 'pending';
1795
+ }
1796
+ export { QueryObserverPendingResult }
1797
+ export { QueryObserverPendingResult as QueryObserverPendingResult_alias_1 }
1798
+
1799
+ declare interface QueryObserverPlaceholderResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
1800
+ data: TData;
1801
+ isError: false;
1802
+ error: null;
1803
+ isPending: false;
1804
+ isLoading: false;
1805
+ isLoadingError: false;
1806
+ isRefetchError: false;
1807
+ isSuccess: true;
1808
+ isPlaceholderData: true;
1809
+ status: 'success';
1810
+ }
1811
+ export { QueryObserverPlaceholderResult }
1812
+ export { QueryObserverPlaceholderResult as QueryObserverPlaceholderResult_alias_1 }
1813
+
1814
+ declare interface QueryObserverRefetchErrorResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
1815
+ data: TData;
1816
+ error: TError;
1817
+ isError: true;
1818
+ isPending: false;
1819
+ isLoading: false;
1820
+ isLoadingError: false;
1821
+ isRefetchError: true;
1822
+ isSuccess: false;
1823
+ isPlaceholderData: false;
1824
+ status: 'error';
1825
+ }
1826
+ export { QueryObserverRefetchErrorResult }
1827
+ export { QueryObserverRefetchErrorResult as QueryObserverRefetchErrorResult_alias_1 }
1828
+
1829
+ declare type QueryObserverResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError> | QueryObserverLoadingErrorResult<TData, TError> | QueryObserverLoadingResult<TData, TError> | QueryObserverPendingResult<TData, TError> | QueryObserverPlaceholderResult<TData, TError>;
1830
+ export { QueryObserverResult }
1831
+ export { QueryObserverResult as QueryObserverResult_alias_1 }
1832
+
1833
+ declare interface QueryObserverSuccessResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
1834
+ data: TData;
1835
+ error: null;
1836
+ isError: false;
1837
+ isPending: false;
1838
+ isLoading: false;
1839
+ isLoadingError: false;
1840
+ isRefetchError: false;
1841
+ isSuccess: true;
1842
+ isPlaceholderData: false;
1843
+ status: 'success';
1844
+ }
1845
+ export { QueryObserverSuccessResult }
1846
+ export { QueryObserverSuccessResult as QueryObserverSuccessResult_alias_1 }
1847
+
1848
+ declare interface QueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> {
1849
+ /**
1850
+ * If `false`, failed queries will not retry by default.
1851
+ * If `true`, failed queries will retry infinitely., failureCount: num
1852
+ * If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number.
1853
+ * If set to a function `(failureCount, error) => boolean` failed queries will retry until the function returns false.
1854
+ */
1855
+ retry?: RetryValue<TError>;
1856
+ retryDelay?: RetryDelayValue<TError>;
1857
+ networkMode?: NetworkMode;
1858
+ /**
1859
+ * The time in milliseconds that unused/inactive cache data remains in memory.
1860
+ * When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration.
1861
+ * When different garbage collection times are specified, the longest one will be used.
1862
+ * Setting it to `Infinity` will disable garbage collection.
1863
+ */
1864
+ gcTime?: number;
1865
+ queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam> | SkipToken;
1866
+ persister?: QueryPersister<NoInfer_2<TQueryFnData>, NoInfer_2<TQueryKey>, NoInfer_2<TPageParam>>;
1867
+ queryHash?: string;
1868
+ queryKey?: TQueryKey;
1869
+ queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>;
1870
+ initialData?: TData | InitialDataFunction<TData>;
1871
+ initialDataUpdatedAt?: number | (() => number | undefined);
1872
+ behavior?: QueryBehavior<TQueryFnData, TError, TData, TQueryKey>;
1873
+ /**
1874
+ * Set this to `false` to disable structural sharing between query results.
1875
+ * 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.
1876
+ * Defaults to `true`.
1877
+ */
1878
+ structuralSharing?: boolean | ((oldData: unknown | undefined, newData: unknown) => unknown);
1879
+ _defaulted?: boolean;
1880
+ /**
1881
+ * Additional payload to be stored on each query.
1882
+ * Use this property to pass information that can be used in other places.
1883
+ */
1884
+ meta?: QueryMeta;
1885
+ /**
1886
+ * Maximum number of pages to store in the data of an infinite query.
1887
+ */
1888
+ maxPages?: number;
1889
+ }
1890
+ export { QueryOptions }
1891
+ export { QueryOptions as QueryOptions_alias_1 }
1892
+
1893
+ declare 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>;
1894
+ export { QueryPersister }
1895
+ export { QueryPersister as QueryPersister_alias_1 }
1896
+
1897
+ declare interface QueryState<TData = unknown, TError = DefaultError> {
1898
+ data: TData | undefined;
1899
+ dataUpdateCount: number;
1900
+ dataUpdatedAt: number;
1901
+ error: TError | null;
1902
+ errorUpdateCount: number;
1903
+ errorUpdatedAt: number;
1904
+ fetchFailureCount: number;
1905
+ fetchFailureReason: TError | null;
1906
+ fetchMeta: FetchMeta | null;
1907
+ isInvalidated: boolean;
1908
+ status: QueryStatus;
1909
+ fetchStatus: FetchStatus;
1910
+ }
1911
+ export { QueryState }
1912
+ export { QueryState as QueryState_alias_1 }
1913
+
1914
+ declare type QueryStatus = 'pending' | 'error' | 'success';
1915
+ export { QueryStatus }
1916
+ export { QueryStatus as QueryStatus_alias_1 }
1917
+
1918
+ export declare interface QueryStore {
1919
+ has: (queryHash: string) => boolean;
1920
+ set: (queryHash: string, query: Query) => void;
1921
+ get: (queryHash: string) => Query | undefined;
1922
+ delete: (queryHash: string) => void;
1923
+ values: () => IterableIterator<Query>;
1924
+ }
1925
+
1926
+ export declare type QueryTypeFilter = 'all' | 'active' | 'inactive';
1927
+
1928
+ declare type ReducibleStreamedQueryParams<TQueryFnData, TData, TQueryKey extends QueryKey> = BaseStreamedQueryParams<TQueryFnData, TQueryKey> & {
1929
+ reducer: (acc: TData, chunk: TQueryFnData) => TData;
1930
+ initialValue: TData;
1931
+ };
1932
+
1933
+ declare interface RefetchOptions extends ResultOptions {
1934
+ /**
1935
+ * If set to `true`, a currently running request will be cancelled before a new request is made
1936
+ *
1937
+ * If set to `false`, no refetch will be made if there is already a request running.
1938
+ *
1939
+ * Defaults to `true`.
1940
+ */
1941
+ cancelRefetch?: boolean;
1942
+ }
1943
+ export { RefetchOptions }
1944
+ export { RefetchOptions as RefetchOptions_alias_1 }
1945
+
1946
+ declare interface RefetchQueryFilters<TQueryKey extends QueryKey = QueryKey> extends QueryFilters<TQueryKey> {
1947
+ }
1948
+ export { RefetchQueryFilters }
1949
+ export { RefetchQueryFilters as RefetchQueryFilters_alias_1 }
1950
+
1951
+ declare interface Register {
1952
+ }
1953
+ export { Register }
1954
+ export { Register as Register_alias_1 }
1955
+
1956
+ declare interface Rejected {
1957
+ status: 'rejected';
1958
+ reason: unknown;
1959
+ }
1960
+
1961
+ export declare type RejectedThenable<T> = Promise<T> & Rejected;
1962
+
1963
+ export declare abstract class Removable {
1964
+ #private;
1965
+ gcTime: number;
1966
+ destroy(): void;
1967
+ protected scheduleGc(): void;
1968
+ protected updateGcTime(newGcTime: number | undefined): void;
1969
+ protected clearGcTimeout(): void;
1970
+ protected abstract optionalRemove(): void;
1971
+ }
1972
+
1973
+ export declare function replaceData<TData, TOptions extends QueryOptions<any, any, any, any>>(prevData: TData | undefined, data: TData, options: TOptions): TData;
1974
+
1975
+ /**
1976
+ * This function returns `a` if `b` is deeply equal.
1977
+ * If not, it will replace any deeply equal children of `b` with those of `a`.
1978
+ * This can be used for structural sharing between JSON values for example.
1979
+ */
1980
+ declare function replaceEqualDeep<T>(a: unknown, b: T, depth?: number): T;
1981
+ export { replaceEqualDeep }
1982
+ export { replaceEqualDeep as replaceEqualDeep_alias_1 }
1983
+
1984
+ declare type ReplaceReturnType<TFunction extends (...args: Array<any>) => unknown, TReturn> = (...args: Parameters<TFunction>) => TReturn;
1985
+
1986
+ declare interface ResetOptions extends RefetchOptions {
1987
+ }
1988
+ export { ResetOptions }
1989
+ export { ResetOptions as ResetOptions_alias_1 }
1990
+
1991
+ export 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;
1992
+
1993
+ export 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;
1994
+
1995
+ declare interface ResultOptions {
1996
+ throwOnError?: boolean;
1997
+ }
1998
+ export { ResultOptions }
1999
+ export { ResultOptions as ResultOptions_alias_1 }
2000
+
2001
+ declare type RetryDelayFunction<TError = DefaultError> = (failureCount: number, error: TError) => number;
2002
+
2003
+ export declare type RetryDelayValue<TError> = number | RetryDelayFunction<TError>;
2004
+
2005
+ export declare interface Retryer<TData = unknown> {
2006
+ promise: Promise<TData>;
2007
+ cancel: (cancelOptions?: CancelOptions) => void;
2008
+ continue: () => Promise<unknown>;
2009
+ cancelRetry: () => void;
2010
+ continueRetry: () => void;
2011
+ canStart: () => boolean;
2012
+ start: () => Promise<TData>;
2013
+ status: () => 'pending' | 'resolved' | 'rejected';
2014
+ }
2015
+
2016
+ declare interface RetryerConfig<TData = unknown, TError = DefaultError> {
2017
+ fn: () => TData | Promise<TData>;
2018
+ initialPromise?: Promise<TData>;
2019
+ onCancel?: (error: TError) => void;
2020
+ onFail?: (failureCount: number, error: TError) => void;
2021
+ onPause?: () => void;
2022
+ onContinue?: () => void;
2023
+ retry?: RetryValue<TError>;
2024
+ retryDelay?: RetryDelayValue<TError>;
2025
+ networkMode: NetworkMode | undefined;
2026
+ canRun: () => boolean;
2027
+ }
2028
+
2029
+ export declare type RetryValue<TError> = boolean | number | ShouldRetryFunction<TError>;
2030
+
2031
+ declare type ScheduleFunction = (callback: () => void) => void;
2032
+
2033
+ declare interface SetDataOptions {
2034
+ updatedAt?: number;
2035
+ }
2036
+ export { SetDataOptions }
2037
+ export { SetDataOptions as SetDataOptions_alias_1 }
2038
+
2039
+ export declare function setIsServer(value: boolean): () => void;
2040
+
2041
+ declare interface SetStateAction<TData, TError> {
2042
+ type: 'setState';
2043
+ state: Partial<QueryState<TData, TError>>;
2044
+ setStateOptions?: SetStateOptions;
2045
+ }
2046
+
2047
+ export declare interface SetStateOptions {
2048
+ meta?: any;
2049
+ }
2050
+
2051
+ declare type SetupFn = (setFocused: (focused?: boolean) => void) => (() => void) | undefined;
2052
+
2053
+ declare type SetupFn_2 = (setOnline: Listener_2) => (() => void) | undefined;
2054
+
2055
+ /**
2056
+ * Shallow compare objects.
2057
+ */
2058
+ export declare function shallowEqualObjects<T extends Record<string, any>>(a: T, b: T | undefined): boolean;
2059
+
2060
+ declare type ShouldRetryFunction<TError = DefaultError> = (failureCount: number, error: TError) => boolean;
2061
+
2062
+ declare function shouldThrowError<T extends (...args: Array<any>) => boolean>(throwOnError: boolean | T | undefined, params: Parameters<T>): boolean;
2063
+ export { shouldThrowError }
2064
+ export { shouldThrowError as shouldThrowError_alias_1 }
2065
+
2066
+ declare type SimpleStreamedQueryParams<TQueryFnData, TQueryKey extends QueryKey> = BaseStreamedQueryParams<TQueryFnData, TQueryKey> & {
2067
+ reducer?: never;
2068
+ initialValue?: never;
2069
+ };
2070
+
2071
+ declare type SkipToken = typeof skipToken;
2072
+ export { SkipToken }
2073
+ export { SkipToken as SkipToken_alias_1 }
2074
+
2075
+ declare const skipToken: unique symbol;
2076
+ export { skipToken }
2077
+ export { skipToken as skipToken_alias_1 }
2078
+
2079
+ export declare function sleep(timeout: number): Promise<void>;
2080
+
2081
+ declare type StaleTime = number | 'static';
2082
+ export { StaleTime }
2083
+ export { StaleTime as StaleTime_alias_1 }
2084
+
2085
+ declare type StaleTimeFunction<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = StaleTime | ((query: Query<TQueryFnData, TError, TData, TQueryKey>) => StaleTime);
2086
+ export { StaleTimeFunction }
2087
+ export { StaleTimeFunction as StaleTimeFunction_alias_1 }
2088
+
2089
+ /**
2090
+ * This is a helper function to create a query function that streams data from an AsyncIterable.
2091
+ * Data will be an Array of all the chunks received.
2092
+ * The query will be in a 'pending' state until the first chunk of data is received, but will go to 'success' after that.
2093
+ * The query will stay in fetchStatus 'fetching' until the stream ends.
2094
+ * @param queryFn - The function that returns an AsyncIterable to stream data from.
2095
+ * @param refetchMode - Defines how re-fetches are handled.
2096
+ * Defaults to `'reset'`, erases all data and puts the query back into `pending` state.
2097
+ * Set to `'append'` to append new data to the existing data.
2098
+ * Set to `'replace'` to write all data to the cache once the stream ends.
2099
+ * @param reducer - A function to reduce the streamed chunks into the final data.
2100
+ * Defaults to a function that appends chunks to the end of the array.
2101
+ * @param initialValue - Initial value to be used while the first chunk is being fetched, and returned if the stream yields no values.
2102
+ */
2103
+ declare function streamedQuery<TQueryFnData = unknown, TData = Array<TQueryFnData>, TQueryKey extends QueryKey = QueryKey>({ streamFn, refetchMode, reducer, initialValue, }: StreamedQueryParams<TQueryFnData, TData, TQueryKey>): QueryFunction<TData, TQueryKey>;
2104
+ export { streamedQuery as experimental_streamedQuery }
2105
+ export { streamedQuery }
2106
+
2107
+ declare type StreamedQueryParams<TQueryFnData, TData, TQueryKey extends QueryKey> = SimpleStreamedQueryParams<TQueryFnData, TQueryKey> | ReducibleStreamedQueryParams<TQueryFnData, TData, TQueryKey>;
2108
+
2109
+ export declare class Subscribable<TListener extends Function> {
2110
+ protected listeners: Set<TListener>;
2111
+ constructor();
2112
+ subscribe(listener: TListener): () => void;
2113
+ hasListeners(): boolean;
2114
+ protected onSubscribe(): void;
2115
+ protected onUnsubscribe(): void;
2116
+ }
2117
+
2118
+ declare interface SuccessAction<TData> {
2119
+ data: TData | undefined;
2120
+ type: 'success';
2121
+ dataUpdatedAt?: number;
2122
+ manual?: boolean;
2123
+ }
2124
+
2125
+ declare interface SuccessAction_2<TData> {
2126
+ type: 'success';
2127
+ data: TData;
2128
+ }
2129
+
2130
+ /**
2131
+ * In many cases code wants to delay to the next event loop tick; this is not
2132
+ * mediated by {@link timeoutManager}.
2133
+ *
2134
+ * This function is provided to make auditing the `tanstack/query-core` for
2135
+ * incorrect use of system `setTimeout` easier.
2136
+ */
2137
+ export declare function systemSetTimeoutZero(callback: TimeoutCallback): void;
2138
+
2139
+ export declare type Thenable<T> = FulfilledThenable<T> | RejectedThenable<T> | PendingThenable<T>;
2140
+
2141
+ declare type ThrowOnError<TQueryFnData, TError, TQueryData, TQueryKey extends QueryKey> = boolean | ((error: TError, query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean);
2142
+ export { ThrowOnError }
2143
+ export { ThrowOnError as ThrowOnError_alias_1 }
2144
+
2145
+ /**
2146
+ * {@link TimeoutManager} does not support passing arguments to the callback.
2147
+ *
2148
+ * `(_: void)` is the argument type inferred by TypeScript's default typings for
2149
+ * `setTimeout(cb, number)`.
2150
+ * If we don't accept a single void argument, then
2151
+ * `new Promise(resolve => timeoutManager.setTimeout(resolve, N))` is a type error.
2152
+ */
2153
+ declare type TimeoutCallback = (_: void) => void;
2154
+ export { TimeoutCallback }
2155
+ export { TimeoutCallback as TimeoutCallback_alias_1 }
2156
+
2157
+ /**
2158
+ * Allows customization of how timeouts are created.
2159
+ *
2160
+ * @tanstack/query-core makes liberal use of timeouts to implement `staleTime`
2161
+ * and `gcTime`. The default TimeoutManager provider uses the platform's global
2162
+ * `setTimeout` implementation, which is known to have scalability issues with
2163
+ * thousands of timeouts on the event loop.
2164
+ *
2165
+ * If you hit this limitation, consider providing a custom TimeoutProvider that
2166
+ * coalesces timeouts.
2167
+ */
2168
+ export declare class TimeoutManager implements Omit<TimeoutProvider, 'name'> {
2169
+ #private;
2170
+ setTimeoutProvider<TTimerId extends ManagedTimerId>(provider: TimeoutProvider<TTimerId>): void;
2171
+ setTimeout(callback: TimeoutCallback, delay: number): ManagedTimerId;
2172
+ clearTimeout(timeoutId: ManagedTimerId | undefined): void;
2173
+ setInterval(callback: TimeoutCallback, delay: number): ManagedTimerId;
2174
+ clearInterval(intervalId: ManagedTimerId | undefined): void;
2175
+ }
2176
+
2177
+ declare const timeoutManager: TimeoutManager;
2178
+ export { timeoutManager }
2179
+ export { timeoutManager as timeoutManager_alias_1 }
2180
+
2181
+ /**
2182
+ * Backend for timer functions.
2183
+ */
2184
+ declare type TimeoutProvider<TTimerId extends ManagedTimerId = ManagedTimerId> = {
2185
+ readonly setTimeout: (callback: TimeoutCallback, delay: number) => TTimerId;
2186
+ readonly clearTimeout: (timeoutId: TTimerId | undefined) => void;
2187
+ readonly setInterval: (callback: TimeoutCallback, delay: number) => TTimerId;
2188
+ readonly clearInterval: (intervalId: TTimerId | undefined) => void;
2189
+ };
2190
+ export { TimeoutProvider }
2191
+ export { TimeoutProvider as TimeoutProvider_alias_1 }
2192
+
2193
+ export declare function timeUntilStale(updatedAt: number, staleTime?: number): number;
2194
+
2195
+ declare type TransformerFn = (data: any) => any;
2196
+
2197
+ /**
2198
+ * This function takes a Promise-like input and detects whether the data
2199
+ * is synchronously available or not.
2200
+ *
2201
+ * It does not inspect .status, .value or .reason properties of the promise,
2202
+ * as those are not always available, and the .status of React's promises
2203
+ * should not be considered part of the public API.
2204
+ */
2205
+ export declare function tryResolveSync(promise: Promise<unknown> | Thenable<unknown>): {
2206
+ data: {} | null;
2207
+ } | undefined;
2208
+
2209
+ declare type TuplePrefixes<T extends ReadonlyArray<unknown>> = T extends readonly [] ? readonly [] : TuplePrefixes<DropLast<T>> | T;
2210
+
2211
+ declare type UnsetMarker = typeof unsetMarker;
2212
+ export { UnsetMarker }
2213
+ export { UnsetMarker as UnsetMarker_alias_1 }
2214
+
2215
+ declare const unsetMarker: unique symbol;
2216
+ export { unsetMarker }
2217
+ export { unsetMarker as unsetMarker_alias_1 }
2218
+
2219
+ declare type Updater<TInput, TOutput> = TOutput | ((input: TInput) => TOutput);
2220
+ export { Updater }
2221
+ export { Updater as Updater_alias_1 }
2222
+
2223
+ declare type WithRequired<TTarget, TKey extends keyof TTarget> = TTarget & {
2224
+ [_ in TKey]: {};
2225
+ };
2226
+ export { WithRequired }
2227
+ export { WithRequired as WithRequired_alias_1 }
2228
+
2229
+ export { }