@tanstack/query-core 5.0.0-alpha.86 → 5.0.0-alpha.87

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 (441) hide show
  1. package/build/legacy/focusManager.cjs +116 -0
  2. package/build/legacy/focusManager.cjs.map +1 -0
  3. package/build/legacy/focusManager.d.cts +16 -0
  4. package/build/{lib → legacy}/focusManager.d.ts +6 -5
  5. package/build/legacy/focusManager.js +91 -0
  6. package/build/legacy/focusManager.js.map +1 -0
  7. package/build/legacy/hydration.cjs +109 -0
  8. package/build/legacy/hydration.cjs.map +1 -0
  9. package/build/legacy/hydration.d.cts +35 -0
  10. package/build/legacy/hydration.d.ts +35 -0
  11. package/build/legacy/hydration.js +82 -0
  12. package/build/legacy/hydration.js.map +1 -0
  13. package/build/legacy/index.cjs +85 -0
  14. package/build/legacy/index.cjs.map +1 -0
  15. package/build/legacy/index.d.cts +9 -0
  16. package/build/legacy/index.d.ts +9 -0
  17. package/build/legacy/index.js +50 -0
  18. package/build/legacy/index.js.map +1 -0
  19. package/build/legacy/infiniteQueryBehavior.cjs +141 -0
  20. package/build/legacy/infiniteQueryBehavior.cjs.map +1 -0
  21. package/build/legacy/infiniteQueryBehavior.d.cts +15 -0
  22. package/build/legacy/infiniteQueryBehavior.d.ts +15 -0
  23. package/build/legacy/infiniteQueryBehavior.js +115 -0
  24. package/build/legacy/infiniteQueryBehavior.js.map +1 -0
  25. package/build/legacy/infiniteQueryObserver.cjs +88 -0
  26. package/build/legacy/infiniteQueryObserver.cjs.map +1 -0
  27. package/build/legacy/infiniteQueryObserver.d.cts +19 -0
  28. package/build/{lib → legacy}/infiniteQueryObserver.d.ts +7 -8
  29. package/build/{lib/infiniteQueryObserver.legacy.js → legacy/infiniteQueryObserver.js} +24 -32
  30. package/build/legacy/infiniteQueryObserver.js.map +1 -0
  31. package/build/legacy/mutation.cjs +297 -0
  32. package/build/legacy/mutation.cjs.map +1 -0
  33. package/build/legacy/mutation.d.cts +3 -0
  34. package/build/legacy/mutation.d.ts +3 -0
  35. package/build/legacy/mutation.js +272 -0
  36. package/build/legacy/mutation.js.map +1 -0
  37. package/build/legacy/mutationCache.cjs +133 -0
  38. package/build/legacy/mutationCache.cjs.map +1 -0
  39. package/build/legacy/mutationCache.d.cts +3 -0
  40. package/build/legacy/mutationCache.d.ts +3 -0
  41. package/build/legacy/mutationCache.js +109 -0
  42. package/build/legacy/mutationCache.js.map +1 -0
  43. package/build/legacy/mutationObserver.cjs +171 -0
  44. package/build/legacy/mutationObserver.cjs.map +1 -0
  45. package/build/legacy/mutationObserver.d.cts +3 -0
  46. package/build/legacy/mutationObserver.d.ts +3 -0
  47. package/build/legacy/mutationObserver.js +147 -0
  48. package/build/legacy/mutationObserver.js.map +1 -0
  49. package/build/legacy/notifyManager.cjs +97 -0
  50. package/build/legacy/notifyManager.cjs.map +1 -0
  51. package/build/legacy/notifyManager.d.cts +20 -0
  52. package/build/{lib → legacy}/notifyManager.d.ts +4 -4
  53. package/build/{lib → legacy}/notifyManager.js +14 -31
  54. package/build/legacy/notifyManager.js.map +1 -0
  55. package/build/legacy/onlineManager.cjs +106 -0
  56. package/build/legacy/onlineManager.cjs.map +1 -0
  57. package/build/legacy/onlineManager.d.cts +16 -0
  58. package/build/{lib → legacy}/onlineManager.d.ts +6 -5
  59. package/build/legacy/onlineManager.js +81 -0
  60. package/build/legacy/onlineManager.js.map +1 -0
  61. package/build/legacy/queriesObserver.cjs +242 -0
  62. package/build/legacy/queriesObserver.cjs.map +1 -0
  63. package/build/legacy/queriesObserver.d.cts +26 -0
  64. package/build/{lib → legacy}/queriesObserver.d.ts +10 -11
  65. package/build/legacy/queriesObserver.js +218 -0
  66. package/build/legacy/queriesObserver.js.map +1 -0
  67. package/build/legacy/query.cjs +423 -0
  68. package/build/legacy/query.cjs.map +1 -0
  69. package/build/legacy/query.d.cts +3 -0
  70. package/build/legacy/query.d.ts +3 -0
  71. package/build/legacy/query.js +399 -0
  72. package/build/legacy/query.js.map +1 -0
  73. package/build/legacy/queryCache.cjs +140 -0
  74. package/build/legacy/queryCache.cjs.map +1 -0
  75. package/build/legacy/queryCache.d.cts +3 -0
  76. package/build/legacy/queryCache.d.ts +3 -0
  77. package/build/legacy/queryCache.js +116 -0
  78. package/build/legacy/queryCache.js.map +1 -0
  79. package/build/legacy/queryClient-4ba6364e.d.ts +916 -0
  80. package/build/legacy/queryClient-d615ed9f.d.ts +916 -0
  81. package/build/legacy/queryClient.cjs +322 -0
  82. package/build/legacy/queryClient.cjs.map +1 -0
  83. package/build/legacy/queryClient.d.cts +3 -0
  84. package/build/legacy/queryClient.d.ts +3 -0
  85. package/build/legacy/queryClient.js +304 -0
  86. package/build/legacy/queryClient.js.map +1 -0
  87. package/build/legacy/queryObserver.cjs +501 -0
  88. package/build/legacy/queryObserver.cjs.map +1 -0
  89. package/build/legacy/queryObserver.d.cts +3 -0
  90. package/build/legacy/queryObserver.d.ts +3 -0
  91. package/build/legacy/queryObserver.js +484 -0
  92. package/build/legacy/queryObserver.js.map +1 -0
  93. package/build/legacy/removable.cjs +77 -0
  94. package/build/legacy/removable.cjs.map +1 -0
  95. package/build/legacy/removable.d.cts +11 -0
  96. package/build/{lib → legacy}/removable.d.ts +3 -2
  97. package/build/legacy/removable.js +53 -0
  98. package/build/legacy/removable.js.map +1 -0
  99. package/build/legacy/retryer.cjs +169 -0
  100. package/build/legacy/retryer.cjs.map +1 -0
  101. package/build/legacy/retryer.d.cts +3 -0
  102. package/build/legacy/retryer.d.ts +3 -0
  103. package/build/{lib/retryer.legacy.js → legacy/retryer.js} +37 -48
  104. package/build/legacy/retryer.js.map +1 -0
  105. package/build/legacy/subscribable.cjs +49 -0
  106. package/build/legacy/subscribable.cjs.map +1 -0
  107. package/build/legacy/subscribable.d.cts +11 -0
  108. package/build/{lib → legacy}/subscribable.d.ts +3 -3
  109. package/build/{lib → legacy}/subscribable.js +5 -6
  110. package/build/legacy/subscribable.js.map +1 -0
  111. package/build/legacy/types.cjs +17 -0
  112. package/build/legacy/types.cjs.map +1 -0
  113. package/build/legacy/types.d.cts +3 -0
  114. package/build/legacy/types.d.ts +3 -0
  115. package/build/legacy/types.js +1 -0
  116. package/build/legacy/types.js.map +1 -0
  117. package/build/{lib/utils.legacy.cjs → legacy/utils.cjs} +92 -93
  118. package/build/legacy/utils.cjs.map +1 -0
  119. package/build/legacy/utils.d.cts +3 -0
  120. package/build/legacy/utils.d.ts +3 -0
  121. package/build/{lib/utils.legacy.js → legacy/utils.js} +49 -72
  122. package/build/legacy/utils.js.map +1 -0
  123. package/build/modern/focusManager.cjs +91 -0
  124. package/build/modern/focusManager.cjs.map +1 -0
  125. package/build/modern/focusManager.d.cts +16 -0
  126. package/build/modern/focusManager.d.ts +16 -0
  127. package/build/modern/focusManager.js +66 -0
  128. package/build/modern/focusManager.js.map +1 -0
  129. package/build/modern/hydration.cjs +107 -0
  130. package/build/modern/hydration.cjs.map +1 -0
  131. package/build/modern/hydration.d.cts +35 -0
  132. package/build/modern/hydration.d.ts +35 -0
  133. package/build/modern/hydration.js +80 -0
  134. package/build/modern/hydration.js.map +1 -0
  135. package/build/modern/index.cjs +85 -0
  136. package/build/modern/index.cjs.map +1 -0
  137. package/build/modern/index.d.cts +9 -0
  138. package/build/modern/index.d.ts +9 -0
  139. package/build/modern/index.js +50 -0
  140. package/build/modern/index.js.map +1 -0
  141. package/build/modern/infiniteQueryBehavior.cjs +138 -0
  142. package/build/modern/infiniteQueryBehavior.cjs.map +1 -0
  143. package/build/modern/infiniteQueryBehavior.d.cts +15 -0
  144. package/build/modern/infiniteQueryBehavior.d.ts +15 -0
  145. package/build/{lib → modern}/infiniteQueryBehavior.js +46 -53
  146. package/build/modern/infiniteQueryBehavior.js.map +1 -0
  147. package/build/modern/infiniteQueryObserver.cjs +87 -0
  148. package/build/modern/infiniteQueryObserver.cjs.map +1 -0
  149. package/build/modern/infiniteQueryObserver.d.cts +19 -0
  150. package/build/modern/infiniteQueryObserver.d.ts +19 -0
  151. package/build/{lib → modern}/infiniteQueryObserver.js +23 -31
  152. package/build/modern/infiniteQueryObserver.js.map +1 -0
  153. package/build/modern/mutation.cjs +259 -0
  154. package/build/modern/mutation.cjs.map +1 -0
  155. package/build/modern/mutation.d.cts +3 -0
  156. package/build/modern/mutation.d.ts +3 -0
  157. package/build/{lib → modern}/mutation.js +86 -86
  158. package/build/modern/mutation.js.map +1 -0
  159. package/build/modern/mutationCache.cjs +103 -0
  160. package/build/modern/mutationCache.cjs.map +1 -0
  161. package/build/modern/mutationCache.d.cts +3 -0
  162. package/build/modern/mutationCache.d.ts +3 -0
  163. package/build/modern/mutationCache.js +79 -0
  164. package/build/modern/mutationCache.js.map +1 -0
  165. package/build/modern/mutationObserver.cjs +132 -0
  166. package/build/modern/mutationObserver.cjs.map +1 -0
  167. package/build/modern/mutationObserver.d.cts +3 -0
  168. package/build/modern/mutationObserver.d.ts +3 -0
  169. package/build/{lib → modern}/mutationObserver.js +44 -32
  170. package/build/modern/mutationObserver.js.map +1 -0
  171. package/build/modern/notifyManager.cjs +97 -0
  172. package/build/modern/notifyManager.cjs.map +1 -0
  173. package/build/modern/notifyManager.d.cts +20 -0
  174. package/build/modern/notifyManager.d.ts +20 -0
  175. package/build/{lib/notifyManager.legacy.js → modern/notifyManager.js} +14 -31
  176. package/build/modern/notifyManager.js.map +1 -0
  177. package/build/modern/onlineManager.cjs +82 -0
  178. package/build/modern/onlineManager.cjs.map +1 -0
  179. package/build/modern/onlineManager.d.cts +16 -0
  180. package/build/modern/onlineManager.d.ts +16 -0
  181. package/build/{lib → modern}/onlineManager.js +14 -17
  182. package/build/modern/onlineManager.js.map +1 -0
  183. package/build/modern/queriesObserver.cjs +202 -0
  184. package/build/modern/queriesObserver.cjs.map +1 -0
  185. package/build/modern/queriesObserver.d.cts +26 -0
  186. package/build/modern/queriesObserver.d.ts +26 -0
  187. package/build/{lib → modern}/queriesObserver.js +69 -50
  188. package/build/modern/queriesObserver.js.map +1 -0
  189. package/build/{lib → modern}/query.cjs +143 -186
  190. package/build/modern/query.cjs.map +1 -0
  191. package/build/modern/query.d.cts +3 -0
  192. package/build/modern/query.d.ts +3 -0
  193. package/build/{lib → modern}/query.js +110 -175
  194. package/build/modern/query.js.map +1 -0
  195. package/build/modern/queryCache.cjs +120 -0
  196. package/build/modern/queryCache.cjs.map +1 -0
  197. package/build/modern/queryCache.d.cts +3 -0
  198. package/build/modern/queryCache.d.ts +3 -0
  199. package/build/{lib → modern}/queryCache.js +21 -29
  200. package/build/modern/queryCache.js.map +1 -0
  201. package/build/modern/queryClient-4ba6364e.d.ts +916 -0
  202. package/build/modern/queryClient-d615ed9f.d.ts +916 -0
  203. package/build/modern/queryClient.cjs +284 -0
  204. package/build/modern/queryClient.cjs.map +1 -0
  205. package/build/modern/queryClient.d.cts +3 -0
  206. package/build/modern/queryClient.d.ts +3 -0
  207. package/build/{lib → modern}/queryClient.js +77 -94
  208. package/build/modern/queryClient.js.map +1 -0
  209. package/build/{lib → modern}/queryObserver.cjs +133 -149
  210. package/build/modern/queryObserver.cjs.map +1 -0
  211. package/build/modern/queryObserver.d.cts +3 -0
  212. package/build/modern/queryObserver.d.ts +3 -0
  213. package/build/{lib → modern}/queryObserver.js +107 -138
  214. package/build/modern/queryObserver.js.map +1 -0
  215. package/build/modern/removable.cjs +55 -0
  216. package/build/modern/removable.cjs.map +1 -0
  217. package/build/modern/removable.d.cts +11 -0
  218. package/build/modern/removable.d.ts +11 -0
  219. package/build/{lib → modern}/removable.js +10 -8
  220. package/build/modern/removable.js.map +1 -0
  221. package/build/{lib → modern}/retryer.cjs +50 -44
  222. package/build/modern/retryer.cjs.map +1 -0
  223. package/build/modern/retryer.d.cts +3 -0
  224. package/build/modern/retryer.d.ts +3 -0
  225. package/build/{lib → modern}/retryer.js +23 -39
  226. package/build/modern/retryer.js.map +1 -0
  227. package/build/modern/subscribable.cjs +49 -0
  228. package/build/modern/subscribable.cjs.map +1 -0
  229. package/build/modern/subscribable.d.cts +11 -0
  230. package/build/modern/subscribable.d.ts +11 -0
  231. package/build/{lib/subscribable.legacy.js → modern/subscribable.js} +5 -6
  232. package/build/modern/subscribable.js.map +1 -0
  233. package/build/modern/types.cjs +17 -0
  234. package/build/modern/types.cjs.map +1 -0
  235. package/build/modern/types.d.cts +3 -0
  236. package/build/modern/types.d.ts +3 -0
  237. package/build/modern/types.js +1 -0
  238. package/build/modern/types.js.map +1 -0
  239. package/build/{lib → modern}/utils.cjs +92 -93
  240. package/build/modern/utils.cjs.map +1 -0
  241. package/build/modern/utils.d.cts +3 -0
  242. package/build/modern/utils.d.ts +3 -0
  243. package/build/{lib → modern}/utils.js +49 -72
  244. package/build/modern/utils.js.map +1 -0
  245. package/package.json +15 -13
  246. package/build/lib/_virtual/_rollupPluginBabelHelpers.legacy.cjs +0 -16
  247. package/build/lib/_virtual/_rollupPluginBabelHelpers.legacy.cjs.map +0 -1
  248. package/build/lib/_virtual/_rollupPluginBabelHelpers.legacy.js +0 -13
  249. package/build/lib/_virtual/_rollupPluginBabelHelpers.legacy.js.map +0 -1
  250. package/build/lib/focusManager.cjs +0 -75
  251. package/build/lib/focusManager.cjs.map +0 -1
  252. package/build/lib/focusManager.d.ts.map +0 -1
  253. package/build/lib/focusManager.js +0 -72
  254. package/build/lib/focusManager.js.map +0 -1
  255. package/build/lib/focusManager.legacy.cjs +0 -91
  256. package/build/lib/focusManager.legacy.cjs.map +0 -1
  257. package/build/lib/focusManager.legacy.js +0 -88
  258. package/build/lib/focusManager.legacy.js.map +0 -1
  259. package/build/lib/hydration.cjs +0 -97
  260. package/build/lib/hydration.cjs.map +0 -1
  261. package/build/lib/hydration.d.ts +0 -35
  262. package/build/lib/hydration.d.ts.map +0 -1
  263. package/build/lib/hydration.js +0 -92
  264. package/build/lib/hydration.js.map +0 -1
  265. package/build/lib/hydration.legacy.cjs +0 -100
  266. package/build/lib/hydration.legacy.cjs.map +0 -1
  267. package/build/lib/hydration.legacy.js +0 -95
  268. package/build/lib/hydration.legacy.js.map +0 -1
  269. package/build/lib/index.cjs +0 -40
  270. package/build/lib/index.cjs.map +0 -1
  271. package/build/lib/index.d.ts +0 -22
  272. package/build/lib/index.d.ts.map +0 -1
  273. package/build/lib/index.js +0 -14
  274. package/build/lib/index.js.map +0 -1
  275. package/build/lib/index.legacy.cjs +0 -40
  276. package/build/lib/index.legacy.cjs.map +0 -1
  277. package/build/lib/index.legacy.js +0 -14
  278. package/build/lib/index.legacy.js.map +0 -1
  279. package/build/lib/infiniteQueryBehavior.cjs +0 -123
  280. package/build/lib/infiniteQueryBehavior.cjs.map +0 -1
  281. package/build/lib/infiniteQueryBehavior.d.ts +0 -12
  282. package/build/lib/infiniteQueryBehavior.d.ts.map +0 -1
  283. package/build/lib/infiniteQueryBehavior.js.map +0 -1
  284. package/build/lib/infiniteQueryBehavior.legacy.cjs +0 -125
  285. package/build/lib/infiniteQueryBehavior.legacy.cjs.map +0 -1
  286. package/build/lib/infiniteQueryBehavior.legacy.js +0 -121
  287. package/build/lib/infiniteQueryBehavior.legacy.js.map +0 -1
  288. package/build/lib/infiniteQueryObserver.cjs +0 -77
  289. package/build/lib/infiniteQueryObserver.cjs.map +0 -1
  290. package/build/lib/infiniteQueryObserver.d.ts.map +0 -1
  291. package/build/lib/infiniteQueryObserver.js.map +0 -1
  292. package/build/lib/infiniteQueryObserver.legacy.cjs +0 -78
  293. package/build/lib/infiniteQueryObserver.legacy.cjs.map +0 -1
  294. package/build/lib/infiniteQueryObserver.legacy.js.map +0 -1
  295. package/build/lib/mutation.cjs +0 -237
  296. package/build/lib/mutation.cjs.map +0 -1
  297. package/build/lib/mutation.d.ts +0 -64
  298. package/build/lib/mutation.d.ts.map +0 -1
  299. package/build/lib/mutation.js.map +0 -1
  300. package/build/lib/mutation.legacy.cjs +0 -262
  301. package/build/lib/mutation.legacy.cjs.map +0 -1
  302. package/build/lib/mutation.legacy.js +0 -259
  303. package/build/lib/mutation.legacy.js.map +0 -1
  304. package/build/lib/mutationCache.cjs +0 -85
  305. package/build/lib/mutationCache.cjs.map +0 -1
  306. package/build/lib/mutationCache.d.ts +0 -59
  307. package/build/lib/mutationCache.d.ts.map +0 -1
  308. package/build/lib/mutationCache.js +0 -83
  309. package/build/lib/mutationCache.js.map +0 -1
  310. package/build/lib/mutationCache.legacy.cjs +0 -98
  311. package/build/lib/mutationCache.legacy.cjs.map +0 -1
  312. package/build/lib/mutationCache.legacy.js +0 -96
  313. package/build/lib/mutationCache.legacy.js.map +0 -1
  314. package/build/lib/mutationObserver.cjs +0 -98
  315. package/build/lib/mutationObserver.cjs.map +0 -1
  316. package/build/lib/mutationObserver.d.ts +0 -19
  317. package/build/lib/mutationObserver.d.ts.map +0 -1
  318. package/build/lib/mutationObserver.js.map +0 -1
  319. package/build/lib/mutationObserver.legacy.cjs +0 -128
  320. package/build/lib/mutationObserver.legacy.cjs.map +0 -1
  321. package/build/lib/mutationObserver.legacy.js +0 -126
  322. package/build/lib/mutationObserver.legacy.js.map +0 -1
  323. package/build/lib/notifyManager.cjs +0 -92
  324. package/build/lib/notifyManager.cjs.map +0 -1
  325. package/build/lib/notifyManager.d.ts.map +0 -1
  326. package/build/lib/notifyManager.js.map +0 -1
  327. package/build/lib/notifyManager.legacy.cjs +0 -92
  328. package/build/lib/notifyManager.legacy.cjs.map +0 -1
  329. package/build/lib/notifyManager.legacy.js.map +0 -1
  330. package/build/lib/onlineManager.cjs +0 -63
  331. package/build/lib/onlineManager.cjs.map +0 -1
  332. package/build/lib/onlineManager.d.ts.map +0 -1
  333. package/build/lib/onlineManager.js.map +0 -1
  334. package/build/lib/onlineManager.legacy.cjs +0 -78
  335. package/build/lib/onlineManager.legacy.cjs.map +0 -1
  336. package/build/lib/onlineManager.legacy.js +0 -75
  337. package/build/lib/onlineManager.legacy.js.map +0 -1
  338. package/build/lib/queriesObserver.cjs +0 -161
  339. package/build/lib/queriesObserver.cjs.map +0 -1
  340. package/build/lib/queriesObserver.d.ts.map +0 -1
  341. package/build/lib/queriesObserver.js.map +0 -1
  342. package/build/lib/queriesObserver.legacy.cjs +0 -207
  343. package/build/lib/queriesObserver.legacy.cjs.map +0 -1
  344. package/build/lib/queriesObserver.legacy.js +0 -205
  345. package/build/lib/queriesObserver.legacy.js.map +0 -1
  346. package/build/lib/query.cjs.map +0 -1
  347. package/build/lib/query.d.ts +0 -115
  348. package/build/lib/query.d.ts.map +0 -1
  349. package/build/lib/query.js.map +0 -1
  350. package/build/lib/query.legacy.cjs +0 -471
  351. package/build/lib/query.legacy.cjs.map +0 -1
  352. package/build/lib/query.legacy.js +0 -469
  353. package/build/lib/query.legacy.js.map +0 -1
  354. package/build/lib/queryCache.cjs +0 -106
  355. package/build/lib/queryCache.cjs.map +0 -1
  356. package/build/lib/queryCache.d.ts +0 -71
  357. package/build/lib/queryCache.d.ts.map +0 -1
  358. package/build/lib/queryCache.js.map +0 -1
  359. package/build/lib/queryCache.legacy.cjs +0 -111
  360. package/build/lib/queryCache.legacy.cjs.map +0 -1
  361. package/build/lib/queryCache.legacy.js +0 -109
  362. package/build/lib/queryCache.legacy.js.map +0 -1
  363. package/build/lib/queryClient.cjs +0 -285
  364. package/build/lib/queryClient.cjs.map +0 -1
  365. package/build/lib/queryClient.d.ts +0 -41
  366. package/build/lib/queryClient.d.ts.map +0 -1
  367. package/build/lib/queryClient.js.map +0 -1
  368. package/build/lib/queryClient.legacy.cjs +0 -322
  369. package/build/lib/queryClient.legacy.cjs.map +0 -1
  370. package/build/lib/queryClient.legacy.js +0 -320
  371. package/build/lib/queryClient.legacy.js.map +0 -1
  372. package/build/lib/queryObserver.cjs.map +0 -1
  373. package/build/lib/queryObserver.d.ts +0 -35
  374. package/build/lib/queryObserver.d.ts.map +0 -1
  375. package/build/lib/queryObserver.js.map +0 -1
  376. package/build/lib/queryObserver.legacy.cjs +0 -561
  377. package/build/lib/queryObserver.legacy.cjs.map +0 -1
  378. package/build/lib/queryObserver.legacy.js +0 -559
  379. package/build/lib/queryObserver.legacy.js.map +0 -1
  380. package/build/lib/removable.cjs +0 -31
  381. package/build/lib/removable.cjs.map +0 -1
  382. package/build/lib/removable.d.ts.map +0 -1
  383. package/build/lib/removable.js.map +0 -1
  384. package/build/lib/removable.legacy.cjs +0 -38
  385. package/build/lib/removable.legacy.cjs.map +0 -1
  386. package/build/lib/removable.legacy.js +0 -36
  387. package/build/lib/removable.legacy.js.map +0 -1
  388. package/build/lib/retryer.cjs.map +0 -1
  389. package/build/lib/retryer.d.ts +0 -34
  390. package/build/lib/retryer.d.ts.map +0 -1
  391. package/build/lib/retryer.js.map +0 -1
  392. package/build/lib/retryer.legacy.cjs +0 -158
  393. package/build/lib/retryer.legacy.cjs.map +0 -1
  394. package/build/lib/retryer.legacy.js.map +0 -1
  395. package/build/lib/subscribable.cjs +0 -28
  396. package/build/lib/subscribable.cjs.map +0 -1
  397. package/build/lib/subscribable.d.ts.map +0 -1
  398. package/build/lib/subscribable.js.map +0 -1
  399. package/build/lib/subscribable.legacy.cjs +0 -28
  400. package/build/lib/subscribable.legacy.cjs.map +0 -1
  401. package/build/lib/subscribable.legacy.js.map +0 -1
  402. package/build/lib/tests/focusManager.test.d.ts +0 -2
  403. package/build/lib/tests/focusManager.test.d.ts.map +0 -1
  404. package/build/lib/tests/hydration.test.d.ts +0 -2
  405. package/build/lib/tests/hydration.test.d.ts.map +0 -1
  406. package/build/lib/tests/infiniteQueryBehavior.test.d.ts +0 -2
  407. package/build/lib/tests/infiniteQueryBehavior.test.d.ts.map +0 -1
  408. package/build/lib/tests/infiniteQueryObserver.test.d.ts +0 -2
  409. package/build/lib/tests/infiniteQueryObserver.test.d.ts.map +0 -1
  410. package/build/lib/tests/mutationCache.test.d.ts +0 -2
  411. package/build/lib/tests/mutationCache.test.d.ts.map +0 -1
  412. package/build/lib/tests/mutationObserver.test.d.ts +0 -2
  413. package/build/lib/tests/mutationObserver.test.d.ts.map +0 -1
  414. package/build/lib/tests/mutations.test.d.ts +0 -2
  415. package/build/lib/tests/mutations.test.d.ts.map +0 -1
  416. package/build/lib/tests/notifyManager.test.d.ts +0 -2
  417. package/build/lib/tests/notifyManager.test.d.ts.map +0 -1
  418. package/build/lib/tests/onlineManager.test.d.ts +0 -2
  419. package/build/lib/tests/onlineManager.test.d.ts.map +0 -1
  420. package/build/lib/tests/queriesObserver.test.d.ts +0 -2
  421. package/build/lib/tests/queriesObserver.test.d.ts.map +0 -1
  422. package/build/lib/tests/query.test.d.ts +0 -2
  423. package/build/lib/tests/query.test.d.ts.map +0 -1
  424. package/build/lib/tests/queryCache.test.d.ts +0 -2
  425. package/build/lib/tests/queryCache.test.d.ts.map +0 -1
  426. package/build/lib/tests/queryClient.test.d.ts +0 -2
  427. package/build/lib/tests/queryClient.test.d.ts.map +0 -1
  428. package/build/lib/tests/queryObserver.test.d.ts +0 -2
  429. package/build/lib/tests/queryObserver.test.d.ts.map +0 -1
  430. package/build/lib/tests/utils.d.ts +0 -17
  431. package/build/lib/tests/utils.d.ts.map +0 -1
  432. package/build/lib/tests/utils.test.d.ts +0 -2
  433. package/build/lib/tests/utils.test.d.ts.map +0 -1
  434. package/build/lib/types.d.ts +0 -437
  435. package/build/lib/types.d.ts.map +0 -1
  436. package/build/lib/utils.cjs.map +0 -1
  437. package/build/lib/utils.d.ts +0 -90
  438. package/build/lib/utils.d.ts.map +0 -1
  439. package/build/lib/utils.js.map +0 -1
  440. package/build/lib/utils.legacy.cjs.map +0 -1
  441. package/build/lib/utils.legacy.js.map +0 -1
@@ -0,0 +1,916 @@
1
+ import { Removable } from './removable.cjs';
2
+ import { Subscribable } from './subscribable.cjs';
3
+
4
+ type MutationObserverListener<TData, TError, TVariables, TContext> = (result: MutationObserverResult<TData, TError, TVariables, TContext>) => void;
5
+ declare class MutationObserver<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends Subscribable<MutationObserverListener<TData, TError, TVariables, TContext>> {
6
+ #private;
7
+ options: MutationObserverOptions<TData, TError, TVariables, TContext>;
8
+ constructor(client: QueryClient, options: MutationObserverOptions<TData, TError, TVariables, TContext>);
9
+ protected bindMethods(): void;
10
+ setOptions(options?: MutationObserverOptions<TData, TError, TVariables, TContext>): void;
11
+ protected onUnsubscribe(): void;
12
+ onMutationUpdate(action: Action$1<TData, TError, TVariables, TContext>): void;
13
+ getCurrentResult(): MutationObserverResult<TData, TError, TVariables, TContext>;
14
+ reset(): void;
15
+ mutate(variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>): Promise<TData>;
16
+ }
17
+
18
+ interface QueryFilters {
19
+ /**
20
+ * Filter to active queries, inactive queries or all queries
21
+ */
22
+ type?: QueryTypeFilter;
23
+ /**
24
+ * Match query key exactly
25
+ */
26
+ exact?: boolean;
27
+ /**
28
+ * Include queries matching this predicate function
29
+ */
30
+ predicate?: (query: Query) => boolean;
31
+ /**
32
+ * Include queries matching this query key
33
+ */
34
+ queryKey?: QueryKey;
35
+ /**
36
+ * Include or exclude stale queries
37
+ */
38
+ stale?: boolean;
39
+ /**
40
+ * Include queries matching their fetchStatus
41
+ */
42
+ fetchStatus?: FetchStatus;
43
+ }
44
+ interface MutationFilters {
45
+ /**
46
+ * Match mutation key exactly
47
+ */
48
+ exact?: boolean;
49
+ /**
50
+ * Include mutations matching this predicate function
51
+ */
52
+ predicate?: (mutation: Mutation<any, any, any>) => boolean;
53
+ /**
54
+ * Include mutations matching this mutation key
55
+ */
56
+ mutationKey?: MutationKey;
57
+ /**
58
+ * Filter by mutation status
59
+ */
60
+ status?: MutationStatus;
61
+ }
62
+ type DataUpdateFunction<TInput, TOutput> = (input: TInput) => TOutput;
63
+ type Updater<TInput, TOutput> = TOutput | DataUpdateFunction<TInput, TOutput>;
64
+ type QueryTypeFilter = 'all' | 'active' | 'inactive';
65
+ declare const isServer: boolean;
66
+ declare function noop(): undefined;
67
+ declare function functionalUpdate<TInput, TOutput>(updater: Updater<TInput, TOutput>, input: TInput): TOutput;
68
+ declare function isValidTimeout(value: unknown): value is number;
69
+ declare function timeUntilStale(updatedAt: number, staleTime?: number): number;
70
+ declare function matchQuery(filters: QueryFilters, query: Query<any, any, any, any>): boolean;
71
+ declare function matchMutation(filters: MutationFilters, mutation: Mutation<any, any>): boolean;
72
+ declare function hashQueryKeyByOptions<TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: QueryOptions<any, any, any, TQueryKey>): string;
73
+ /**
74
+ * Default query & mutation keys hash function.
75
+ * Hashes the value into a stable hash.
76
+ */
77
+ declare function hashKey(queryKey: QueryKey | MutationKey): string;
78
+ /**
79
+ * Checks if key `b` partially matches with key `a`.
80
+ */
81
+ declare function partialMatchKey(a: QueryKey, b: QueryKey): boolean;
82
+ /**
83
+ * This function returns `a` if `b` is deeply equal.
84
+ * If not, it will replace any deeply equal children of `b` with those of `a`.
85
+ * This can be used for structural sharing between JSON values for example.
86
+ */
87
+ declare function replaceEqualDeep<T>(a: unknown, b: T): T;
88
+ /**
89
+ * Shallow compare objects. Only works with objects that always have the same properties.
90
+ */
91
+ declare function shallowEqualObjects<T>(a: T, b: T): boolean;
92
+ declare function isPlainArray(value: unknown): boolean;
93
+ declare function isPlainObject(o: any): o is Object;
94
+ declare function sleep(timeout: number): Promise<void>;
95
+ /**
96
+ * Schedules a microtask.
97
+ * This can be useful to schedule state updates after rendering.
98
+ */
99
+ declare function scheduleMicrotask(callback: () => void): void;
100
+ declare function replaceData<TData, TOptions extends QueryOptions<any, any, any, any>>(prevData: TData | undefined, data: TData, options: TOptions): TData;
101
+ declare function keepPreviousData<T>(previousData: T | undefined): T | undefined;
102
+ declare function addToEnd<T>(items: T[], item: T, max?: number): T[];
103
+ declare function addToStart<T>(items: T[], item: T, max?: number): T[];
104
+
105
+ interface MutationCacheConfig {
106
+ onError?: (error: DefaultError, variables: unknown, context: unknown, mutation: Mutation<unknown, unknown, unknown>) => Promise<unknown> | unknown;
107
+ onSuccess?: (data: unknown, variables: unknown, context: unknown, mutation: Mutation<unknown, unknown, unknown>) => Promise<unknown> | unknown;
108
+ onMutate?: (variables: unknown, mutation: Mutation<unknown, unknown, unknown>) => Promise<unknown> | unknown;
109
+ onSettled?: (data: unknown | undefined, error: DefaultError | null, variables: unknown, context: unknown, mutation: Mutation<unknown, unknown, unknown>) => Promise<unknown> | unknown;
110
+ }
111
+ interface NotifyEventMutationAdded extends NotifyEvent {
112
+ type: 'added';
113
+ mutation: Mutation<any, any, any, any>;
114
+ }
115
+ interface NotifyEventMutationRemoved extends NotifyEvent {
116
+ type: 'removed';
117
+ mutation: Mutation<any, any, any, any>;
118
+ }
119
+ interface NotifyEventMutationObserverAdded extends NotifyEvent {
120
+ type: 'observerAdded';
121
+ mutation: Mutation<any, any, any, any>;
122
+ observer: MutationObserver<any, any, any>;
123
+ }
124
+ interface NotifyEventMutationObserverRemoved extends NotifyEvent {
125
+ type: 'observerRemoved';
126
+ mutation: Mutation<any, any, any, any>;
127
+ observer: MutationObserver<any, any, any>;
128
+ }
129
+ interface NotifyEventMutationObserverOptionsUpdated extends NotifyEvent {
130
+ type: 'observerOptionsUpdated';
131
+ mutation?: Mutation<any, any, any, any>;
132
+ observer: MutationObserver<any, any, any, any>;
133
+ }
134
+ interface NotifyEventMutationUpdated extends NotifyEvent {
135
+ type: 'updated';
136
+ mutation: Mutation<any, any, any, any>;
137
+ action: Action$1<any, any, any, any>;
138
+ }
139
+ type MutationCacheNotifyEvent = NotifyEventMutationAdded | NotifyEventMutationRemoved | NotifyEventMutationObserverAdded | NotifyEventMutationObserverRemoved | NotifyEventMutationObserverOptionsUpdated | NotifyEventMutationUpdated;
140
+ type MutationCacheListener = (event: MutationCacheNotifyEvent) => void;
141
+ declare class MutationCache extends Subscribable<MutationCacheListener> {
142
+ #private;
143
+ config: MutationCacheConfig;
144
+ constructor(config?: MutationCacheConfig);
145
+ build<TData, TError, TVariables, TContext>(client: QueryClient, options: MutationOptions<TData, TError, TVariables, TContext>, state?: MutationState<TData, TError, TVariables, TContext>): Mutation<TData, TError, TVariables, TContext>;
146
+ add(mutation: Mutation<any, any, any, any>): void;
147
+ remove(mutation: Mutation<any, any, any, any>): void;
148
+ clear(): void;
149
+ getAll(): Mutation[];
150
+ find<TData = unknown, TError = DefaultError, TVariables = any, TContext = unknown>(filters: MutationFilters): Mutation<TData, TError, TVariables, TContext> | undefined;
151
+ findAll(filters?: MutationFilters): Mutation[];
152
+ notify(event: MutationCacheNotifyEvent): void;
153
+ resumePausedMutations(): Promise<unknown>;
154
+ }
155
+
156
+ interface MutationConfig<TData, TError, TVariables, TContext> {
157
+ mutationId: number;
158
+ mutationCache: MutationCache;
159
+ options: MutationOptions<TData, TError, TVariables, TContext>;
160
+ defaultOptions?: MutationOptions<TData, TError, TVariables, TContext>;
161
+ state?: MutationState<TData, TError, TVariables, TContext>;
162
+ }
163
+ interface MutationState<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> {
164
+ context: TContext | undefined;
165
+ data: TData | undefined;
166
+ error: TError | null;
167
+ failureCount: number;
168
+ failureReason: TError | null;
169
+ isPaused: boolean;
170
+ status: MutationStatus;
171
+ variables: TVariables | undefined;
172
+ submittedAt: number;
173
+ }
174
+ interface FailedAction$1<TError> {
175
+ type: 'failed';
176
+ failureCount: number;
177
+ error: TError | null;
178
+ }
179
+ interface PendingAction<TVariables, TContext> {
180
+ type: 'pending';
181
+ variables?: TVariables;
182
+ context?: TContext;
183
+ }
184
+ interface SuccessAction$1<TData> {
185
+ type: 'success';
186
+ data: TData;
187
+ }
188
+ interface ErrorAction$1<TError> {
189
+ type: 'error';
190
+ error: TError;
191
+ }
192
+ interface PauseAction$1 {
193
+ type: 'pause';
194
+ }
195
+ interface ContinueAction$1 {
196
+ type: 'continue';
197
+ }
198
+ type Action$1<TData, TError, TVariables, TContext> = ContinueAction$1 | ErrorAction$1<TError> | FailedAction$1<TError> | PendingAction<TVariables, TContext> | PauseAction$1 | SuccessAction$1<TData>;
199
+ declare class Mutation<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends Removable {
200
+ #private;
201
+ state: MutationState<TData, TError, TVariables, TContext>;
202
+ options: MutationOptions<TData, TError, TVariables, TContext>;
203
+ readonly mutationId: number;
204
+ constructor(config: MutationConfig<TData, TError, TVariables, TContext>);
205
+ setOptions(options?: MutationOptions<TData, TError, TVariables, TContext>): void;
206
+ get meta(): MutationMeta | undefined;
207
+ addObserver(observer: MutationObserver<any, any, any, any>): void;
208
+ removeObserver(observer: MutationObserver<any, any, any, any>): void;
209
+ protected optionalRemove(): void;
210
+ continue(): Promise<unknown>;
211
+ execute(variables: TVariables): Promise<TData>;
212
+ }
213
+ declare function getDefaultState<TData, TError, TVariables, TContext>(): MutationState<TData, TError, TVariables, TContext>;
214
+
215
+ interface RetryerConfig<TData = unknown, TError = DefaultError> {
216
+ fn: () => TData | Promise<TData>;
217
+ abort?: () => void;
218
+ onError?: (error: TError) => void;
219
+ onSuccess?: (data: TData) => void;
220
+ onFail?: (failureCount: number, error: TError) => void;
221
+ onPause?: () => void;
222
+ onContinue?: () => void;
223
+ retry?: RetryValue<TError>;
224
+ retryDelay?: RetryDelayValue<TError>;
225
+ networkMode: NetworkMode | undefined;
226
+ }
227
+ interface Retryer<TData = unknown> {
228
+ promise: Promise<TData>;
229
+ cancel: (cancelOptions?: CancelOptions) => void;
230
+ continue: () => Promise<unknown>;
231
+ cancelRetry: () => void;
232
+ continueRetry: () => void;
233
+ }
234
+ type RetryValue<TError> = boolean | number | ShouldRetryFunction<TError>;
235
+ type ShouldRetryFunction<TError = DefaultError> = (failureCount: number, error: TError) => boolean;
236
+ type RetryDelayValue<TError> = number | RetryDelayFunction<TError>;
237
+ type RetryDelayFunction<TError = DefaultError> = (failureCount: number, error: TError) => number;
238
+ declare function canFetch(networkMode: NetworkMode | undefined): boolean;
239
+ declare class CancelledError {
240
+ revert?: boolean;
241
+ silent?: boolean;
242
+ constructor(options?: CancelOptions);
243
+ }
244
+ declare function isCancelledError(value: any): value is CancelledError;
245
+ declare function createRetryer<TData = unknown, TError = DefaultError>(config: RetryerConfig<TData, TError>): Retryer<TData>;
246
+
247
+ interface Register {
248
+ }
249
+ type DefaultError = Register extends {
250
+ defaultError: infer TError;
251
+ } ? TError : Error;
252
+ type QueryKey = readonly unknown[];
253
+ type QueryFunction<T = unknown, TQueryKey extends QueryKey = QueryKey, TPageParam = never> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>;
254
+ type QueryFunctionContext<TQueryKey extends QueryKey = QueryKey, TPageParam = never> = [TPageParam] extends [never] ? {
255
+ queryKey: TQueryKey;
256
+ signal: AbortSignal;
257
+ meta: QueryMeta | undefined;
258
+ } : {
259
+ queryKey: TQueryKey;
260
+ signal: AbortSignal;
261
+ pageParam: TPageParam;
262
+ direction: FetchDirection;
263
+ meta: QueryMeta | undefined;
264
+ };
265
+ type InitialDataFunction<T> = () => T | undefined;
266
+ type NonFunctionGuard<T> = T extends Function ? never : T;
267
+ type PlaceholderDataFunction<TQueryFnData = unknown, TError = DefaultError, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = (previousData: TQueryData | undefined, previousQuery: Query<TQueryFnData, TError, TQueryData, TQueryKey> | undefined) => TQueryData | undefined;
268
+ type QueriesPlaceholderDataFunction<TQueryData> = () => TQueryData | undefined;
269
+ type QueryKeyHashFunction<TQueryKey extends QueryKey> = (queryKey: TQueryKey) => string;
270
+ type GetPreviousPageParamFunction<TPageParam, TQueryFnData = unknown> = (firstPage: TQueryFnData, allPages: TQueryFnData[], firstPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined;
271
+ type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (lastPage: TQueryFnData, allPages: TQueryFnData[], lastPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined;
272
+ interface InfiniteData<TData> {
273
+ pages: TData[];
274
+ pageParams: unknown[];
275
+ }
276
+ type QueryMeta = Register extends {
277
+ queryMeta: infer TQueryMeta;
278
+ } ? TQueryMeta extends Record<string, unknown> ? TQueryMeta : Record<string, unknown> : Record<string, unknown>;
279
+ type NetworkMode = 'online' | 'always' | 'offlineFirst';
280
+ interface QueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> {
281
+ /**
282
+ * If `false`, failed queries will not retry by default.
283
+ * If `true`, failed queries will retry infinitely., failureCount: num
284
+ * If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number.
285
+ * If set to a function `(failureCount, error) => boolean` failed queries will retry until the function returns false.
286
+ */
287
+ retry?: RetryValue<TError>;
288
+ retryDelay?: RetryDelayValue<TError>;
289
+ networkMode?: NetworkMode;
290
+ gcTime?: number;
291
+ queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam>;
292
+ queryHash?: string;
293
+ queryKey?: TQueryKey;
294
+ queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>;
295
+ initialData?: TData | InitialDataFunction<TData>;
296
+ initialDataUpdatedAt?: number | (() => number | undefined);
297
+ behavior?: QueryBehavior<TQueryFnData, TError, TData, TQueryKey>;
298
+ /**
299
+ * Set this to `false` to disable structural sharing between query results.
300
+ * 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.
301
+ * Defaults to `true`.
302
+ */
303
+ structuralSharing?: boolean | ((oldData: TData | undefined, newData: TData) => TData);
304
+ _defaulted?: boolean;
305
+ /**
306
+ * Additional payload to be stored on each query.
307
+ * Use this property to pass information that can be used in other places.
308
+ */
309
+ meta?: QueryMeta;
310
+ /**
311
+ * Maximum number of pages to store in the data of an infinite query.
312
+ */
313
+ maxPages?: number;
314
+ }
315
+ interface DefaultPageParam<TPageParam = unknown> {
316
+ defaultPageParam: TPageParam;
317
+ }
318
+ interface InfiniteQueryPageParamsOptions<TQueryFnData = unknown, TPageParam = unknown> extends DefaultPageParam<TPageParam> {
319
+ /**
320
+ * This function can be set to automatically get the previous cursor for infinite queries.
321
+ * The result will also be used to determine the value of `hasPreviousPage`.
322
+ */
323
+ getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TQueryFnData>;
324
+ /**
325
+ * This function can be set to automatically get the next cursor for infinite queries.
326
+ * The result will also be used to determine the value of `hasNextPage`.
327
+ */
328
+ getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>;
329
+ }
330
+ type ThrowOnError<TQueryFnData, TError, TQueryData, TQueryKey extends QueryKey> = boolean | ((error: TError, query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean);
331
+ interface QueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey, TPageParam> {
332
+ /**
333
+ * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
334
+ * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
335
+ * Defaults to `true`.
336
+ */
337
+ enabled?: boolean;
338
+ /**
339
+ * The time in milliseconds after data is considered stale.
340
+ * If set to `Infinity`, the data will never be considered stale.
341
+ */
342
+ staleTime?: number;
343
+ /**
344
+ * If set to a number, the query will continuously refetch at this frequency in milliseconds.
345
+ * If set to a function, the function will be executed with the latest data and query to compute a frequency
346
+ * Defaults to `false`.
347
+ */
348
+ refetchInterval?: number | false | ((data: TData | undefined, query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => number | false | undefined);
349
+ /**
350
+ * If set to `true`, the query will continue to refetch while their tab/window is in the background.
351
+ * Defaults to `false`.
352
+ */
353
+ refetchIntervalInBackground?: boolean;
354
+ /**
355
+ * If set to `true`, the query will refetch on window focus if the data is stale.
356
+ * If set to `false`, the query will not refetch on window focus.
357
+ * If set to `'always'`, the query will always refetch on window focus.
358
+ * If set to a function, the function will be executed with the latest data and query to compute the value.
359
+ * Defaults to `true`.
360
+ */
361
+ refetchOnWindowFocus?: boolean | 'always' | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | 'always');
362
+ /**
363
+ * If set to `true`, the query will refetch on reconnect if the data is stale.
364
+ * If set to `false`, the query will not refetch on reconnect.
365
+ * If set to `'always'`, the query will always refetch on reconnect.
366
+ * If set to a function, the function will be executed with the latest data and query to compute the value.
367
+ * Defaults to the value of `networkOnline` (`true`)
368
+ */
369
+ refetchOnReconnect?: boolean | 'always' | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | 'always');
370
+ /**
371
+ * If set to `true`, the query will refetch on mount if the data is stale.
372
+ * If set to `false`, will disable additional instances of a query to trigger background refetches.
373
+ * If set to `'always'`, the query will always refetch on mount.
374
+ * If set to a function, the function will be executed with the latest data and query to compute the value
375
+ * Defaults to `true`.
376
+ */
377
+ refetchOnMount?: boolean | 'always' | ((query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) => boolean | 'always');
378
+ /**
379
+ * If set to `false`, the query will not be retried on mount if it contains an error.
380
+ * Defaults to `true`.
381
+ */
382
+ retryOnMount?: boolean;
383
+ /**
384
+ * If set, the component will only re-render if any of the listed properties change.
385
+ * When set to `['data', 'error']`, the component will only re-render when the `data` or `error` properties change.
386
+ * When set to `'all'`, the component will re-render whenever a query is updated.
387
+ * By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.
388
+ */
389
+ notifyOnChangeProps?: Array<keyof InfiniteQueryObserverResult> | 'all';
390
+ /**
391
+ * Whether errors should be thrown instead of setting the `error` property.
392
+ * If set to `true` or `suspense` is `true`, all errors will be thrown to the error boundary.
393
+ * If set to `false` and `suspense` is `false`, errors are returned as state.
394
+ * 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`).
395
+ * Defaults to `false`.
396
+ */
397
+ throwOnError?: ThrowOnError<TQueryFnData, TError, TQueryData, TQueryKey>;
398
+ /**
399
+ * This option can be used to transform or select a part of the data returned by the query function.
400
+ */
401
+ select?: (data: TQueryData) => TData;
402
+ /**
403
+ * If set to `true`, the query will suspend when `status === 'pending'`
404
+ * and throw errors when `status === 'error'`.
405
+ * Defaults to `false`.
406
+ */
407
+ suspense?: boolean;
408
+ /**
409
+ * 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.
410
+ */
411
+ placeholderData?: NonFunctionGuard<TQueryData> | PlaceholderDataFunction<NonFunctionGuard<TQueryData>>;
412
+ _optimisticResults?: 'optimistic' | 'isRestoring';
413
+ }
414
+ type WithRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
415
+ type DefaultedQueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = WithRequired<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'throwOnError' | 'refetchOnReconnect'>;
416
+ interface InfiniteQueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends QueryObserverOptions<TQueryFnData, TError, TData, InfiniteData<TQueryData>, TQueryKey, TPageParam>, InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> {
417
+ }
418
+ type DefaultedInfiniteQueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = WithRequired<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, 'throwOnError' | 'refetchOnReconnect'>;
419
+ interface FetchQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends WithRequired<QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, 'queryKey'> {
420
+ /**
421
+ * The time in milliseconds after data is considered stale.
422
+ * If the data is fresh it will be returned from the cache.
423
+ */
424
+ staleTime?: number;
425
+ }
426
+ type FetchInfiniteQueryPages<TQueryFnData = unknown, TPageParam = unknown> = {
427
+ pages?: never;
428
+ getNextPageParam?: never;
429
+ } | {
430
+ pages: number;
431
+ getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>;
432
+ };
433
+ type FetchInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = FetchQueryOptions<TQueryFnData, TError, InfiniteData<TData>, TQueryKey, TPageParam> & DefaultPageParam<TPageParam> & FetchInfiniteQueryPages<TQueryFnData, TPageParam>;
434
+ interface ResultOptions {
435
+ throwOnError?: boolean;
436
+ }
437
+ interface RefetchOptions extends ResultOptions {
438
+ cancelRefetch?: boolean;
439
+ }
440
+ interface InvalidateQueryFilters extends QueryFilters {
441
+ refetchType?: QueryTypeFilter | 'none';
442
+ }
443
+ interface RefetchQueryFilters extends QueryFilters {
444
+ }
445
+ interface InvalidateOptions extends RefetchOptions {
446
+ }
447
+ interface ResetOptions extends RefetchOptions {
448
+ }
449
+ interface FetchNextPageOptions extends ResultOptions {
450
+ cancelRefetch?: boolean;
451
+ }
452
+ interface FetchPreviousPageOptions extends ResultOptions {
453
+ cancelRefetch?: boolean;
454
+ }
455
+ type QueryStatus = 'pending' | 'error' | 'success';
456
+ type FetchStatus = 'fetching' | 'paused' | 'idle';
457
+ interface QueryObserverBaseResult<TData = unknown, TError = DefaultError> {
458
+ data: TData | undefined;
459
+ dataUpdatedAt: number;
460
+ error: TError | null;
461
+ errorUpdatedAt: number;
462
+ failureCount: number;
463
+ failureReason: TError | null;
464
+ errorUpdateCount: number;
465
+ isError: boolean;
466
+ isFetched: boolean;
467
+ isFetchedAfterMount: boolean;
468
+ isFetching: boolean;
469
+ isLoading: boolean;
470
+ isPending: boolean;
471
+ isLoadingError: boolean;
472
+ /**
473
+ * @deprecated isInitialLoading is being deprecated in favor of isLoading
474
+ * and will be removed in the next major version.
475
+ */
476
+ isInitialLoading: boolean;
477
+ isPaused: boolean;
478
+ isPlaceholderData: boolean;
479
+ isRefetchError: boolean;
480
+ isRefetching: boolean;
481
+ isStale: boolean;
482
+ isSuccess: boolean;
483
+ refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>>;
484
+ status: QueryStatus;
485
+ fetchStatus: FetchStatus;
486
+ }
487
+ interface QueryObserverLoadingResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
488
+ data: undefined;
489
+ error: null;
490
+ isError: false;
491
+ isPending: true;
492
+ isLoadingError: false;
493
+ isRefetchError: false;
494
+ isSuccess: false;
495
+ status: 'pending';
496
+ }
497
+ interface QueryObserverLoadingErrorResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
498
+ data: undefined;
499
+ error: TError;
500
+ isError: true;
501
+ isPending: false;
502
+ isLoadingError: true;
503
+ isRefetchError: false;
504
+ isSuccess: false;
505
+ status: 'error';
506
+ }
507
+ interface QueryObserverRefetchErrorResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
508
+ data: TData;
509
+ error: TError;
510
+ isError: true;
511
+ isPending: false;
512
+ isLoadingError: false;
513
+ isRefetchError: true;
514
+ isSuccess: false;
515
+ status: 'error';
516
+ }
517
+ interface QueryObserverSuccessResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
518
+ data: TData;
519
+ error: null;
520
+ isError: false;
521
+ isPending: false;
522
+ isLoadingError: false;
523
+ isRefetchError: false;
524
+ isSuccess: true;
525
+ status: 'success';
526
+ }
527
+ type DefinedQueryObserverResult<TData = unknown, TError = DefaultError> = QueryObserverRefetchErrorResult<TData, TError> | QueryObserverSuccessResult<TData, TError>;
528
+ type QueryObserverResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError> | QueryObserverLoadingErrorResult<TData, TError> | QueryObserverLoadingResult<TData, TError>;
529
+ interface InfiniteQueryObserverBaseResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
530
+ fetchNextPage: (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>;
531
+ fetchPreviousPage: (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>;
532
+ hasNextPage: boolean;
533
+ hasPreviousPage: boolean;
534
+ isFetchingNextPage: boolean;
535
+ isFetchingPreviousPage: boolean;
536
+ }
537
+ interface InfiniteQueryObserverLoadingResult<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
+ isSuccess: false;
545
+ status: 'pending';
546
+ }
547
+ interface InfiniteQueryObserverLoadingErrorResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
548
+ data: undefined;
549
+ error: TError;
550
+ isError: true;
551
+ isPending: false;
552
+ isLoadingError: true;
553
+ isRefetchError: false;
554
+ isSuccess: false;
555
+ status: 'error';
556
+ }
557
+ interface InfiniteQueryObserverRefetchErrorResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
558
+ data: TData;
559
+ error: TError;
560
+ isError: true;
561
+ isPending: false;
562
+ isLoadingError: false;
563
+ isRefetchError: true;
564
+ isSuccess: false;
565
+ status: 'error';
566
+ }
567
+ interface InfiniteQueryObserverSuccessResult<TData = unknown, TError = DefaultError> extends InfiniteQueryObserverBaseResult<TData, TError> {
568
+ data: TData;
569
+ error: null;
570
+ isError: false;
571
+ isPending: false;
572
+ isLoadingError: false;
573
+ isRefetchError: false;
574
+ isSuccess: true;
575
+ status: 'success';
576
+ }
577
+ type InfiniteQueryObserverResult<TData = unknown, TError = DefaultError> = InfiniteQueryObserverLoadingErrorResult<TData, TError> | InfiniteQueryObserverLoadingResult<TData, TError> | InfiniteQueryObserverRefetchErrorResult<TData, TError> | InfiniteQueryObserverSuccessResult<TData, TError>;
578
+ type MutationKey = readonly unknown[];
579
+ type MutationStatus = 'idle' | 'pending' | 'success' | 'error';
580
+ type MutationMeta = Register extends {
581
+ mutationMeta: infer TMutationMeta;
582
+ } ? TMutationMeta : Record<string, unknown>;
583
+ type MutationFunction<TData = unknown, TVariables = unknown> = (variables: TVariables) => Promise<TData>;
584
+ interface MutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> {
585
+ mutationFn?: MutationFunction<TData, TVariables>;
586
+ mutationKey?: MutationKey;
587
+ onMutate?: (variables: TVariables) => Promise<TContext | undefined> | TContext | undefined;
588
+ onSuccess?: (data: TData, variables: TVariables, context: TContext | undefined) => Promise<unknown> | unknown;
589
+ onError?: (error: TError, variables: TVariables, context: TContext | undefined) => Promise<unknown> | unknown;
590
+ onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, context: TContext | undefined) => Promise<unknown> | unknown;
591
+ retry?: RetryValue<TError>;
592
+ retryDelay?: RetryDelayValue<TError>;
593
+ networkMode?: NetworkMode;
594
+ gcTime?: number;
595
+ _defaulted?: boolean;
596
+ meta?: MutationMeta;
597
+ }
598
+ interface MutationObserverOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends MutationOptions<TData, TError, TVariables, TContext> {
599
+ throwOnError?: boolean | ((error: TError) => boolean);
600
+ }
601
+ interface MutateOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> {
602
+ onSuccess?: (data: TData, variables: TVariables, context: TContext) => void;
603
+ onError?: (error: TError, variables: TVariables, context: TContext | undefined) => void;
604
+ onSettled?: (data: TData | undefined, error: TError | null, variables: TVariables, context: TContext | undefined) => void;
605
+ }
606
+ type MutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = (variables: TVariables, options?: MutateOptions<TData, TError, TVariables, TContext>) => Promise<TData>;
607
+ interface MutationObserverBaseResult<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends MutationState<TData, TError, TVariables, TContext> {
608
+ isError: boolean;
609
+ isIdle: boolean;
610
+ isPending: boolean;
611
+ isSuccess: boolean;
612
+ mutate: MutateFunction<TData, TError, TVariables, TContext>;
613
+ reset: () => void;
614
+ }
615
+ interface MutationObserverIdleResult<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
616
+ data: undefined;
617
+ variables: undefined;
618
+ error: null;
619
+ isError: false;
620
+ isIdle: true;
621
+ isPending: false;
622
+ isSuccess: false;
623
+ status: 'idle';
624
+ }
625
+ interface MutationObserverLoadingResult<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
626
+ data: undefined;
627
+ variables: TVariables;
628
+ error: null;
629
+ isError: false;
630
+ isIdle: false;
631
+ isPending: true;
632
+ isSuccess: false;
633
+ status: 'pending';
634
+ }
635
+ interface MutationObserverErrorResult<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
636
+ data: undefined;
637
+ error: TError;
638
+ variables: TVariables;
639
+ isError: true;
640
+ isIdle: false;
641
+ isPending: false;
642
+ isSuccess: false;
643
+ status: 'error';
644
+ }
645
+ interface MutationObserverSuccessResult<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends MutationObserverBaseResult<TData, TError, TVariables, TContext> {
646
+ data: TData;
647
+ error: null;
648
+ variables: TVariables;
649
+ isError: false;
650
+ isIdle: false;
651
+ isPending: false;
652
+ isSuccess: true;
653
+ status: 'success';
654
+ }
655
+ type MutationObserverResult<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = MutationObserverIdleResult<TData, TError, TVariables, TContext> | MutationObserverLoadingResult<TData, TError, TVariables, TContext> | MutationObserverErrorResult<TData, TError, TVariables, TContext> | MutationObserverSuccessResult<TData, TError, TVariables, TContext>;
656
+ interface QueryClientConfig {
657
+ queryCache?: QueryCache;
658
+ mutationCache?: MutationCache;
659
+ defaultOptions?: DefaultOptions;
660
+ }
661
+ interface DefaultOptions<TError = DefaultError> {
662
+ queries?: QueryObserverOptions<unknown, TError>;
663
+ mutations?: MutationObserverOptions<unknown, TError, unknown, unknown>;
664
+ }
665
+ interface CancelOptions {
666
+ revert?: boolean;
667
+ silent?: boolean;
668
+ }
669
+ interface SetDataOptions {
670
+ updatedAt?: number;
671
+ }
672
+ type NotifyEventType = 'added' | 'removed' | 'updated' | 'observerAdded' | 'observerRemoved' | 'observerResultsUpdated' | 'observerOptionsUpdated';
673
+ interface NotifyEvent {
674
+ type: NotifyEventType;
675
+ }
676
+
677
+ type QueryObserverListener<TData, TError> = (result: QueryObserverResult<TData, TError>) => void;
678
+ interface NotifyOptions {
679
+ listeners?: boolean;
680
+ }
681
+ interface ObserverFetchOptions extends FetchOptions {
682
+ throwOnError?: boolean;
683
+ }
684
+ declare class QueryObserver<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends Subscribable<QueryObserverListener<TData, TError>> {
685
+ #private;
686
+ options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
687
+ constructor(client: QueryClient, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>);
688
+ protected bindMethods(): void;
689
+ protected onSubscribe(): void;
690
+ protected onUnsubscribe(): void;
691
+ shouldFetchOnReconnect(): boolean;
692
+ shouldFetchOnWindowFocus(): boolean;
693
+ destroy(): void;
694
+ setOptions(options?: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, notifyOptions?: NotifyOptions): void;
695
+ getOptimisticResult(options: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
696
+ getCurrentResult(): QueryObserverResult<TData, TError>;
697
+ trackResult(result: QueryObserverResult<TData, TError>): QueryObserverResult<TData, TError>;
698
+ getCurrentQuery(): Query<TQueryFnData, TError, TQueryData, TQueryKey>;
699
+ refetch({ ...options }?: RefetchOptions): Promise<QueryObserverResult<TData, TError>>;
700
+ fetchOptimistic(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): Promise<QueryObserverResult<TData, TError>>;
701
+ protected fetch(fetchOptions: ObserverFetchOptions): Promise<QueryObserverResult<TData, TError>>;
702
+ protected createResult(query: Query<TQueryFnData, TError, TQueryData, TQueryKey>, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>;
703
+ updateResult(notifyOptions?: NotifyOptions): void;
704
+ onQueryUpdate(): void;
705
+ }
706
+
707
+ interface QueryConfig<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
708
+ cache: QueryCache;
709
+ queryKey: TQueryKey;
710
+ queryHash: string;
711
+ options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
712
+ defaultOptions?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
713
+ state?: QueryState<TData, TError>;
714
+ }
715
+ interface QueryState<TData = unknown, TError = DefaultError> {
716
+ data: TData | undefined;
717
+ dataUpdateCount: number;
718
+ dataUpdatedAt: number;
719
+ error: TError | null;
720
+ errorUpdateCount: number;
721
+ errorUpdatedAt: number;
722
+ fetchFailureCount: number;
723
+ fetchFailureReason: TError | null;
724
+ fetchMeta: FetchMeta | null;
725
+ isInvalidated: boolean;
726
+ status: QueryStatus;
727
+ fetchStatus: FetchStatus;
728
+ }
729
+ interface FetchContext<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey> {
730
+ fetchFn: () => unknown | Promise<unknown>;
731
+ fetchOptions?: FetchOptions;
732
+ signal: AbortSignal;
733
+ options: QueryOptions<TQueryFnData, TError, TData, any>;
734
+ queryKey: TQueryKey;
735
+ state: QueryState<TData, TError>;
736
+ }
737
+ interface QueryBehavior<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> {
738
+ onFetch: (context: FetchContext<TQueryFnData, TError, TData, TQueryKey>) => void;
739
+ }
740
+ type FetchDirection = 'forward' | 'backward';
741
+ interface FetchMeta {
742
+ fetchMore?: {
743
+ direction: FetchDirection;
744
+ };
745
+ }
746
+ interface FetchOptions {
747
+ cancelRefetch?: boolean;
748
+ meta?: FetchMeta;
749
+ }
750
+ interface FailedAction<TError> {
751
+ type: 'failed';
752
+ failureCount: number;
753
+ error: TError;
754
+ }
755
+ interface FetchAction {
756
+ type: 'fetch';
757
+ meta?: FetchMeta;
758
+ }
759
+ interface SuccessAction<TData> {
760
+ data: TData | undefined;
761
+ type: 'success';
762
+ dataUpdatedAt?: number;
763
+ manual?: boolean;
764
+ }
765
+ interface ErrorAction<TError> {
766
+ type: 'error';
767
+ error: TError;
768
+ }
769
+ interface InvalidateAction {
770
+ type: 'invalidate';
771
+ }
772
+ interface PauseAction {
773
+ type: 'pause';
774
+ }
775
+ interface ContinueAction {
776
+ type: 'continue';
777
+ }
778
+ interface SetStateAction<TData, TError> {
779
+ type: 'setState';
780
+ state: Partial<QueryState<TData, TError>>;
781
+ setStateOptions?: SetStateOptions;
782
+ }
783
+ type Action<TData, TError> = ContinueAction | ErrorAction<TError> | FailedAction<TError> | FetchAction | InvalidateAction | PauseAction | SetStateAction<TData, TError> | SuccessAction<TData>;
784
+ interface SetStateOptions {
785
+ meta?: any;
786
+ }
787
+ declare class Query<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends Removable {
788
+ #private;
789
+ queryKey: TQueryKey;
790
+ queryHash: string;
791
+ options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>;
792
+ state: QueryState<TData, TError>;
793
+ isFetchingOptimistic?: boolean;
794
+ constructor(config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>);
795
+ get meta(): QueryMeta | undefined;
796
+ protected optionalRemove(): void;
797
+ setData(newData: TData, options?: SetDataOptions & {
798
+ manual: boolean;
799
+ }): TData;
800
+ setState(state: Partial<QueryState<TData, TError>>, setStateOptions?: SetStateOptions): void;
801
+ cancel(options?: CancelOptions): Promise<void>;
802
+ destroy(): void;
803
+ reset(): void;
804
+ isActive(): boolean;
805
+ isDisabled(): boolean;
806
+ isStale(): boolean;
807
+ isStaleByTime(staleTime?: number): boolean;
808
+ onFocus(): void;
809
+ onOnline(): void;
810
+ addObserver(observer: QueryObserver<any, any, any, any, any>): void;
811
+ removeObserver(observer: QueryObserver<any, any, any, any, any>): void;
812
+ getObserversCount(): number;
813
+ invalidate(): void;
814
+ fetch(options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>, fetchOptions?: FetchOptions): Promise<TData>;
815
+ }
816
+
817
+ interface QueryCacheConfig {
818
+ onError?: (error: DefaultError, query: Query<unknown, unknown, unknown>) => void;
819
+ onSuccess?: (data: unknown, query: Query<unknown, unknown, unknown>) => void;
820
+ onSettled?: (data: unknown | undefined, error: DefaultError | null, query: Query<unknown, unknown, unknown>) => void;
821
+ }
822
+ interface NotifyEventQueryAdded extends NotifyEvent {
823
+ type: 'added';
824
+ query: Query<any, any, any, any>;
825
+ }
826
+ interface NotifyEventQueryRemoved extends NotifyEvent {
827
+ type: 'removed';
828
+ query: Query<any, any, any, any>;
829
+ }
830
+ interface NotifyEventQueryUpdated extends NotifyEvent {
831
+ type: 'updated';
832
+ query: Query<any, any, any, any>;
833
+ action: Action<any, any>;
834
+ }
835
+ interface NotifyEventQueryObserverAdded extends NotifyEvent {
836
+ type: 'observerAdded';
837
+ query: Query<any, any, any, any>;
838
+ observer: QueryObserver<any, any, any, any, any>;
839
+ }
840
+ interface NotifyEventQueryObserverRemoved extends NotifyEvent {
841
+ type: 'observerRemoved';
842
+ query: Query<any, any, any, any>;
843
+ observer: QueryObserver<any, any, any, any, any>;
844
+ }
845
+ interface NotifyEventQueryObserverResultsUpdated extends NotifyEvent {
846
+ type: 'observerResultsUpdated';
847
+ query: Query<any, any, any, any>;
848
+ }
849
+ interface NotifyEventQueryObserverOptionsUpdated extends NotifyEvent {
850
+ type: 'observerOptionsUpdated';
851
+ query: Query<any, any, any, any>;
852
+ observer: QueryObserver<any, any, any, any, any>;
853
+ }
854
+ type QueryCacheNotifyEvent = NotifyEventQueryAdded | NotifyEventQueryRemoved | NotifyEventQueryUpdated | NotifyEventQueryObserverAdded | NotifyEventQueryObserverRemoved | NotifyEventQueryObserverResultsUpdated | NotifyEventQueryObserverOptionsUpdated;
855
+ type QueryCacheListener = (event: QueryCacheNotifyEvent) => void;
856
+ interface QueryStore {
857
+ has: (queryKey: string) => boolean;
858
+ set: (queryKey: string, query: Query) => void;
859
+ get: (queryKey: string) => Query | undefined;
860
+ delete: (queryKey: string) => void;
861
+ values: () => IterableIterator<Query>;
862
+ }
863
+ declare class QueryCache extends Subscribable<QueryCacheListener> {
864
+ #private;
865
+ config: QueryCacheConfig;
866
+ constructor(config?: QueryCacheConfig);
867
+ build<TQueryFnData, TError, TData, TQueryKey extends QueryKey>(client: QueryClient, options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>, state?: QueryState<TData, TError>): Query<TQueryFnData, TError, TData, TQueryKey>;
868
+ add(query: Query<any, any, any, any>): void;
869
+ remove(query: Query<any, any, any, any>): void;
870
+ clear(): void;
871
+ get<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryHash: string): Query<TQueryFnData, TError, TData, TQueryKey> | undefined;
872
+ getAll(): Query[];
873
+ find<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData>(filters: WithRequired<QueryFilters, 'queryKey'>): Query<TQueryFnData, TError, TData> | undefined;
874
+ findAll(filters?: QueryFilters): Query[];
875
+ notify(event: QueryCacheNotifyEvent): void;
876
+ onFocus(): void;
877
+ onOnline(): void;
878
+ }
879
+
880
+ declare class QueryClient {
881
+ #private;
882
+ constructor(config?: QueryClientConfig);
883
+ mount(): void;
884
+ unmount(): void;
885
+ isFetching(filters?: QueryFilters): number;
886
+ isMutating(filters?: MutationFilters): number;
887
+ getQueryData<TQueryFnData = unknown>(queryKey: QueryKey): TQueryFnData | undefined;
888
+ ensureQueryData<TQueryFnData, TError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>;
889
+ getQueriesData<TQueryFnData = unknown>(filters: QueryFilters): [QueryKey, TQueryFnData | undefined][];
890
+ setQueryData<TQueryFnData>(queryKey: QueryKey, updater: Updater<TQueryFnData | undefined, TQueryFnData | undefined>, options?: SetDataOptions): TQueryFnData | undefined;
891
+ setQueriesData<TQueryFnData>(filters: QueryFilters, updater: Updater<TQueryFnData | undefined, TQueryFnData | undefined>, options?: SetDataOptions): [QueryKey, TQueryFnData | undefined][];
892
+ getQueryState<TQueryFnData = unknown, TError = DefaultError>(queryKey: QueryKey): QueryState<TQueryFnData, TError> | undefined;
893
+ removeQueries(filters?: QueryFilters): void;
894
+ resetQueries(filters?: QueryFilters, options?: ResetOptions): Promise<void>;
895
+ cancelQueries(filters?: QueryFilters, cancelOptions?: CancelOptions): Promise<void>;
896
+ invalidateQueries(filters?: InvalidateQueryFilters, options?: InvalidateOptions): Promise<void>;
897
+ refetchQueries(filters?: RefetchQueryFilters, options?: RefetchOptions): Promise<void>;
898
+ fetchQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<TData>;
899
+ prefetchQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;
900
+ fetchInfiniteQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<InfiniteData<TData>>;
901
+ prefetchInfiniteQuery<TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<void>;
902
+ resumePausedMutations(): Promise<unknown>;
903
+ getQueryCache(): QueryCache;
904
+ getMutationCache(): MutationCache;
905
+ getDefaultOptions(): DefaultOptions;
906
+ setDefaultOptions(options: DefaultOptions): void;
907
+ setQueryDefaults(queryKey: QueryKey, options: Partial<Omit<QueryObserverOptions<unknown, any, any, any>, 'queryKey'>>): void;
908
+ getQueryDefaults(queryKey: QueryKey): QueryObserverOptions<any, any, any, any, any>;
909
+ setMutationDefaults(mutationKey: MutationKey, options: Omit<MutationObserverOptions<any, any, any, any>, 'mutationKey'>): void;
910
+ getMutationDefaults(mutationKey: MutationKey): MutationObserverOptions<any, any, any, any>;
911
+ 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>;
912
+ defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(options?: T): T;
913
+ clear(): void;
914
+ }
915
+
916
+ export { QueryStatus as $, InfiniteQueryPageParamsOptions as A, QueryObserverOptions as B, CancelledError as C, DefaultError as D, DefaultedQueryObserverOptions as E, InfiniteQueryObserverOptions as F, GetPreviousPageParamFunction as G, DefaultedInfiniteQueryObserverOptions as H, InitialDataFunction as I, FetchQueryOptions as J, FetchInfiniteQueryOptions as K, ResultOptions as L, MutationCache as M, NetworkMode as N, RefetchOptions as O, PlaceholderDataFunction as P, QueryCache as Q, Register as R, InvalidateQueryFilters as S, ThrowOnError as T, Updater as U, RefetchQueryFilters as V, WithRequired as W, InvalidateOptions as X, ResetOptions as Y, FetchNextPageOptions as Z, FetchPreviousPageOptions as _, QueryCacheNotifyEvent as a, FetchMeta as a$, FetchStatus as a0, QueryObserverBaseResult as a1, QueryObserverLoadingResult as a2, QueryObserverLoadingErrorResult as a3, QueryObserverRefetchErrorResult as a4, QueryObserverSuccessResult as a5, DefinedQueryObserverResult as a6, QueryObserverResult as a7, InfiniteQueryObserverBaseResult as a8, InfiniteQueryObserverLoadingResult as a9, NotifyOptions as aA, DataUpdateFunction as aB, QueryTypeFilter as aC, noop as aD, functionalUpdate as aE, isValidTimeout as aF, timeUntilStale as aG, matchMutation as aH, hashQueryKeyByOptions as aI, partialMatchKey as aJ, shallowEqualObjects as aK, isPlainArray as aL, isPlainObject as aM, sleep as aN, scheduleMicrotask as aO, replaceData as aP, addToEnd as aQ, addToStart as aR, Action$1 as aS, getDefaultState as aT, Retryer as aU, RetryValue as aV, RetryDelayValue as aW, canFetch as aX, createRetryer as aY, FetchContext as aZ, FetchDirection as a_, InfiniteQueryObserverLoadingErrorResult as aa, InfiniteQueryObserverRefetchErrorResult as ab, InfiniteQueryObserverSuccessResult as ac, InfiniteQueryObserverResult as ad, MutationKey as ae, MutationStatus as af, MutationMeta as ag, MutationFunction as ah, MutationOptions as ai, MutationObserverOptions as aj, MutateOptions as ak, MutateFunction as al, MutationObserverBaseResult as am, MutationObserverIdleResult as an, MutationObserverLoadingResult as ao, MutationObserverErrorResult as ap, MutationObserverSuccessResult as aq, MutationObserverResult as ar, QueryClientConfig as as, DefaultOptions as at, CancelOptions as au, SetDataOptions as av, NotifyEventType as aw, NotifyEvent as ax, QueryBehavior as ay, ObserverFetchOptions as az, QueryClient as b, FetchOptions as b0, Action as b1, SetStateOptions as b2, QueryStore as b3, QueryObserver as c, MutationObserver as d, MutationFilters as e, QueryFilters as f, isCancelledError as g, hashKey as h, isServer as i, Query as j, keepPreviousData as k, QueryState as l, matchQuery as m, Mutation as n, MutationState as o, QueryKey as p, QueryFunction as q, replaceEqualDeep as r, QueryFunctionContext as s, QueriesPlaceholderDataFunction as t, QueryKeyHashFunction as u, GetNextPageParamFunction as v, InfiniteData as w, QueryMeta as x, QueryOptions as y, DefaultPageParam as z };