@tanstack/vue-query 5.107.0 → 5.107.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (219) hide show
  1. package/README.md +2 -3
  2. package/build/legacy/devtools/devtools.cjs +1 -1
  3. package/build/legacy/devtools/devtools.cjs.map +1 -1
  4. package/build/legacy/devtools/devtools.d.cts +1 -1
  5. package/build/legacy/devtools/devtools.d.ts +1 -1
  6. package/build/legacy/devtools/devtools.js +1 -1
  7. package/build/legacy/devtools/devtools.js.map +1 -1
  8. package/build/legacy/index.cjs +1 -1
  9. package/build/legacy/index.d.cts +4 -4
  10. package/build/legacy/index.d.ts +4 -4
  11. package/build/legacy/index.js +1 -1
  12. package/build/legacy/{infiniteQueryOptions-lJ_zR-As.d.cts → infiniteQueryOptions-CLfd_vOE.d.cts} +61 -17
  13. package/build/legacy/infiniteQueryOptions-CLfd_vOE.d.cts.map +1 -0
  14. package/build/legacy/{infiniteQueryOptions-CN37iZvc.d.ts → infiniteQueryOptions-vEnw-JaW.d.ts} +61 -17
  15. package/build/legacy/infiniteQueryOptions-vEnw-JaW.d.ts.map +1 -0
  16. package/build/legacy/infiniteQueryOptions.d.cts +1 -1
  17. package/build/legacy/infiniteQueryOptions.d.ts +1 -1
  18. package/build/{modern/queryClient-Ba4HSFnn.d.ts → legacy/queryClient-6AWIHAhP.d.ts} +2 -2
  19. package/build/legacy/{queryClient-Ba4HSFnn.d.ts.map → queryClient-6AWIHAhP.d.ts.map} +1 -1
  20. package/build/{modern/queryClient-BGn8uIej.d.cts → legacy/queryClient-yJW8K_VP.d.cts} +2 -2
  21. package/build/legacy/{queryClient-BGn8uIej.d.cts.map → queryClient-yJW8K_VP.d.cts.map} +1 -1
  22. package/build/legacy/queryClient.cjs +1 -1
  23. package/build/legacy/queryClient.cjs.map +1 -1
  24. package/build/legacy/queryClient.d.cts +1 -1
  25. package/build/legacy/queryClient.d.ts +1 -1
  26. package/build/legacy/queryClient.js +1 -1
  27. package/build/legacy/queryClient.js.map +1 -1
  28. package/build/{modern/queryOptions-BuZEBLtg.d.cts → legacy/queryOptions-nndmAASX.d.cts} +22 -11
  29. package/build/legacy/queryOptions-nndmAASX.d.cts.map +1 -0
  30. package/build/{modern/queryOptions-dXiBZnGk.d.ts → legacy/queryOptions-v0l6M7Eo.d.ts} +22 -11
  31. package/build/legacy/queryOptions-v0l6M7Eo.d.ts.map +1 -0
  32. package/build/legacy/queryOptions.cjs.map +1 -1
  33. package/build/legacy/queryOptions.d.cts +2 -2
  34. package/build/legacy/queryOptions.d.ts +2 -2
  35. package/build/legacy/queryOptions.js.map +1 -1
  36. package/build/legacy/types-u_Tu5Ybs.d.cts.map +1 -1
  37. package/build/legacy/types-u_Tu5Ybs.d.ts.map +1 -1
  38. package/build/legacy/useBaseQuery.cjs +11 -5
  39. package/build/legacy/useBaseQuery.cjs.map +1 -1
  40. package/build/legacy/useBaseQuery.d.cts +1 -1
  41. package/build/legacy/useBaseQuery.d.ts +1 -1
  42. package/build/legacy/useBaseQuery.js +11 -5
  43. package/build/legacy/useBaseQuery.js.map +1 -1
  44. package/build/legacy/useInfiniteQuery.cjs.map +1 -1
  45. package/build/legacy/useInfiniteQuery.d.cts +1 -1
  46. package/build/legacy/useInfiniteQuery.d.ts +1 -1
  47. package/build/legacy/useInfiniteQuery.js.map +1 -1
  48. package/build/legacy/useIsFetching.cjs.map +1 -1
  49. package/build/legacy/useIsFetching.d.cts +1 -1
  50. package/build/legacy/useIsFetching.d.ts +1 -1
  51. package/build/legacy/useIsFetching.js.map +1 -1
  52. package/build/legacy/useMutation.cjs.map +1 -1
  53. package/build/legacy/useMutation.d.cts +1 -1
  54. package/build/legacy/useMutation.d.ts +1 -1
  55. package/build/legacy/useMutation.js.map +1 -1
  56. package/build/legacy/useMutationState.cjs.map +1 -1
  57. package/build/legacy/useMutationState.d.cts +1 -1
  58. package/build/legacy/useMutationState.d.ts +1 -1
  59. package/build/legacy/useMutationState.js.map +1 -1
  60. package/build/legacy/usePrefetchInfiniteQuery.cjs.map +1 -1
  61. package/build/legacy/usePrefetchInfiniteQuery.d.cts +1 -1
  62. package/build/legacy/usePrefetchInfiniteQuery.d.ts +1 -1
  63. package/build/legacy/usePrefetchInfiniteQuery.js.map +1 -1
  64. package/build/legacy/usePrefetchQuery.cjs.map +1 -1
  65. package/build/legacy/usePrefetchQuery.d.cts +1 -1
  66. package/build/legacy/usePrefetchQuery.d.ts +1 -1
  67. package/build/legacy/usePrefetchQuery.js.map +1 -1
  68. package/build/legacy/useQueries.cjs +1 -1
  69. package/build/legacy/useQueries.cjs.map +1 -1
  70. package/build/legacy/useQueries.d.cts +2 -2
  71. package/build/legacy/useQueries.d.cts.map +1 -1
  72. package/build/legacy/useQueries.d.ts +2 -2
  73. package/build/legacy/useQueries.d.ts.map +1 -1
  74. package/build/legacy/useQueries.js +1 -1
  75. package/build/legacy/useQueries.js.map +1 -1
  76. package/build/legacy/useQuery.cjs.map +1 -1
  77. package/build/legacy/useQuery.d.cts +56 -22
  78. package/build/legacy/useQuery.d.cts.map +1 -1
  79. package/build/legacy/useQuery.d.ts +56 -22
  80. package/build/legacy/useQuery.d.ts.map +1 -1
  81. package/build/legacy/useQuery.js.map +1 -1
  82. package/build/legacy/useQueryClient.cjs.map +1 -1
  83. package/build/legacy/useQueryClient.d.cts +1 -1
  84. package/build/legacy/useQueryClient.d.cts.map +1 -1
  85. package/build/legacy/useQueryClient.d.ts +1 -1
  86. package/build/legacy/useQueryClient.d.ts.map +1 -1
  87. package/build/legacy/useQueryClient.js.map +1 -1
  88. package/build/legacy/utils.cjs.map +1 -1
  89. package/build/legacy/utils.js.map +1 -1
  90. package/build/legacy/vueQueryPlugin.cjs +1 -1
  91. package/build/legacy/vueQueryPlugin.cjs.map +1 -1
  92. package/build/legacy/vueQueryPlugin.d.cts +1 -1
  93. package/build/legacy/vueQueryPlugin.d.cts.map +1 -1
  94. package/build/legacy/vueQueryPlugin.d.ts +1 -1
  95. package/build/legacy/vueQueryPlugin.d.ts.map +1 -1
  96. package/build/legacy/vueQueryPlugin.js +1 -1
  97. package/build/legacy/vueQueryPlugin.js.map +1 -1
  98. package/build/modern/devtools/devtools.cjs +1 -1
  99. package/build/modern/devtools/devtools.cjs.map +1 -1
  100. package/build/modern/devtools/devtools.d.cts +1 -1
  101. package/build/modern/devtools/devtools.d.ts +1 -1
  102. package/build/modern/devtools/devtools.js +1 -1
  103. package/build/modern/devtools/devtools.js.map +1 -1
  104. package/build/modern/index.cjs +1 -1
  105. package/build/modern/index.d.cts +4 -4
  106. package/build/modern/index.d.ts +4 -4
  107. package/build/modern/index.js +1 -1
  108. package/build/modern/{infiniteQueryOptions-lJ_zR-As.d.cts → infiniteQueryOptions-CLfd_vOE.d.cts} +61 -17
  109. package/build/modern/infiniteQueryOptions-CLfd_vOE.d.cts.map +1 -0
  110. package/build/modern/{infiniteQueryOptions-CN37iZvc.d.ts → infiniteQueryOptions-vEnw-JaW.d.ts} +61 -17
  111. package/build/modern/infiniteQueryOptions-vEnw-JaW.d.ts.map +1 -0
  112. package/build/modern/infiniteQueryOptions.d.cts +1 -1
  113. package/build/modern/infiniteQueryOptions.d.ts +1 -1
  114. package/build/{legacy/queryClient-Ba4HSFnn.d.ts → modern/queryClient-6AWIHAhP.d.ts} +2 -2
  115. package/build/modern/{queryClient-Ba4HSFnn.d.ts.map → queryClient-6AWIHAhP.d.ts.map} +1 -1
  116. package/build/{legacy/queryClient-BGn8uIej.d.cts → modern/queryClient-yJW8K_VP.d.cts} +2 -2
  117. package/build/modern/{queryClient-BGn8uIej.d.cts.map → queryClient-yJW8K_VP.d.cts.map} +1 -1
  118. package/build/modern/queryClient.cjs +1 -1
  119. package/build/modern/queryClient.cjs.map +1 -1
  120. package/build/modern/queryClient.d.cts +1 -1
  121. package/build/modern/queryClient.d.ts +1 -1
  122. package/build/modern/queryClient.js +1 -1
  123. package/build/modern/queryClient.js.map +1 -1
  124. package/build/{legacy/queryOptions-BuZEBLtg.d.cts → modern/queryOptions-nndmAASX.d.cts} +22 -11
  125. package/build/modern/queryOptions-nndmAASX.d.cts.map +1 -0
  126. package/build/{legacy/queryOptions-dXiBZnGk.d.ts → modern/queryOptions-v0l6M7Eo.d.ts} +22 -11
  127. package/build/modern/queryOptions-v0l6M7Eo.d.ts.map +1 -0
  128. package/build/modern/queryOptions.cjs.map +1 -1
  129. package/build/modern/queryOptions.d.cts +2 -2
  130. package/build/modern/queryOptions.d.ts +2 -2
  131. package/build/modern/queryOptions.js.map +1 -1
  132. package/build/modern/types-u_Tu5Ybs.d.cts.map +1 -1
  133. package/build/modern/types-u_Tu5Ybs.d.ts.map +1 -1
  134. package/build/modern/useBaseQuery.cjs +11 -5
  135. package/build/modern/useBaseQuery.cjs.map +1 -1
  136. package/build/modern/useBaseQuery.d.cts +1 -1
  137. package/build/modern/useBaseQuery.d.ts +1 -1
  138. package/build/modern/useBaseQuery.js +11 -5
  139. package/build/modern/useBaseQuery.js.map +1 -1
  140. package/build/modern/useInfiniteQuery.cjs.map +1 -1
  141. package/build/modern/useInfiniteQuery.d.cts +1 -1
  142. package/build/modern/useInfiniteQuery.d.ts +1 -1
  143. package/build/modern/useInfiniteQuery.js.map +1 -1
  144. package/build/modern/useIsFetching.cjs.map +1 -1
  145. package/build/modern/useIsFetching.d.cts +1 -1
  146. package/build/modern/useIsFetching.d.ts +1 -1
  147. package/build/modern/useIsFetching.js.map +1 -1
  148. package/build/modern/useMutation.cjs.map +1 -1
  149. package/build/modern/useMutation.d.cts +1 -1
  150. package/build/modern/useMutation.d.ts +1 -1
  151. package/build/modern/useMutation.js.map +1 -1
  152. package/build/modern/useMutationState.cjs.map +1 -1
  153. package/build/modern/useMutationState.d.cts +1 -1
  154. package/build/modern/useMutationState.d.ts +1 -1
  155. package/build/modern/useMutationState.js.map +1 -1
  156. package/build/modern/usePrefetchInfiniteQuery.cjs.map +1 -1
  157. package/build/modern/usePrefetchInfiniteQuery.d.cts +1 -1
  158. package/build/modern/usePrefetchInfiniteQuery.d.ts +1 -1
  159. package/build/modern/usePrefetchInfiniteQuery.js.map +1 -1
  160. package/build/modern/usePrefetchQuery.cjs.map +1 -1
  161. package/build/modern/usePrefetchQuery.d.cts +1 -1
  162. package/build/modern/usePrefetchQuery.d.ts +1 -1
  163. package/build/modern/usePrefetchQuery.js.map +1 -1
  164. package/build/modern/useQueries.cjs +1 -1
  165. package/build/modern/useQueries.cjs.map +1 -1
  166. package/build/modern/useQueries.d.cts +2 -2
  167. package/build/modern/useQueries.d.cts.map +1 -1
  168. package/build/modern/useQueries.d.ts +2 -2
  169. package/build/modern/useQueries.d.ts.map +1 -1
  170. package/build/modern/useQueries.js +1 -1
  171. package/build/modern/useQueries.js.map +1 -1
  172. package/build/modern/useQuery.cjs.map +1 -1
  173. package/build/modern/useQuery.d.cts +56 -22
  174. package/build/modern/useQuery.d.cts.map +1 -1
  175. package/build/modern/useQuery.d.ts +56 -22
  176. package/build/modern/useQuery.d.ts.map +1 -1
  177. package/build/modern/useQuery.js.map +1 -1
  178. package/build/modern/useQueryClient.cjs.map +1 -1
  179. package/build/modern/useQueryClient.d.cts +1 -1
  180. package/build/modern/useQueryClient.d.cts.map +1 -1
  181. package/build/modern/useQueryClient.d.ts +1 -1
  182. package/build/modern/useQueryClient.d.ts.map +1 -1
  183. package/build/modern/useQueryClient.js.map +1 -1
  184. package/build/modern/utils.cjs.map +1 -1
  185. package/build/modern/utils.js.map +1 -1
  186. package/build/modern/vueQueryPlugin.cjs +1 -1
  187. package/build/modern/vueQueryPlugin.cjs.map +1 -1
  188. package/build/modern/vueQueryPlugin.d.cts +1 -1
  189. package/build/modern/vueQueryPlugin.d.cts.map +1 -1
  190. package/build/modern/vueQueryPlugin.d.ts +1 -1
  191. package/build/modern/vueQueryPlugin.d.ts.map +1 -1
  192. package/build/modern/vueQueryPlugin.js +1 -1
  193. package/build/modern/vueQueryPlugin.js.map +1 -1
  194. package/package.json +12 -2
  195. package/src/devtools/devtools.ts +2 -2
  196. package/src/index.ts +2 -0
  197. package/src/queryClient.ts +12 -12
  198. package/src/queryOptions.ts +40 -23
  199. package/src/types.ts +2 -0
  200. package/src/useBaseQuery.ts +71 -11
  201. package/src/useInfiniteQuery.ts +32 -28
  202. package/src/useIsFetching.ts +2 -2
  203. package/src/useMutation.ts +4 -4
  204. package/src/useMutationState.ts +2 -2
  205. package/src/usePrefetchInfiniteQuery.ts +1 -1
  206. package/src/usePrefetchQuery.ts +1 -1
  207. package/src/useQueries.ts +9 -5
  208. package/src/useQuery.ts +55 -21
  209. package/src/useQueryClient.ts +0 -1
  210. package/src/utils.ts +2 -2
  211. package/src/vueQueryPlugin.ts +2 -3
  212. package/build/legacy/infiniteQueryOptions-CN37iZvc.d.ts.map +0 -1
  213. package/build/legacy/infiniteQueryOptions-lJ_zR-As.d.cts.map +0 -1
  214. package/build/legacy/queryOptions-BuZEBLtg.d.cts.map +0 -1
  215. package/build/legacy/queryOptions-dXiBZnGk.d.ts.map +0 -1
  216. package/build/modern/infiniteQueryOptions-CN37iZvc.d.ts.map +0 -1
  217. package/build/modern/infiniteQueryOptions-lJ_zR-As.d.cts.map +0 -1
  218. package/build/modern/queryOptions-BuZEBLtg.d.cts.map +0 -1
  219. package/build/modern/queryOptions-dXiBZnGk.d.ts.map +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"useQueries.cjs","names":["getCurrentScope","useQueryClient","computed","unref","cloneDeepUnref","QueriesObserver","shallowRef","shallowReadonly","readonly"],"sources":["../../src/useQueries.ts"],"sourcesContent":["import { QueriesObserver } from '@tanstack/query-core'\nimport {\n computed,\n getCurrentScope,\n onScopeDispose,\n readonly,\n shallowReadonly,\n shallowRef,\n unref,\n watch,\n} from 'vue-demi'\n\nimport { useQueryClient } from './useQueryClient'\nimport { cloneDeepUnref } from './utils'\nimport type { Ref } from 'vue-demi'\nimport type {\n DefaultError,\n DefinedQueryObserverResult,\n QueriesObserverOptions,\n QueryFunction,\n QueryKey,\n QueryObserverResult,\n ThrowOnError,\n} from '@tanstack/query-core'\nimport type { UseQueryOptions } from './queryOptions'\nimport type { QueryClient } from './queryClient'\nimport type { DeepUnwrapRef, MaybeRefDeep, ShallowOption } from './types'\n\n// This defines the `UseQueryOptions` that are accepted in `QueriesOptions` & `GetOptions`.\n// `placeholderData` function does not have a parameter\ntype UseQueryOptionsForUseQueries<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>\n\n// Avoid TS depth-limit error in case of large array literal\ntype MAXIMUM_DEPTH = 20\n\n// Widen the type of the symbol to enable type inference even if skipToken is not immutable.\ntype SkipTokenForUseQueries = symbol\n\ntype GetUseQueryOptionsForUseQueries<T> =\n // Part 1: if UseQueryOptions are already being sent through, then just return T\n T extends UseQueryOptions\n ? DeepUnwrapRef<T>\n : // Part 2: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }\n T extends {\n queryFnData: infer TQueryFnData\n error?: infer TError\n data: infer TData\n }\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseQueryOptionsForUseQueries<unknown, TError, TData>\n : // Part 3: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]\n T extends [infer TQueryFnData, infer TError, infer TData]\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData>\n : T extends [infer TQueryFnData, infer TError]\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseQueryOptionsForUseQueries<TQueryFnData>\n : // Part 4: responsible for inferring and enforcing type if no explicit parameter was provided\n T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, infer TQueryKey>\n | SkipTokenForUseQueries\n select?: (data: any) => infer TData\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? UseQueryOptionsForUseQueries<\n TQueryFnData,\n unknown extends TError ? DefaultError : TError,\n unknown extends TData ? TQueryFnData : TData,\n TQueryKey\n >\n : T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, infer TQueryKey>\n | SkipTokenForUseQueries\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? UseQueryOptionsForUseQueries<\n TQueryFnData,\n TError,\n TQueryFnData,\n TQueryKey\n >\n : // Fallback\n UseQueryOptionsForUseQueries\n\n// A defined initialData setting should return a DefinedQueryObserverResult rather than QueryObserverResult\ntype GetDefinedOrUndefinedQueryResult<T, TData, TError = unknown> = T extends {\n initialData?: infer TInitialData\n}\n ? unknown extends TInitialData\n ? QueryObserverResult<TData, TError>\n : TInitialData extends TData\n ? DefinedQueryObserverResult<TData, TError>\n : TInitialData extends () => infer TInitialDataResult\n ? unknown extends TInitialDataResult\n ? QueryObserverResult<TData, TError>\n : TInitialDataResult extends TData\n ? DefinedQueryObserverResult<TData, TError>\n : QueryObserverResult<TData, TError>\n : QueryObserverResult<TData, TError>\n : QueryObserverResult<TData, TError>\n\ntype GetUseQueryResult<T> =\n // Part 1: if using UseQueryOptions then the types are already set\n T extends UseQueryOptions<\n infer TQueryFnData,\n infer TError,\n infer TData,\n any,\n any\n >\n ? GetDefinedOrUndefinedQueryResult<\n T,\n undefined extends TData ? TQueryFnData : TData,\n unknown extends TError ? DefaultError : TError\n >\n : // Part 2: responsible for mapping explicit type parameter to function result, if object\n T extends { queryFnData: any; error?: infer TError; data: infer TData }\n ? GetDefinedOrUndefinedQueryResult<T, TData, TError>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? GetDefinedOrUndefinedQueryResult<T, TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? GetDefinedOrUndefinedQueryResult<T, TData, TError>\n : // Part 3: responsible for mapping explicit type parameter to function result, if tuple\n T extends [any, infer TError, infer TData]\n ? GetDefinedOrUndefinedQueryResult<T, TData, TError>\n : T extends [infer TQueryFnData, infer TError]\n ? GetDefinedOrUndefinedQueryResult<T, TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? GetDefinedOrUndefinedQueryResult<T, TQueryFnData>\n : // Part 4: responsible for mapping inferred type to results, if no explicit parameter was provided\n T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, any>\n | SkipTokenForUseQueries\n select?: (data: any) => infer TData\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? GetDefinedOrUndefinedQueryResult<\n T,\n unknown extends TData ? TQueryFnData : TData,\n unknown extends TError ? DefaultError : TError\n >\n : T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, any>\n | SkipTokenForUseQueries\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? GetDefinedOrUndefinedQueryResult<\n T,\n TQueryFnData,\n unknown extends TError ? DefaultError : TError\n >\n : // Fallback\n QueryObserverResult\n\n/**\n * UseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param\n */\nexport type UseQueriesOptions<\n T extends Array<any>,\n TResults extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseQueryOptionsForUseQueries>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResults, GetUseQueryOptionsForUseQueries<Head>]\n : T extends [infer Head, ...infer Tails]\n ? UseQueriesOptions<\n [...Tails],\n [...TResults, GetUseQueryOptionsForUseQueries<Head>],\n [...TDepth, 1]\n >\n : ReadonlyArray<unknown> extends T\n ? T\n : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogeneous type!\n // use this to infer the param types in the case of Array.map() argument\n T extends Array<\n UseQueryOptionsForUseQueries<\n infer TQueryFnData,\n infer TError,\n infer TData,\n infer TQueryKey\n >\n >\n ? Array<\n UseQueryOptionsForUseQueries<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >\n >\n : // Fallback\n Array<UseQueryOptionsForUseQueries>\n\n/**\n * UseQueriesResults reducer recursively maps type param to results\n */\nexport type UseQueriesResults<\n T extends Array<any>,\n TResults extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<QueryObserverResult>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResults, GetUseQueryResult<Head>]\n : T extends [infer Head, ...infer Tails]\n ? UseQueriesResults<\n [...Tails],\n [...TResults, GetUseQueryResult<Head>],\n [...TDepth, 1]\n >\n : { [K in keyof T]: GetUseQueryResult<T[K]> }\n\ntype UseQueriesOptionsArg<T extends Array<any>> = readonly [\n ...UseQueriesOptions<T>,\n]\n\n/**\n * The `useQueries` composable can be used to fetch a variable number of queries.\n *\n * The `queries` option accepts an array of query option objects mostly identical to `useQuery`'s. It may be a\n * plain array, a `ref`/reactive array (each entry tracked individually), or a getter function — pass a getter\n * if the array itself (its length, or which queries are in it) depends on other reactive state.\n *\n * Having the same query key more than once in the array of query objects may cause some data to be shared\n * between queries. To avoid this, consider de-duplicating the queries and map the results back to the desired\n * structure.\n *\n * The `combine` option can be used to combine the results of the queries into a single value. The result will\n * be structurally shared to be as referentially stable as possible.\n *\n * `placeholderData` is supported here too, but unlike `useQuery`, it doesn't receive information from\n * previously rendered queries, because the number of queries can differ between renders.\n * @param options - The `queries` array to run, and the optional `combine` and `shallow` options.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one provided by `VueQueryPlugin`\n * will be used.\n * @returns A `ref` to the combined result. Without `combine`, this is an array with all the query results, in\n * the same order as the input. When `combine` is provided, this is the value returned by `combine` instead.\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQueries } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ ids: Array<number> }>()\n *\n * const postQueries = useQueries({\n * queries: () =>\n * props.ids.map((id) => ({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * staleTime: Infinity,\n * })),\n * })\n * </script>\n *\n * <template>\n * <ul>\n * <li v-for=\"(query, index) in postQueries\" :key=\"props.ids[index]\">\n * <span v-if=\"query.isPending\">Loading...</span>\n * <span v-else-if=\"query.isError\">Error: {{ query.error.message }}</span>\n * <span v-else>{{ query.data.title }}</span>\n * </li>\n * </ul>\n * </template>\n * ```\n * @example\n * Combining results into a single value:\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQueries } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ ids: Array<number> }>()\n *\n * const combined = useQueries({\n * queries: () =>\n * props.ids.map((id) => ({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * })),\n * combine: (postQueries) => ({\n * data: postQueries.map((query) => query.data),\n * isPending: postQueries.some((query) => query.isPending),\n * isError: postQueries.some((query) => query.isError),\n * }),\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"combined.isPending\">Loading...</span>\n * <span v-else-if=\"combined.isError\">Error!</span>\n * <ul v-else>\n * <li v-for=\"post in combined.data\" :key=\"post.id\">{{ post.title }}</li>\n * </ul>\n * </template>\n * ```\n * @example\n * Typing `select` via {@link queryOptions}. Note that spreading a `queryOptions` result and overriding\n * `select` inline still falls back to `unknown` — wrap the spread in `queryOptions` again so the override is\n * resolved before it reaches `useQueries`:\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, useQueries } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ id: number }>()\n *\n * const postOptions = (id: number) =>\n * queryOptions({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * })\n *\n * const [{ data: broken }] = useQueries({\n * queries: () => [\n * {\n * ...postOptions(props.id),\n * // ❌ `data` is `unknown` here\n * select: (data) => data.title,\n * },\n * ],\n * })\n *\n * const [{ data: fixed }] = useQueries({\n * queries: () => [\n * queryOptions({\n * ...postOptions(props.id),\n * // ✅ `data` is `Post`\n * select: (data) => data.title,\n * }),\n * ],\n * })\n * </script>\n *\n * <template>\n * <h1>{{ fixed }}</h1>\n * </template>\n * ```\n */\nexport function useQueries<\n T extends Array<any>,\n TCombinedResult = UseQueriesResults<T>,\n>(\n {\n queries,\n ...options\n }: ShallowOption & {\n queries:\n | (() => MaybeRefDeep<UseQueriesOptionsArg<T>>)\n | MaybeRefDeep<UseQueriesOptionsArg<T>>\n | MaybeRefDeep<\n readonly [\n ...{ [K in keyof T]: GetUseQueryOptionsForUseQueries<T[K]> },\n ]\n >\n combine?: (result: UseQueriesResults<T>) => TCombinedResult\n },\n queryClient?: QueryClient,\n): Readonly<Ref<TCombinedResult>> {\n if (process.env.NODE_ENV === 'development') {\n if (!getCurrentScope()) {\n console.warn(\n 'vue-query composable like \"useQuery()\" should only be used inside a \"setup()\" function or a running effect scope. They might otherwise lead to memory leaks.',\n )\n }\n }\n\n const client = queryClient || useQueryClient()\n\n const defaultedQueries = computed(() => {\n const resolvedQueries =\n typeof queries === 'function'\n ? (queries as () => MaybeRefDeep<UseQueriesOptionsArg<T>>)()\n : queries\n // Only unref the top level array.\n const queriesRaw = unref(resolvedQueries) as ReadonlyArray<any>\n\n // Unref the rest for each element in the top level array.\n return queriesRaw.map((queryOptions) => {\n const clonedOptions = cloneDeepUnref(queryOptions)\n\n if (typeof clonedOptions.enabled === 'function') {\n clonedOptions.enabled = queryOptions.enabled()\n }\n\n const defaulted = client.defaultQueryOptions(clonedOptions)\n defaulted._optimisticResults = client.isRestoring?.value\n ? 'isRestoring'\n : 'optimistic'\n\n return defaulted\n })\n })\n\n const observer = new QueriesObserver<TCombinedResult>(\n client,\n defaultedQueries.value,\n options as QueriesObserverOptions<TCombinedResult>,\n )\n\n const getOptimisticResult = () => {\n const [results, getCombinedResult] = observer.getOptimisticResult(\n defaultedQueries.value,\n (options as QueriesObserverOptions<TCombinedResult>).combine,\n )\n\n return getCombinedResult(\n results.map((result, index) => {\n return {\n ...result,\n refetch: async (...args: Array<any>) => {\n const [{ [index]: query }] = observer.getOptimisticResult(\n defaultedQueries.value,\n (options as QueriesObserverOptions<TCombinedResult>).combine,\n )\n\n return query!.refetch(...args)\n },\n }\n }),\n )\n }\n\n const state = shallowRef(getOptimisticResult())\n\n let unsubscribe = () => {\n // noop\n }\n\n if (client.isRestoring) {\n watch(\n client.isRestoring,\n (isRestoring) => {\n if (!isRestoring) {\n unsubscribe()\n unsubscribe = observer.subscribe(() => {\n state.value = getOptimisticResult()\n })\n\n state.value = getOptimisticResult()\n }\n },\n { immediate: true },\n )\n }\n\n watch(defaultedQueries, (queriesValue) => {\n observer.setQueries(\n queriesValue,\n options as QueriesObserverOptions<TCombinedResult>,\n )\n state.value = getOptimisticResult()\n })\n\n onScopeDispose(() => {\n unsubscribe()\n })\n\n return options.shallow\n ? shallowReadonly(state)\n : (readonly(state) as Readonly<Ref<TCombinedResult>>)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiWA,SAAgB,WAId,EACE,SACA,GAAG,WAYL,aACgC;CAChC,IAAI,QAAQ,IAAI,aAAa,eACvB;MAAA,EAAA,GAACA,SAAAA,gBAAAA,CAAgB,GACnB,QAAQ,KACN,kKACF;CAAA;CAIJ,MAAM,SAAS,eAAeC,uBAAAA,eAAe;CAE7C,MAAM,oBAAA,GAAmBC,SAAAA,SAAAA,OAAe;EACtC,MAAM,kBACJ,OAAO,YAAY,aACd,QAAwD,IACzD;EAKN,QAAA,GAHmBC,SAAAA,MAAAA,CAAM,eAGT,CAAC,CAAC,KAAK,iBAAiB;GACtC,MAAM,gBAAgBC,cAAAA,eAAe,YAAY;GAEjD,IAAI,OAAO,cAAc,YAAY,YACnC,cAAc,UAAU,aAAa,QAAQ;GAG/C,MAAM,YAAY,OAAO,oBAAoB,aAAa;GAC1D,UAAU,qBAAqB,OAAO,aAAa,QAC/C,gBACA;GAEJ,OAAO;EACT,CAAC;CACH,CAAC;CAED,MAAM,WAAW,IAAIC,qBAAAA,gBACnB,QACA,iBAAiB,OACjB,OACF;CAEA,MAAM,4BAA4B;EAChC,MAAM,CAAC,SAAS,qBAAqB,SAAS,oBAC5C,iBAAiB,OAChB,QAAoD,OACvD;EAEA,OAAO,kBACL,QAAQ,KAAK,QAAQ,UAAU;GAC7B,OAAO;IACL,GAAG;IACH,SAAS,OAAO,GAAG,SAAqB;KACtC,MAAM,CAAC,GAAG,QAAQ,WAAW,SAAS,oBACpC,iBAAiB,OAChB,QAAoD,OACvD;KAEA,OAAO,MAAO,QAAQ,GAAG,IAAI;IAC/B;GACF;EACF,CAAC,CACH;CACF;CAEA,MAAM,SAAA,GAAQC,SAAAA,WAAAA,CAAW,oBAAoB,CAAC;CAE9C,IAAI,oBAAoB,CAExB;CAEA,IAAI,OAAO,aACT,CAAA,GAAA,SAAA,MAAA,CACE,OAAO,cACN,gBAAgB;EACf,IAAI,CAAC,aAAa;GAChB,YAAY;GACZ,cAAc,SAAS,gBAAgB;IACrC,MAAM,QAAQ,oBAAoB;GACpC,CAAC;GAED,MAAM,QAAQ,oBAAoB;EACpC;CACF,GACA,EAAE,WAAW,KAAK,CACpB;CAGF,CAAA,GAAA,SAAA,MAAA,CAAM,mBAAmB,iBAAiB;EACxC,SAAS,WACP,cACA,OACF;EACA,MAAM,QAAQ,oBAAoB;CACpC,CAAC;CAED,CAAA,GAAA,SAAA,eAAA,OAAqB;EACnB,YAAY;CACd,CAAC;CAED,OAAO,QAAQ,WAAA,GACXC,SAAAA,gBAAAA,CAAgB,KAAK,KAAA,GACpBC,SAAAA,SAAAA,CAAS,KAAK;AACrB"}
1
+ {"version":3,"file":"useQueries.cjs","names":["getCurrentScope","useQueryClient","computed","unref","cloneDeepUnref","QueriesObserver","shallowRef","shallowReadonly","readonly"],"sources":["../../src/useQueries.ts"],"sourcesContent":["import { QueriesObserver } from '@tanstack/query-core'\nimport {\n computed,\n getCurrentScope,\n onScopeDispose,\n readonly,\n shallowReadonly,\n shallowRef,\n unref,\n watch,\n} from 'vue-demi'\nimport { useQueryClient } from './useQueryClient'\nimport { cloneDeepUnref } from './utils'\nimport type {\n DefaultError,\n DefinedQueryObserverResult,\n QueriesObserverOptions,\n QueryFunction,\n QueryKey,\n QueryObserverResult,\n ThrowOnError,\n} from '@tanstack/query-core'\nimport type { Ref } from 'vue-demi'\nimport type { QueryClient } from './queryClient'\nimport type { UseQueryOptions } from './queryOptions'\nimport type { DeepUnwrapRef, MaybeRefDeep, ShallowOption } from './types'\n\n// This defines the `UseQueryOptions` that are accepted in `QueriesOptions` & `GetOptions`.\n// `placeholderData` function does not have a parameter\ntype UseQueryOptionsForUseQueries<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>\n\n// Avoid TS depth-limit error in case of large array literal\ntype MAXIMUM_DEPTH = 20\n\n// Widen the type of the symbol to enable type inference even if skipToken is not immutable.\ntype SkipTokenForUseQueries = symbol\n\ntype GetUseQueryOptionsForUseQueries<T> =\n // Part 1: if UseQueryOptions are already being sent through, then just return T\n T extends UseQueryOptions\n ? DeepUnwrapRef<T>\n : // Part 2: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }\n T extends {\n queryFnData: infer TQueryFnData\n error?: infer TError\n data: infer TData\n }\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseQueryOptionsForUseQueries<unknown, TError, TData>\n : // Part 3: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]\n T extends [infer TQueryFnData, infer TError, infer TData]\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData>\n : T extends [infer TQueryFnData, infer TError]\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseQueryOptionsForUseQueries<TQueryFnData>\n : // Part 4: responsible for inferring and enforcing type if no explicit parameter was provided\n T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, infer TQueryKey>\n | SkipTokenForUseQueries\n select?: (data: any) => infer TData\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? UseQueryOptionsForUseQueries<\n TQueryFnData,\n unknown extends TError ? DefaultError : TError,\n unknown extends TData ? TQueryFnData : TData,\n TQueryKey\n >\n : T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, infer TQueryKey>\n | SkipTokenForUseQueries\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? UseQueryOptionsForUseQueries<\n TQueryFnData,\n TError,\n TQueryFnData,\n TQueryKey\n >\n : // Fallback\n UseQueryOptionsForUseQueries\n\n// A defined initialData setting should return a DefinedQueryObserverResult rather than QueryObserverResult\ntype GetDefinedOrUndefinedQueryResult<T, TData, TError = unknown> = T extends {\n initialData?: infer TInitialData\n}\n ? unknown extends TInitialData\n ? QueryObserverResult<TData, TError>\n : TInitialData extends TData\n ? DefinedQueryObserverResult<TData, TError>\n : TInitialData extends () => infer TInitialDataResult\n ? unknown extends TInitialDataResult\n ? QueryObserverResult<TData, TError>\n : TInitialDataResult extends TData\n ? DefinedQueryObserverResult<TData, TError>\n : QueryObserverResult<TData, TError>\n : QueryObserverResult<TData, TError>\n : QueryObserverResult<TData, TError>\n\ntype GetUseQueryResult<T> =\n // Part 1: if using UseQueryOptions then the types are already set\n T extends UseQueryOptions<\n infer TQueryFnData,\n infer TError,\n infer TData,\n any,\n any\n >\n ? GetDefinedOrUndefinedQueryResult<\n T,\n undefined extends TData ? TQueryFnData : TData,\n unknown extends TError ? DefaultError : TError\n >\n : // Part 2: responsible for mapping explicit type parameter to function result, if object\n T extends { queryFnData: any; error?: infer TError; data: infer TData }\n ? GetDefinedOrUndefinedQueryResult<T, TData, TError>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? GetDefinedOrUndefinedQueryResult<T, TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? GetDefinedOrUndefinedQueryResult<T, TData, TError>\n : // Part 3: responsible for mapping explicit type parameter to function result, if tuple\n T extends [any, infer TError, infer TData]\n ? GetDefinedOrUndefinedQueryResult<T, TData, TError>\n : T extends [infer TQueryFnData, infer TError]\n ? GetDefinedOrUndefinedQueryResult<T, TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? GetDefinedOrUndefinedQueryResult<T, TQueryFnData>\n : // Part 4: responsible for mapping inferred type to results, if no explicit parameter was provided\n T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, any>\n | SkipTokenForUseQueries\n select?: (data: any) => infer TData\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? GetDefinedOrUndefinedQueryResult<\n T,\n unknown extends TData ? TQueryFnData : TData,\n unknown extends TError ? DefaultError : TError\n >\n : T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, any>\n | SkipTokenForUseQueries\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? GetDefinedOrUndefinedQueryResult<\n T,\n TQueryFnData,\n unknown extends TError ? DefaultError : TError\n >\n : // Fallback\n QueryObserverResult\n\n/**\n * UseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param\n */\nexport type UseQueriesOptions<\n T extends Array<any>,\n TResults extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseQueryOptionsForUseQueries>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResults, GetUseQueryOptionsForUseQueries<Head>]\n : T extends [infer Head, ...infer Tails]\n ? UseQueriesOptions<\n [...Tails],\n [...TResults, GetUseQueryOptionsForUseQueries<Head>],\n [...TDepth, 1]\n >\n : ReadonlyArray<unknown> extends T\n ? T\n : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogeneous type!\n // use this to infer the param types in the case of Array.map() argument\n T extends Array<\n UseQueryOptionsForUseQueries<\n infer TQueryFnData,\n infer TError,\n infer TData,\n infer TQueryKey\n >\n >\n ? Array<\n UseQueryOptionsForUseQueries<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >\n >\n : // Fallback\n Array<UseQueryOptionsForUseQueries>\n\n/**\n * UseQueriesResults reducer recursively maps type param to results\n */\nexport type UseQueriesResults<\n T extends Array<any>,\n TResults extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<QueryObserverResult>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResults, GetUseQueryResult<Head>]\n : T extends [infer Head, ...infer Tails]\n ? UseQueriesResults<\n [...Tails],\n [...TResults, GetUseQueryResult<Head>],\n [...TDepth, 1]\n >\n : { [K in keyof T]: GetUseQueryResult<T[K]> }\n\ntype UseQueriesOptionsArg<T extends Array<any>> = readonly [\n ...UseQueriesOptions<T>,\n]\n\n/**\n * The `useQueries` composable can be used to fetch a variable number of queries.\n *\n * The `queries` option accepts an array of query option objects mostly identical to `useQuery`'s. It may be a\n * plain array, a `ref`/reactive array (each entry tracked individually), or a getter function — pass a getter\n * if the array itself (its length, or which queries are in it) depends on other reactive state.\n *\n * Having the same query key more than once in the array of query objects may cause some data to be shared\n * between queries. To avoid this, consider de-duplicating the queries and map the results back to the desired\n * structure.\n *\n * The `combine` option can be used to combine the results of the queries into a single value. The result will\n * be structurally shared to be as referentially stable as possible.\n *\n * `placeholderData` is supported here too, but unlike `useQuery`, it doesn't receive information from\n * previously rendered queries, because the number of queries can differ between renders.\n * @param options - The `queries` array to run, and the optional `combine` and `shallow` options.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one provided by `VueQueryPlugin`\n * will be used.\n * @returns A `ref` to the combined result. Without `combine`, this is an array with all the query results, in\n * the same order as the input. When `combine` is provided, this is the value returned by `combine` instead.\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQueries } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ ids: Array<number> }>()\n *\n * const postQueries = useQueries({\n * queries: () =>\n * props.ids.map((id) => ({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * staleTime: Infinity,\n * })),\n * })\n * </script>\n *\n * <template>\n * <ul>\n * <li v-for=\"(query, index) in postQueries\" :key=\"props.ids[index]\">\n * <span v-if=\"query.isPending\">Loading...</span>\n * <span v-else-if=\"query.isError\">Error: {{ query.error.message }}</span>\n * <span v-else>{{ query.data.title }}</span>\n * </li>\n * </ul>\n * </template>\n * ```\n * @example\n * Combining results into a single value:\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQueries } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ ids: Array<number> }>()\n *\n * const combined = useQueries({\n * queries: () =>\n * props.ids.map((id) => ({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * })),\n * combine: (postQueries) => ({\n * data: postQueries.map((query) => query.data),\n * isPending: postQueries.some((query) => query.isPending),\n * isError: postQueries.some((query) => query.isError),\n * }),\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"combined.isPending\">Loading...</span>\n * <span v-else-if=\"combined.isError\">Error!</span>\n * <ul v-else>\n * <li v-for=\"post in combined.data\" :key=\"post.id\">{{ post.title }}</li>\n * </ul>\n * </template>\n * ```\n * @example\n * Typing `select` via {@link queryOptions}. Note that spreading a `queryOptions` result and overriding\n * `select` inline still falls back to `unknown` — wrap the spread in `queryOptions` again so the override is\n * resolved before it reaches `useQueries`:\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, useQueries } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ id: number }>()\n *\n * const postOptions = (id: number) =>\n * queryOptions({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * })\n *\n * const [{ data: broken }] = useQueries({\n * queries: () => [\n * {\n * ...postOptions(props.id),\n * // ❌ `data` is `unknown` here\n * select: (data) => data.title,\n * },\n * ],\n * })\n *\n * const [{ data: fixed }] = useQueries({\n * queries: () => [\n * queryOptions({\n * ...postOptions(props.id),\n * // ✅ `data` is `Post`\n * select: (data) => data.title,\n * }),\n * ],\n * })\n * </script>\n *\n * <template>\n * <h1>{{ fixed }}</h1>\n * </template>\n * ```\n */\nexport function useQueries<\n T extends Array<any>,\n TCombinedResult = UseQueriesResults<T>,\n>(\n {\n queries,\n ...options\n }: ShallowOption & {\n queries:\n | (() => MaybeRefDeep<UseQueriesOptionsArg<T>>)\n | MaybeRefDeep<UseQueriesOptionsArg<T>>\n | MaybeRefDeep<\n readonly [\n ...{ [K in keyof T]: GetUseQueryOptionsForUseQueries<T[K]> },\n ]\n >\n combine?: (result: UseQueriesResults<T>) => TCombinedResult\n },\n queryClient?: QueryClient,\n): Readonly<Ref<TCombinedResult>> {\n if (process.env.NODE_ENV === 'development') {\n if (!getCurrentScope()) {\n console.warn(\n 'vue-query composable like \"useQuery()\" should only be used inside a \"setup()\" function or a running effect scope. They might otherwise lead to memory leaks.',\n )\n }\n }\n\n const client = queryClient || useQueryClient()\n\n const defaultedQueries = computed(() => {\n const resolvedQueries =\n typeof queries === 'function'\n ? (queries as () => MaybeRefDeep<UseQueriesOptionsArg<T>>)()\n : queries\n // Only unref the top level array.\n const queriesRaw = unref(resolvedQueries) as ReadonlyArray<any>\n\n // Unref the rest for each element in the top level array.\n return queriesRaw.map((queryOptions) => {\n const clonedOptions = cloneDeepUnref(queryOptions)\n\n // A zero-arg function is a Vue getter and must run here so its refs are tracked.\n // `(query) => boolean` is query-core's callback and is left for core to call.\n if (\n typeof clonedOptions.enabled === 'function' &&\n clonedOptions.enabled.length === 0\n ) {\n clonedOptions.enabled = clonedOptions.enabled()\n }\n\n const defaulted = client.defaultQueryOptions(clonedOptions)\n defaulted._optimisticResults = client.isRestoring?.value\n ? 'isRestoring'\n : 'optimistic'\n\n return defaulted\n })\n })\n\n const observer = new QueriesObserver<TCombinedResult>(\n client,\n defaultedQueries.value,\n options as QueriesObserverOptions<TCombinedResult>,\n )\n\n const getOptimisticResult = () => {\n const [results, getCombinedResult] = observer.getOptimisticResult(\n defaultedQueries.value,\n (options as QueriesObserverOptions<TCombinedResult>).combine,\n )\n\n return getCombinedResult(\n results.map((result, index) => {\n return {\n ...result,\n refetch: async (...args: Array<any>) => {\n const [{ [index]: query }] = observer.getOptimisticResult(\n defaultedQueries.value,\n (options as QueriesObserverOptions<TCombinedResult>).combine,\n )\n\n return query!.refetch(...args)\n },\n }\n }),\n )\n }\n\n const state = shallowRef(getOptimisticResult())\n\n let unsubscribe = () => {\n // noop\n }\n\n if (client.isRestoring) {\n watch(\n client.isRestoring,\n (isRestoring) => {\n if (!isRestoring) {\n unsubscribe()\n unsubscribe = observer.subscribe(() => {\n state.value = getOptimisticResult()\n })\n\n state.value = getOptimisticResult()\n }\n },\n { immediate: true },\n )\n }\n\n watch(defaultedQueries, (queriesValue) => {\n observer.setQueries(\n queriesValue,\n options as QueriesObserverOptions<TCombinedResult>,\n )\n state.value = getOptimisticResult()\n })\n\n onScopeDispose(() => {\n unsubscribe()\n })\n\n return options.shallow\n ? shallowReadonly(state)\n : (readonly(state) as Readonly<Ref<TCombinedResult>>)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgWA,SAAgB,WAId,EACE,SACA,GAAG,WAYL,aACgC;CAChC,IAAI,QAAQ,IAAI,aAAa,eACvB;MAAA,EAAA,GAACA,SAAAA,gBAAAA,CAAgB,GACnB,QAAQ,KACN,kKACF;CAAA;CAIJ,MAAM,SAAS,eAAeC,uBAAAA,eAAe;CAE7C,MAAM,oBAAA,GAAmBC,SAAAA,SAAAA,OAAe;EACtC,MAAM,kBACJ,OAAO,YAAY,aACd,QAAwD,IACzD;EAKN,QAAA,GAHmBC,SAAAA,MAAAA,CAAM,eAGT,CAAC,CAAC,KAAK,iBAAiB;GACtC,MAAM,gBAAgBC,cAAAA,eAAe,YAAY;GAIjD,IACE,OAAO,cAAc,YAAY,cACjC,cAAc,QAAQ,WAAW,GAEjC,cAAc,UAAU,cAAc,QAAQ;GAGhD,MAAM,YAAY,OAAO,oBAAoB,aAAa;GAC1D,UAAU,qBAAqB,OAAO,aAAa,QAC/C,gBACA;GAEJ,OAAO;EACT,CAAC;CACH,CAAC;CAED,MAAM,WAAW,IAAIC,qBAAAA,gBACnB,QACA,iBAAiB,OACjB,OACF;CAEA,MAAM,4BAA4B;EAChC,MAAM,CAAC,SAAS,qBAAqB,SAAS,oBAC5C,iBAAiB,OAChB,QAAoD,OACvD;EAEA,OAAO,kBACL,QAAQ,KAAK,QAAQ,UAAU;GAC7B,OAAO;IACL,GAAG;IACH,SAAS,OAAO,GAAG,SAAqB;KACtC,MAAM,CAAC,GAAG,QAAQ,WAAW,SAAS,oBACpC,iBAAiB,OAChB,QAAoD,OACvD;KAEA,OAAO,MAAO,QAAQ,GAAG,IAAI;IAC/B;GACF;EACF,CAAC,CACH;CACF;CAEA,MAAM,SAAA,GAAQC,SAAAA,WAAAA,CAAW,oBAAoB,CAAC;CAE9C,IAAI,oBAAoB,CAExB;CAEA,IAAI,OAAO,aACT,CAAA,GAAA,SAAA,MAAA,CACE,OAAO,cACN,gBAAgB;EACf,IAAI,CAAC,aAAa;GAChB,YAAY;GACZ,cAAc,SAAS,gBAAgB;IACrC,MAAM,QAAQ,oBAAoB;GACpC,CAAC;GAED,MAAM,QAAQ,oBAAoB;EACpC;CACF,GACA,EAAE,WAAW,KAAK,CACpB;CAGF,CAAA,GAAA,SAAA,MAAA,CAAM,mBAAmB,iBAAiB;EACxC,SAAS,WACP,cACA,OACF;EACA,MAAM,QAAQ,oBAAoB;CACpC,CAAC;CAED,CAAA,GAAA,SAAA,eAAA,OAAqB;EACnB,YAAY;CACd,CAAC;CAED,OAAO,QAAQ,WAAA,GACXC,SAAAA,gBAAAA,CAAgB,KAAK,KAAA,GACpBC,SAAAA,SAAAA,CAAS,KAAK;AACrB"}
@@ -1,6 +1,6 @@
1
1
  import { d as ShallowOption, o as MaybeRefDeep, t as DeepUnwrapRef } from "./types-u_Tu5Ybs.cjs";
2
- import { o as UseQueryOptions } from "./queryOptions-BuZEBLtg.cjs";
3
- import { t as QueryClient$1 } from "./queryClient-BGn8uIej.cjs";
2
+ import { o as UseQueryOptions } from "./queryOptions-nndmAASX.cjs";
3
+ import { t as QueryClient$1 } from "./queryClient-yJW8K_VP.cjs";
4
4
  import { DefaultError, DefinedQueryObserverResult, QueryFunction, QueryKey, QueryObserverResult, ThrowOnError } from "@tanstack/query-core";
5
5
  import { Ref } from "vue-demi";
6
6
  type UseQueryOptionsForUseQueries<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>;
@@ -1 +1 @@
1
- {"version":3,"file":"useQueries.d.cts","names":["QueryClient"],"sources":["../../src/useQueries.ts"],"mappings":";;;;;KA8BK,6BACH,wBACA,kBACA,QAAQ,cACR,kBAAkB,WAAW,YAC3B,gBAAgB,cAAc,QAAQ,OAAO,cAAc;KAG1D;KAGA;KAEA,gCAAgC,KAEnC,UAAU,kBACN,cAAc,KAEd;EACI,mBAAmB;EACnB,cAAc;EACd,YAAY;IAEd,6BAA6B,cAAc,QAAQ,SACnD;EAAY,mBAAmB;EAAc,cAAc;IACzD,6BAA6B,cAAc,UAC3C;EAAY,YAAY;EAAO,cAAc;IAC3C,sCAAsC,QAAQ,SAE9C,iBAAiB,oBAAoB,cAAc,SACjD,6BAA6B,cAAc,QAAQ,SACnD,iBAAiB,oBAAoB,UACnC,6BAA6B,cAAc,UAC3C,iBAAiB,gBACf,6BAA6B,gBAE7B;EACI,UACI,oBAAoB,oBAAoB,aACxC;EACJ,UAAU,oBAAoB;EAC9B,eAAe,wBAAwB;IAEzC,6BACE,8BACgB,SAAS,eAAe,wBACxB,QAAQ,eAAe,OACvC,aAEF;EACI,UACI,oBAAoB,oBAAoB,aACxC;EACJ,eAAe,wBAAwB;IAEzC,6BACE,cACA,QACA,cACA,aAGF;KAGjB,iCAAiC,GAAG,OAAO,oBAAoB;EAClE,oBAAoB;oBAEF,eACd,oBAAoB,OAAO,UAC3B,qBAAqB,QACnB,2BAA2B,OAAO,UAClC,kCAAiC,sCACf,qBACd,oBAAoB,OAAO,UAC3B,2BAA2B,QACzB,2BAA2B,OAAO,UAClC,oBAAoB,OAAO,UAC/B,oBAAoB,OAAO,UACjC,oBAAoB,OAAO;KAE1B,kBAAkB,KAErB,UAAU,sBACF,oBACA,cACA,mBAIJ,iCACE,qBACkB,QAAQ,eAAe,uBACzB,SAAS,eAAe,UAG1C;EAAY;EAAkB,cAAc;EAAQ,YAAY;IAC9D,iCAAiC,GAAG,OAAO,UAC3C;EAAY,mBAAmB;EAAc,cAAc;IACzD,iCAAiC,GAAG,cAAc,UAClD;EAAY,YAAY;EAAO,cAAc;IAC3C,iCAAiC,GAAG,OAAO,UAE3C,sBAAsB,cAAc,SAClC,iCAAiC,GAAG,OAAO,UAC3C,iBAAiB,oBAAoB,UACnC,iCAAiC,GAAG,cAAc,UAClD,iBAAiB,gBACf,iCAAiC,GAAG,gBAEpC;EACI,UACI,oBAAoB,qBACpB;EACJ,UAAU,oBAAoB;EAC9B,eAAe,wBAAwB;IAEzC,iCACE,mBACgB,QAAQ,eAAe,uBACvB,SAAS,eAAe,UAE1C;EACI,UACI,oBAAoB,qBACpB;EACJ,eAAe,wBAAwB;IAEzC,iCACE,GACA,8BACgB,SAAS,eAAe,UAG1C;;;;YAKV,kBACV,UAAU,YACV,iBAAiB,iBACjB,eAAe,8BACb,yBAAyB,gBACzB,MAAM,gCACN,oBAEE,iBAAiB,YACX,UAAU,gCAAgC,SAC9C,iBAAiB,eAAe,SAC9B,sBACM,YACA,UAAU,gCAAgC,YAC1C,cAEN,+BAA+B,IAC7B,IAGA,UAAU,MACN,mCACQ,oBACA,cACA,aACA,cAGV,MACE,6BACE,cACA,QACA,OACA,cAIJ,MAAM;;;;YAKR,kBACV,UAAU,YACV,iBAAiB,iBACjB,eAAe,8BACb,yBAAyB,gBACzB,MAAM,uBACN,oBAEE,iBAAiB,YACX,UAAU,kBAAkB,SAChC,iBAAiB,eAAe,SAC9B,sBACM,YACA,UAAU,kBAAkB,YAC5B,iBAEH,WAAW,IAAI,kBAAkB,EAAE;KAE3C,qBAAqB,UAAU,2BAC/B,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA2HP,WACd,UAAU,YACV,kBAAkB,kBAAkB,MAGlC,YACG,WACF;EACD,gBACW,aAAa,qBAAqB,OACzC,aAAa,qBAAqB,MAClC,6BAEU,WAAW,IAAI,gCAAgC,EAAE;EAG/D,WAAW,QAAQ,kBAAkB,OAAO;GAE9C,cAAcA,gBACb,SAAS,IAAI"}
1
+ {"version":3,"file":"useQueries.d.cts","names":["QueryClient"],"sources":["../../src/useQueries.ts"],"mappings":";;;;;KA6BK,6BACH,wBACA,kBACA,QAAQ,cACR,kBAAkB,WAAW,YAC3B,gBAAgB,cAAc,QAAQ,OAAO,cAAc;KAG1D;KAGA;KAEA,gCAAgC,KAEnC,UAAU,kBACN,cAAc,KAEd;EACI,mBAAmB;EACnB,cAAc;EACd,YAAY;IAEd,6BAA6B,cAAc,QAAQ,SACnD;EAAY,mBAAmB;EAAc,cAAc;IACzD,6BAA6B,cAAc,UAC3C;EAAY,YAAY;EAAO,cAAc;IAC3C,sCAAsC,QAAQ,SAE9C,iBAAiB,oBAAoB,cAAc,SACjD,6BAA6B,cAAc,QAAQ,SACnD,iBAAiB,oBAAoB,UACnC,6BAA6B,cAAc,UAC3C,iBAAiB,gBACf,6BAA6B,gBAE7B;EACI,UACI,oBAAoB,oBAAoB,aACxC;EACJ,UAAU,oBAAoB;EAC9B,eAAe,wBAAwB;IAEzC,6BACE,8BACgB,SAAS,eAAe,wBACxB,QAAQ,eAAe,OACvC,aAEF;EACI,UACI,oBAAoB,oBAAoB,aACxC;EACJ,eAAe,wBAAwB;IAEzC,6BACE,cACA,QACA,cACA,aAGF;KAGjB,iCAAiC,GAAG,OAAO,oBAAoB;EAClE,oBAAoB;oBAEF,eACd,oBAAoB,OAAO,UAC3B,qBAAqB,QACnB,2BAA2B,OAAO,UAClC,kCAAiC,sCACf,qBACd,oBAAoB,OAAO,UAC3B,2BAA2B,QACzB,2BAA2B,OAAO,UAClC,oBAAoB,OAAO,UAC/B,oBAAoB,OAAO,UACjC,oBAAoB,OAAO;KAE1B,kBAAkB,KAErB,UAAU,sBACF,oBACA,cACA,mBAIJ,iCACE,qBACkB,QAAQ,eAAe,uBACzB,SAAS,eAAe,UAG1C;EAAY;EAAkB,cAAc;EAAQ,YAAY;IAC9D,iCAAiC,GAAG,OAAO,UAC3C;EAAY,mBAAmB;EAAc,cAAc;IACzD,iCAAiC,GAAG,cAAc,UAClD;EAAY,YAAY;EAAO,cAAc;IAC3C,iCAAiC,GAAG,OAAO,UAE3C,sBAAsB,cAAc,SAClC,iCAAiC,GAAG,OAAO,UAC3C,iBAAiB,oBAAoB,UACnC,iCAAiC,GAAG,cAAc,UAClD,iBAAiB,gBACf,iCAAiC,GAAG,gBAEpC;EACI,UACI,oBAAoB,qBACpB;EACJ,UAAU,oBAAoB;EAC9B,eAAe,wBAAwB;IAEzC,iCACE,mBACgB,QAAQ,eAAe,uBACvB,SAAS,eAAe,UAE1C;EACI,UACI,oBAAoB,qBACpB;EACJ,eAAe,wBAAwB;IAEzC,iCACE,GACA,8BACgB,SAAS,eAAe,UAG1C;;;;YAKV,kBACV,UAAU,YACV,iBAAiB,iBACjB,eAAe,8BACb,yBAAyB,gBACzB,MAAM,gCACN,oBAEE,iBAAiB,YACX,UAAU,gCAAgC,SAC9C,iBAAiB,eAAe,SAC9B,sBACM,YACA,UAAU,gCAAgC,YAC1C,cAEN,+BAA+B,IAC7B,IAGA,UAAU,MACN,mCACQ,oBACA,cACA,aACA,cAGV,MACE,6BACE,cACA,QACA,OACA,cAIJ,MAAM;;;;YAKR,kBACV,UAAU,YACV,iBAAiB,iBACjB,eAAe,8BACb,yBAAyB,gBACzB,MAAM,uBACN,oBAEE,iBAAiB,YACX,UAAU,kBAAkB,SAChC,iBAAiB,eAAe,SAC9B,sBACM,YACA,UAAU,kBAAkB,YAC5B,iBAEH,WAAW,IAAI,kBAAkB,EAAE;KAE3C,qBAAqB,UAAU,2BAC/B,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA2HP,WACd,UAAU,YACV,kBAAkB,kBAAkB,MAGlC,YACG,WACF;EACD,gBACW,aAAa,qBAAqB,OACzC,aAAa,qBAAqB,MAClC,6BAEU,WAAW,IAAI,gCAAgC,EAAE;EAG/D,WAAW,QAAQ,kBAAkB,OAAO;GAE9C,cAAcA,gBACb,SAAS,IAAI"}
@@ -1,6 +1,6 @@
1
1
  import { d as ShallowOption, o as MaybeRefDeep, t as DeepUnwrapRef } from "./types-u_Tu5Ybs.js";
2
- import { o as UseQueryOptions } from "./queryOptions-dXiBZnGk.js";
3
- import { t as QueryClient$1 } from "./queryClient-Ba4HSFnn.js";
2
+ import { o as UseQueryOptions } from "./queryOptions-v0l6M7Eo.js";
3
+ import { t as QueryClient$1 } from "./queryClient-6AWIHAhP.js";
4
4
  import { DefaultError, DefinedQueryObserverResult, QueryFunction, QueryKey, QueryObserverResult, ThrowOnError } from "@tanstack/query-core";
5
5
  import { Ref } from "vue-demi";
6
6
  type UseQueryOptionsForUseQueries<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>;
@@ -1 +1 @@
1
- {"version":3,"file":"useQueries.d.ts","names":["QueryClient"],"sources":["../../src/useQueries.ts"],"mappings":";;;;;KA8BK,6BACH,wBACA,kBACA,QAAQ,cACR,kBAAkB,WAAW,YAC3B,gBAAgB,cAAc,QAAQ,OAAO,cAAc;KAG1D;KAGA;KAEA,gCAAgC,KAEnC,UAAU,kBACN,cAAc,KAEd;EACI,mBAAmB;EACnB,cAAc;EACd,YAAY;IAEd,6BAA6B,cAAc,QAAQ,SACnD;EAAY,mBAAmB;EAAc,cAAc;IACzD,6BAA6B,cAAc,UAC3C;EAAY,YAAY;EAAO,cAAc;IAC3C,sCAAsC,QAAQ,SAE9C,iBAAiB,oBAAoB,cAAc,SACjD,6BAA6B,cAAc,QAAQ,SACnD,iBAAiB,oBAAoB,UACnC,6BAA6B,cAAc,UAC3C,iBAAiB,gBACf,6BAA6B,gBAE7B;EACI,UACI,oBAAoB,oBAAoB,aACxC;EACJ,UAAU,oBAAoB;EAC9B,eAAe,wBAAwB;IAEzC,6BACE,8BACgB,SAAS,eAAe,wBACxB,QAAQ,eAAe,OACvC,aAEF;EACI,UACI,oBAAoB,oBAAoB,aACxC;EACJ,eAAe,wBAAwB;IAEzC,6BACE,cACA,QACA,cACA,aAGF;KAGjB,iCAAiC,GAAG,OAAO,oBAAoB;EAClE,oBAAoB;oBAEF,eACd,oBAAoB,OAAO,UAC3B,qBAAqB,QACnB,2BAA2B,OAAO,UAClC,kCAAiC,sCACf,qBACd,oBAAoB,OAAO,UAC3B,2BAA2B,QACzB,2BAA2B,OAAO,UAClC,oBAAoB,OAAO,UAC/B,oBAAoB,OAAO,UACjC,oBAAoB,OAAO;KAE1B,kBAAkB,KAErB,UAAU,sBACF,oBACA,cACA,mBAIJ,iCACE,qBACkB,QAAQ,eAAe,uBACzB,SAAS,eAAe,UAG1C;EAAY;EAAkB,cAAc;EAAQ,YAAY;IAC9D,iCAAiC,GAAG,OAAO,UAC3C;EAAY,mBAAmB;EAAc,cAAc;IACzD,iCAAiC,GAAG,cAAc,UAClD;EAAY,YAAY;EAAO,cAAc;IAC3C,iCAAiC,GAAG,OAAO,UAE3C,sBAAsB,cAAc,SAClC,iCAAiC,GAAG,OAAO,UAC3C,iBAAiB,oBAAoB,UACnC,iCAAiC,GAAG,cAAc,UAClD,iBAAiB,gBACf,iCAAiC,GAAG,gBAEpC;EACI,UACI,oBAAoB,qBACpB;EACJ,UAAU,oBAAoB;EAC9B,eAAe,wBAAwB;IAEzC,iCACE,mBACgB,QAAQ,eAAe,uBACvB,SAAS,eAAe,UAE1C;EACI,UACI,oBAAoB,qBACpB;EACJ,eAAe,wBAAwB;IAEzC,iCACE,GACA,8BACgB,SAAS,eAAe,UAG1C;;;;YAKV,kBACV,UAAU,YACV,iBAAiB,iBACjB,eAAe,8BACb,yBAAyB,gBACzB,MAAM,gCACN,oBAEE,iBAAiB,YACX,UAAU,gCAAgC,SAC9C,iBAAiB,eAAe,SAC9B,sBACM,YACA,UAAU,gCAAgC,YAC1C,cAEN,+BAA+B,IAC7B,IAGA,UAAU,MACN,mCACQ,oBACA,cACA,aACA,cAGV,MACE,6BACE,cACA,QACA,OACA,cAIJ,MAAM;;;;YAKR,kBACV,UAAU,YACV,iBAAiB,iBACjB,eAAe,8BACb,yBAAyB,gBACzB,MAAM,uBACN,oBAEE,iBAAiB,YACX,UAAU,kBAAkB,SAChC,iBAAiB,eAAe,SAC9B,sBACM,YACA,UAAU,kBAAkB,YAC5B,iBAEH,WAAW,IAAI,kBAAkB,EAAE;KAE3C,qBAAqB,UAAU,2BAC/B,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA2HP,WACd,UAAU,YACV,kBAAkB,kBAAkB,MAGlC,YACG,WACF;EACD,gBACW,aAAa,qBAAqB,OACzC,aAAa,qBAAqB,MAClC,6BAEU,WAAW,IAAI,gCAAgC,EAAE;EAG/D,WAAW,QAAQ,kBAAkB,OAAO;GAE9C,cAAcA,gBACb,SAAS,IAAI"}
1
+ {"version":3,"file":"useQueries.d.ts","names":["QueryClient"],"sources":["../../src/useQueries.ts"],"mappings":";;;;;KA6BK,6BACH,wBACA,kBACA,QAAQ,cACR,kBAAkB,WAAW,YAC3B,gBAAgB,cAAc,QAAQ,OAAO,cAAc;KAG1D;KAGA;KAEA,gCAAgC,KAEnC,UAAU,kBACN,cAAc,KAEd;EACI,mBAAmB;EACnB,cAAc;EACd,YAAY;IAEd,6BAA6B,cAAc,QAAQ,SACnD;EAAY,mBAAmB;EAAc,cAAc;IACzD,6BAA6B,cAAc,UAC3C;EAAY,YAAY;EAAO,cAAc;IAC3C,sCAAsC,QAAQ,SAE9C,iBAAiB,oBAAoB,cAAc,SACjD,6BAA6B,cAAc,QAAQ,SACnD,iBAAiB,oBAAoB,UACnC,6BAA6B,cAAc,UAC3C,iBAAiB,gBACf,6BAA6B,gBAE7B;EACI,UACI,oBAAoB,oBAAoB,aACxC;EACJ,UAAU,oBAAoB;EAC9B,eAAe,wBAAwB;IAEzC,6BACE,8BACgB,SAAS,eAAe,wBACxB,QAAQ,eAAe,OACvC,aAEF;EACI,UACI,oBAAoB,oBAAoB,aACxC;EACJ,eAAe,wBAAwB;IAEzC,6BACE,cACA,QACA,cACA,aAGF;KAGjB,iCAAiC,GAAG,OAAO,oBAAoB;EAClE,oBAAoB;oBAEF,eACd,oBAAoB,OAAO,UAC3B,qBAAqB,QACnB,2BAA2B,OAAO,UAClC,kCAAiC,sCACf,qBACd,oBAAoB,OAAO,UAC3B,2BAA2B,QACzB,2BAA2B,OAAO,UAClC,oBAAoB,OAAO,UAC/B,oBAAoB,OAAO,UACjC,oBAAoB,OAAO;KAE1B,kBAAkB,KAErB,UAAU,sBACF,oBACA,cACA,mBAIJ,iCACE,qBACkB,QAAQ,eAAe,uBACzB,SAAS,eAAe,UAG1C;EAAY;EAAkB,cAAc;EAAQ,YAAY;IAC9D,iCAAiC,GAAG,OAAO,UAC3C;EAAY,mBAAmB;EAAc,cAAc;IACzD,iCAAiC,GAAG,cAAc,UAClD;EAAY,YAAY;EAAO,cAAc;IAC3C,iCAAiC,GAAG,OAAO,UAE3C,sBAAsB,cAAc,SAClC,iCAAiC,GAAG,OAAO,UAC3C,iBAAiB,oBAAoB,UACnC,iCAAiC,GAAG,cAAc,UAClD,iBAAiB,gBACf,iCAAiC,GAAG,gBAEpC;EACI,UACI,oBAAoB,qBACpB;EACJ,UAAU,oBAAoB;EAC9B,eAAe,wBAAwB;IAEzC,iCACE,mBACgB,QAAQ,eAAe,uBACvB,SAAS,eAAe,UAE1C;EACI,UACI,oBAAoB,qBACpB;EACJ,eAAe,wBAAwB;IAEzC,iCACE,GACA,8BACgB,SAAS,eAAe,UAG1C;;;;YAKV,kBACV,UAAU,YACV,iBAAiB,iBACjB,eAAe,8BACb,yBAAyB,gBACzB,MAAM,gCACN,oBAEE,iBAAiB,YACX,UAAU,gCAAgC,SAC9C,iBAAiB,eAAe,SAC9B,sBACM,YACA,UAAU,gCAAgC,YAC1C,cAEN,+BAA+B,IAC7B,IAGA,UAAU,MACN,mCACQ,oBACA,cACA,aACA,cAGV,MACE,6BACE,cACA,QACA,OACA,cAIJ,MAAM;;;;YAKR,kBACV,UAAU,YACV,iBAAiB,iBACjB,eAAe,8BACb,yBAAyB,gBACzB,MAAM,uBACN,oBAEE,iBAAiB,YACX,UAAU,kBAAkB,SAChC,iBAAiB,eAAe,SAC9B,sBACM,YACA,UAAU,kBAAkB,YAC5B,iBAEH,WAAW,IAAI,kBAAkB,EAAE;KAE3C,qBAAqB,UAAU,2BAC/B,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA2HP,WACd,UAAU,YACV,kBAAkB,kBAAkB,MAGlC,YACG,WACF;EACD,gBACW,aAAa,qBAAqB,OACzC,aAAa,qBAAqB,MAClC,6BAEU,WAAW,IAAI,gCAAgC,EAAE;EAG/D,WAAW,QAAQ,kBAAkB,OAAO;GAE9C,cAAcA,gBACb,SAAS,IAAI"}
@@ -132,7 +132,7 @@ function useQueries({ queries, ...options }, queryClient) {
132
132
  const resolvedQueries = typeof queries === "function" ? queries() : queries;
133
133
  return unref(resolvedQueries).map((queryOptions) => {
134
134
  const clonedOptions = cloneDeepUnref(queryOptions);
135
- if (typeof clonedOptions.enabled === "function") clonedOptions.enabled = queryOptions.enabled();
135
+ if (typeof clonedOptions.enabled === "function" && clonedOptions.enabled.length === 0) clonedOptions.enabled = clonedOptions.enabled();
136
136
  const defaulted = client.defaultQueryOptions(clonedOptions);
137
137
  defaulted._optimisticResults = client.isRestoring?.value ? "isRestoring" : "optimistic";
138
138
  return defaulted;
@@ -1 +1 @@
1
- {"version":3,"file":"useQueries.js","names":[],"sources":["../../src/useQueries.ts"],"sourcesContent":["import { QueriesObserver } from '@tanstack/query-core'\nimport {\n computed,\n getCurrentScope,\n onScopeDispose,\n readonly,\n shallowReadonly,\n shallowRef,\n unref,\n watch,\n} from 'vue-demi'\n\nimport { useQueryClient } from './useQueryClient'\nimport { cloneDeepUnref } from './utils'\nimport type { Ref } from 'vue-demi'\nimport type {\n DefaultError,\n DefinedQueryObserverResult,\n QueriesObserverOptions,\n QueryFunction,\n QueryKey,\n QueryObserverResult,\n ThrowOnError,\n} from '@tanstack/query-core'\nimport type { UseQueryOptions } from './queryOptions'\nimport type { QueryClient } from './queryClient'\nimport type { DeepUnwrapRef, MaybeRefDeep, ShallowOption } from './types'\n\n// This defines the `UseQueryOptions` that are accepted in `QueriesOptions` & `GetOptions`.\n// `placeholderData` function does not have a parameter\ntype UseQueryOptionsForUseQueries<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>\n\n// Avoid TS depth-limit error in case of large array literal\ntype MAXIMUM_DEPTH = 20\n\n// Widen the type of the symbol to enable type inference even if skipToken is not immutable.\ntype SkipTokenForUseQueries = symbol\n\ntype GetUseQueryOptionsForUseQueries<T> =\n // Part 1: if UseQueryOptions are already being sent through, then just return T\n T extends UseQueryOptions\n ? DeepUnwrapRef<T>\n : // Part 2: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }\n T extends {\n queryFnData: infer TQueryFnData\n error?: infer TError\n data: infer TData\n }\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseQueryOptionsForUseQueries<unknown, TError, TData>\n : // Part 3: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]\n T extends [infer TQueryFnData, infer TError, infer TData]\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData>\n : T extends [infer TQueryFnData, infer TError]\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseQueryOptionsForUseQueries<TQueryFnData>\n : // Part 4: responsible for inferring and enforcing type if no explicit parameter was provided\n T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, infer TQueryKey>\n | SkipTokenForUseQueries\n select?: (data: any) => infer TData\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? UseQueryOptionsForUseQueries<\n TQueryFnData,\n unknown extends TError ? DefaultError : TError,\n unknown extends TData ? TQueryFnData : TData,\n TQueryKey\n >\n : T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, infer TQueryKey>\n | SkipTokenForUseQueries\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? UseQueryOptionsForUseQueries<\n TQueryFnData,\n TError,\n TQueryFnData,\n TQueryKey\n >\n : // Fallback\n UseQueryOptionsForUseQueries\n\n// A defined initialData setting should return a DefinedQueryObserverResult rather than QueryObserverResult\ntype GetDefinedOrUndefinedQueryResult<T, TData, TError = unknown> = T extends {\n initialData?: infer TInitialData\n}\n ? unknown extends TInitialData\n ? QueryObserverResult<TData, TError>\n : TInitialData extends TData\n ? DefinedQueryObserverResult<TData, TError>\n : TInitialData extends () => infer TInitialDataResult\n ? unknown extends TInitialDataResult\n ? QueryObserverResult<TData, TError>\n : TInitialDataResult extends TData\n ? DefinedQueryObserverResult<TData, TError>\n : QueryObserverResult<TData, TError>\n : QueryObserverResult<TData, TError>\n : QueryObserverResult<TData, TError>\n\ntype GetUseQueryResult<T> =\n // Part 1: if using UseQueryOptions then the types are already set\n T extends UseQueryOptions<\n infer TQueryFnData,\n infer TError,\n infer TData,\n any,\n any\n >\n ? GetDefinedOrUndefinedQueryResult<\n T,\n undefined extends TData ? TQueryFnData : TData,\n unknown extends TError ? DefaultError : TError\n >\n : // Part 2: responsible for mapping explicit type parameter to function result, if object\n T extends { queryFnData: any; error?: infer TError; data: infer TData }\n ? GetDefinedOrUndefinedQueryResult<T, TData, TError>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? GetDefinedOrUndefinedQueryResult<T, TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? GetDefinedOrUndefinedQueryResult<T, TData, TError>\n : // Part 3: responsible for mapping explicit type parameter to function result, if tuple\n T extends [any, infer TError, infer TData]\n ? GetDefinedOrUndefinedQueryResult<T, TData, TError>\n : T extends [infer TQueryFnData, infer TError]\n ? GetDefinedOrUndefinedQueryResult<T, TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? GetDefinedOrUndefinedQueryResult<T, TQueryFnData>\n : // Part 4: responsible for mapping inferred type to results, if no explicit parameter was provided\n T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, any>\n | SkipTokenForUseQueries\n select?: (data: any) => infer TData\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? GetDefinedOrUndefinedQueryResult<\n T,\n unknown extends TData ? TQueryFnData : TData,\n unknown extends TError ? DefaultError : TError\n >\n : T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, any>\n | SkipTokenForUseQueries\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? GetDefinedOrUndefinedQueryResult<\n T,\n TQueryFnData,\n unknown extends TError ? DefaultError : TError\n >\n : // Fallback\n QueryObserverResult\n\n/**\n * UseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param\n */\nexport type UseQueriesOptions<\n T extends Array<any>,\n TResults extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseQueryOptionsForUseQueries>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResults, GetUseQueryOptionsForUseQueries<Head>]\n : T extends [infer Head, ...infer Tails]\n ? UseQueriesOptions<\n [...Tails],\n [...TResults, GetUseQueryOptionsForUseQueries<Head>],\n [...TDepth, 1]\n >\n : ReadonlyArray<unknown> extends T\n ? T\n : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogeneous type!\n // use this to infer the param types in the case of Array.map() argument\n T extends Array<\n UseQueryOptionsForUseQueries<\n infer TQueryFnData,\n infer TError,\n infer TData,\n infer TQueryKey\n >\n >\n ? Array<\n UseQueryOptionsForUseQueries<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >\n >\n : // Fallback\n Array<UseQueryOptionsForUseQueries>\n\n/**\n * UseQueriesResults reducer recursively maps type param to results\n */\nexport type UseQueriesResults<\n T extends Array<any>,\n TResults extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<QueryObserverResult>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResults, GetUseQueryResult<Head>]\n : T extends [infer Head, ...infer Tails]\n ? UseQueriesResults<\n [...Tails],\n [...TResults, GetUseQueryResult<Head>],\n [...TDepth, 1]\n >\n : { [K in keyof T]: GetUseQueryResult<T[K]> }\n\ntype UseQueriesOptionsArg<T extends Array<any>> = readonly [\n ...UseQueriesOptions<T>,\n]\n\n/**\n * The `useQueries` composable can be used to fetch a variable number of queries.\n *\n * The `queries` option accepts an array of query option objects mostly identical to `useQuery`'s. It may be a\n * plain array, a `ref`/reactive array (each entry tracked individually), or a getter function — pass a getter\n * if the array itself (its length, or which queries are in it) depends on other reactive state.\n *\n * Having the same query key more than once in the array of query objects may cause some data to be shared\n * between queries. To avoid this, consider de-duplicating the queries and map the results back to the desired\n * structure.\n *\n * The `combine` option can be used to combine the results of the queries into a single value. The result will\n * be structurally shared to be as referentially stable as possible.\n *\n * `placeholderData` is supported here too, but unlike `useQuery`, it doesn't receive information from\n * previously rendered queries, because the number of queries can differ between renders.\n * @param options - The `queries` array to run, and the optional `combine` and `shallow` options.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one provided by `VueQueryPlugin`\n * will be used.\n * @returns A `ref` to the combined result. Without `combine`, this is an array with all the query results, in\n * the same order as the input. When `combine` is provided, this is the value returned by `combine` instead.\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQueries } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ ids: Array<number> }>()\n *\n * const postQueries = useQueries({\n * queries: () =>\n * props.ids.map((id) => ({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * staleTime: Infinity,\n * })),\n * })\n * </script>\n *\n * <template>\n * <ul>\n * <li v-for=\"(query, index) in postQueries\" :key=\"props.ids[index]\">\n * <span v-if=\"query.isPending\">Loading...</span>\n * <span v-else-if=\"query.isError\">Error: {{ query.error.message }}</span>\n * <span v-else>{{ query.data.title }}</span>\n * </li>\n * </ul>\n * </template>\n * ```\n * @example\n * Combining results into a single value:\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQueries } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ ids: Array<number> }>()\n *\n * const combined = useQueries({\n * queries: () =>\n * props.ids.map((id) => ({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * })),\n * combine: (postQueries) => ({\n * data: postQueries.map((query) => query.data),\n * isPending: postQueries.some((query) => query.isPending),\n * isError: postQueries.some((query) => query.isError),\n * }),\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"combined.isPending\">Loading...</span>\n * <span v-else-if=\"combined.isError\">Error!</span>\n * <ul v-else>\n * <li v-for=\"post in combined.data\" :key=\"post.id\">{{ post.title }}</li>\n * </ul>\n * </template>\n * ```\n * @example\n * Typing `select` via {@link queryOptions}. Note that spreading a `queryOptions` result and overriding\n * `select` inline still falls back to `unknown` — wrap the spread in `queryOptions` again so the override is\n * resolved before it reaches `useQueries`:\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, useQueries } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ id: number }>()\n *\n * const postOptions = (id: number) =>\n * queryOptions({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * })\n *\n * const [{ data: broken }] = useQueries({\n * queries: () => [\n * {\n * ...postOptions(props.id),\n * // ❌ `data` is `unknown` here\n * select: (data) => data.title,\n * },\n * ],\n * })\n *\n * const [{ data: fixed }] = useQueries({\n * queries: () => [\n * queryOptions({\n * ...postOptions(props.id),\n * // ✅ `data` is `Post`\n * select: (data) => data.title,\n * }),\n * ],\n * })\n * </script>\n *\n * <template>\n * <h1>{{ fixed }}</h1>\n * </template>\n * ```\n */\nexport function useQueries<\n T extends Array<any>,\n TCombinedResult = UseQueriesResults<T>,\n>(\n {\n queries,\n ...options\n }: ShallowOption & {\n queries:\n | (() => MaybeRefDeep<UseQueriesOptionsArg<T>>)\n | MaybeRefDeep<UseQueriesOptionsArg<T>>\n | MaybeRefDeep<\n readonly [\n ...{ [K in keyof T]: GetUseQueryOptionsForUseQueries<T[K]> },\n ]\n >\n combine?: (result: UseQueriesResults<T>) => TCombinedResult\n },\n queryClient?: QueryClient,\n): Readonly<Ref<TCombinedResult>> {\n if (process.env.NODE_ENV === 'development') {\n if (!getCurrentScope()) {\n console.warn(\n 'vue-query composable like \"useQuery()\" should only be used inside a \"setup()\" function or a running effect scope. They might otherwise lead to memory leaks.',\n )\n }\n }\n\n const client = queryClient || useQueryClient()\n\n const defaultedQueries = computed(() => {\n const resolvedQueries =\n typeof queries === 'function'\n ? (queries as () => MaybeRefDeep<UseQueriesOptionsArg<T>>)()\n : queries\n // Only unref the top level array.\n const queriesRaw = unref(resolvedQueries) as ReadonlyArray<any>\n\n // Unref the rest for each element in the top level array.\n return queriesRaw.map((queryOptions) => {\n const clonedOptions = cloneDeepUnref(queryOptions)\n\n if (typeof clonedOptions.enabled === 'function') {\n clonedOptions.enabled = queryOptions.enabled()\n }\n\n const defaulted = client.defaultQueryOptions(clonedOptions)\n defaulted._optimisticResults = client.isRestoring?.value\n ? 'isRestoring'\n : 'optimistic'\n\n return defaulted\n })\n })\n\n const observer = new QueriesObserver<TCombinedResult>(\n client,\n defaultedQueries.value,\n options as QueriesObserverOptions<TCombinedResult>,\n )\n\n const getOptimisticResult = () => {\n const [results, getCombinedResult] = observer.getOptimisticResult(\n defaultedQueries.value,\n (options as QueriesObserverOptions<TCombinedResult>).combine,\n )\n\n return getCombinedResult(\n results.map((result, index) => {\n return {\n ...result,\n refetch: async (...args: Array<any>) => {\n const [{ [index]: query }] = observer.getOptimisticResult(\n defaultedQueries.value,\n (options as QueriesObserverOptions<TCombinedResult>).combine,\n )\n\n return query!.refetch(...args)\n },\n }\n }),\n )\n }\n\n const state = shallowRef(getOptimisticResult())\n\n let unsubscribe = () => {\n // noop\n }\n\n if (client.isRestoring) {\n watch(\n client.isRestoring,\n (isRestoring) => {\n if (!isRestoring) {\n unsubscribe()\n unsubscribe = observer.subscribe(() => {\n state.value = getOptimisticResult()\n })\n\n state.value = getOptimisticResult()\n }\n },\n { immediate: true },\n )\n }\n\n watch(defaultedQueries, (queriesValue) => {\n observer.setQueries(\n queriesValue,\n options as QueriesObserverOptions<TCombinedResult>,\n )\n state.value = getOptimisticResult()\n })\n\n onScopeDispose(() => {\n unsubscribe()\n })\n\n return options.shallow\n ? shallowReadonly(state)\n : (readonly(state) as Readonly<Ref<TCombinedResult>>)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiWA,SAAgB,WAId,EACE,SACA,GAAG,WAYL,aACgC;CAChC,IAAI,QAAQ,IAAI,aAAa,eACvB;MAAA,CAAC,gBAAgB,GACnB,QAAQ,KACN,kKACF;CAAA;CAIJ,MAAM,SAAS,eAAe,eAAe;CAE7C,MAAM,mBAAmB,eAAe;EACtC,MAAM,kBACJ,OAAO,YAAY,aACd,QAAwD,IACzD;EAKN,OAHmB,MAAM,eAGT,CAAC,CAAC,KAAK,iBAAiB;GACtC,MAAM,gBAAgB,eAAe,YAAY;GAEjD,IAAI,OAAO,cAAc,YAAY,YACnC,cAAc,UAAU,aAAa,QAAQ;GAG/C,MAAM,YAAY,OAAO,oBAAoB,aAAa;GAC1D,UAAU,qBAAqB,OAAO,aAAa,QAC/C,gBACA;GAEJ,OAAO;EACT,CAAC;CACH,CAAC;CAED,MAAM,WAAW,IAAI,gBACnB,QACA,iBAAiB,OACjB,OACF;CAEA,MAAM,4BAA4B;EAChC,MAAM,CAAC,SAAS,qBAAqB,SAAS,oBAC5C,iBAAiB,OAChB,QAAoD,OACvD;EAEA,OAAO,kBACL,QAAQ,KAAK,QAAQ,UAAU;GAC7B,OAAO;IACL,GAAG;IACH,SAAS,OAAO,GAAG,SAAqB;KACtC,MAAM,CAAC,GAAG,QAAQ,WAAW,SAAS,oBACpC,iBAAiB,OAChB,QAAoD,OACvD;KAEA,OAAO,MAAO,QAAQ,GAAG,IAAI;IAC/B;GACF;EACF,CAAC,CACH;CACF;CAEA,MAAM,QAAQ,WAAW,oBAAoB,CAAC;CAE9C,IAAI,oBAAoB,CAExB;CAEA,IAAI,OAAO,aACT,MACE,OAAO,cACN,gBAAgB;EACf,IAAI,CAAC,aAAa;GAChB,YAAY;GACZ,cAAc,SAAS,gBAAgB;IACrC,MAAM,QAAQ,oBAAoB;GACpC,CAAC;GAED,MAAM,QAAQ,oBAAoB;EACpC;CACF,GACA,EAAE,WAAW,KAAK,CACpB;CAGF,MAAM,mBAAmB,iBAAiB;EACxC,SAAS,WACP,cACA,OACF;EACA,MAAM,QAAQ,oBAAoB;CACpC,CAAC;CAED,qBAAqB;EACnB,YAAY;CACd,CAAC;CAED,OAAO,QAAQ,UACX,gBAAgB,KAAK,IACpB,SAAS,KAAK;AACrB"}
1
+ {"version":3,"file":"useQueries.js","names":[],"sources":["../../src/useQueries.ts"],"sourcesContent":["import { QueriesObserver } from '@tanstack/query-core'\nimport {\n computed,\n getCurrentScope,\n onScopeDispose,\n readonly,\n shallowReadonly,\n shallowRef,\n unref,\n watch,\n} from 'vue-demi'\nimport { useQueryClient } from './useQueryClient'\nimport { cloneDeepUnref } from './utils'\nimport type {\n DefaultError,\n DefinedQueryObserverResult,\n QueriesObserverOptions,\n QueryFunction,\n QueryKey,\n QueryObserverResult,\n ThrowOnError,\n} from '@tanstack/query-core'\nimport type { Ref } from 'vue-demi'\nimport type { QueryClient } from './queryClient'\nimport type { UseQueryOptions } from './queryOptions'\nimport type { DeepUnwrapRef, MaybeRefDeep, ShallowOption } from './types'\n\n// This defines the `UseQueryOptions` that are accepted in `QueriesOptions` & `GetOptions`.\n// `placeholderData` function does not have a parameter\ntype UseQueryOptionsForUseQueries<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>\n\n// Avoid TS depth-limit error in case of large array literal\ntype MAXIMUM_DEPTH = 20\n\n// Widen the type of the symbol to enable type inference even if skipToken is not immutable.\ntype SkipTokenForUseQueries = symbol\n\ntype GetUseQueryOptionsForUseQueries<T> =\n // Part 1: if UseQueryOptions are already being sent through, then just return T\n T extends UseQueryOptions\n ? DeepUnwrapRef<T>\n : // Part 2: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }\n T extends {\n queryFnData: infer TQueryFnData\n error?: infer TError\n data: infer TData\n }\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseQueryOptionsForUseQueries<unknown, TError, TData>\n : // Part 3: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]\n T extends [infer TQueryFnData, infer TError, infer TData]\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData>\n : T extends [infer TQueryFnData, infer TError]\n ? UseQueryOptionsForUseQueries<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseQueryOptionsForUseQueries<TQueryFnData>\n : // Part 4: responsible for inferring and enforcing type if no explicit parameter was provided\n T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, infer TQueryKey>\n | SkipTokenForUseQueries\n select?: (data: any) => infer TData\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? UseQueryOptionsForUseQueries<\n TQueryFnData,\n unknown extends TError ? DefaultError : TError,\n unknown extends TData ? TQueryFnData : TData,\n TQueryKey\n >\n : T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, infer TQueryKey>\n | SkipTokenForUseQueries\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? UseQueryOptionsForUseQueries<\n TQueryFnData,\n TError,\n TQueryFnData,\n TQueryKey\n >\n : // Fallback\n UseQueryOptionsForUseQueries\n\n// A defined initialData setting should return a DefinedQueryObserverResult rather than QueryObserverResult\ntype GetDefinedOrUndefinedQueryResult<T, TData, TError = unknown> = T extends {\n initialData?: infer TInitialData\n}\n ? unknown extends TInitialData\n ? QueryObserverResult<TData, TError>\n : TInitialData extends TData\n ? DefinedQueryObserverResult<TData, TError>\n : TInitialData extends () => infer TInitialDataResult\n ? unknown extends TInitialDataResult\n ? QueryObserverResult<TData, TError>\n : TInitialDataResult extends TData\n ? DefinedQueryObserverResult<TData, TError>\n : QueryObserverResult<TData, TError>\n : QueryObserverResult<TData, TError>\n : QueryObserverResult<TData, TError>\n\ntype GetUseQueryResult<T> =\n // Part 1: if using UseQueryOptions then the types are already set\n T extends UseQueryOptions<\n infer TQueryFnData,\n infer TError,\n infer TData,\n any,\n any\n >\n ? GetDefinedOrUndefinedQueryResult<\n T,\n undefined extends TData ? TQueryFnData : TData,\n unknown extends TError ? DefaultError : TError\n >\n : // Part 2: responsible for mapping explicit type parameter to function result, if object\n T extends { queryFnData: any; error?: infer TError; data: infer TData }\n ? GetDefinedOrUndefinedQueryResult<T, TData, TError>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? GetDefinedOrUndefinedQueryResult<T, TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? GetDefinedOrUndefinedQueryResult<T, TData, TError>\n : // Part 3: responsible for mapping explicit type parameter to function result, if tuple\n T extends [any, infer TError, infer TData]\n ? GetDefinedOrUndefinedQueryResult<T, TData, TError>\n : T extends [infer TQueryFnData, infer TError]\n ? GetDefinedOrUndefinedQueryResult<T, TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? GetDefinedOrUndefinedQueryResult<T, TQueryFnData>\n : // Part 4: responsible for mapping inferred type to results, if no explicit parameter was provided\n T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, any>\n | SkipTokenForUseQueries\n select?: (data: any) => infer TData\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? GetDefinedOrUndefinedQueryResult<\n T,\n unknown extends TData ? TQueryFnData : TData,\n unknown extends TError ? DefaultError : TError\n >\n : T extends {\n queryFn?:\n | QueryFunction<infer TQueryFnData, any>\n | SkipTokenForUseQueries\n throwOnError?: ThrowOnError<any, infer TError, any, any>\n }\n ? GetDefinedOrUndefinedQueryResult<\n T,\n TQueryFnData,\n unknown extends TError ? DefaultError : TError\n >\n : // Fallback\n QueryObserverResult\n\n/**\n * UseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param\n */\nexport type UseQueriesOptions<\n T extends Array<any>,\n TResults extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseQueryOptionsForUseQueries>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResults, GetUseQueryOptionsForUseQueries<Head>]\n : T extends [infer Head, ...infer Tails]\n ? UseQueriesOptions<\n [...Tails],\n [...TResults, GetUseQueryOptionsForUseQueries<Head>],\n [...TDepth, 1]\n >\n : ReadonlyArray<unknown> extends T\n ? T\n : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogeneous type!\n // use this to infer the param types in the case of Array.map() argument\n T extends Array<\n UseQueryOptionsForUseQueries<\n infer TQueryFnData,\n infer TError,\n infer TData,\n infer TQueryKey\n >\n >\n ? Array<\n UseQueryOptionsForUseQueries<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >\n >\n : // Fallback\n Array<UseQueryOptionsForUseQueries>\n\n/**\n * UseQueriesResults reducer recursively maps type param to results\n */\nexport type UseQueriesResults<\n T extends Array<any>,\n TResults extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<QueryObserverResult>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResults, GetUseQueryResult<Head>]\n : T extends [infer Head, ...infer Tails]\n ? UseQueriesResults<\n [...Tails],\n [...TResults, GetUseQueryResult<Head>],\n [...TDepth, 1]\n >\n : { [K in keyof T]: GetUseQueryResult<T[K]> }\n\ntype UseQueriesOptionsArg<T extends Array<any>> = readonly [\n ...UseQueriesOptions<T>,\n]\n\n/**\n * The `useQueries` composable can be used to fetch a variable number of queries.\n *\n * The `queries` option accepts an array of query option objects mostly identical to `useQuery`'s. It may be a\n * plain array, a `ref`/reactive array (each entry tracked individually), or a getter function — pass a getter\n * if the array itself (its length, or which queries are in it) depends on other reactive state.\n *\n * Having the same query key more than once in the array of query objects may cause some data to be shared\n * between queries. To avoid this, consider de-duplicating the queries and map the results back to the desired\n * structure.\n *\n * The `combine` option can be used to combine the results of the queries into a single value. The result will\n * be structurally shared to be as referentially stable as possible.\n *\n * `placeholderData` is supported here too, but unlike `useQuery`, it doesn't receive information from\n * previously rendered queries, because the number of queries can differ between renders.\n * @param options - The `queries` array to run, and the optional `combine` and `shallow` options.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one provided by `VueQueryPlugin`\n * will be used.\n * @returns A `ref` to the combined result. Without `combine`, this is an array with all the query results, in\n * the same order as the input. When `combine` is provided, this is the value returned by `combine` instead.\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQueries } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ ids: Array<number> }>()\n *\n * const postQueries = useQueries({\n * queries: () =>\n * props.ids.map((id) => ({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * staleTime: Infinity,\n * })),\n * })\n * </script>\n *\n * <template>\n * <ul>\n * <li v-for=\"(query, index) in postQueries\" :key=\"props.ids[index]\">\n * <span v-if=\"query.isPending\">Loading...</span>\n * <span v-else-if=\"query.isError\">Error: {{ query.error.message }}</span>\n * <span v-else>{{ query.data.title }}</span>\n * </li>\n * </ul>\n * </template>\n * ```\n * @example\n * Combining results into a single value:\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQueries } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ ids: Array<number> }>()\n *\n * const combined = useQueries({\n * queries: () =>\n * props.ids.map((id) => ({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * })),\n * combine: (postQueries) => ({\n * data: postQueries.map((query) => query.data),\n * isPending: postQueries.some((query) => query.isPending),\n * isError: postQueries.some((query) => query.isError),\n * }),\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"combined.isPending\">Loading...</span>\n * <span v-else-if=\"combined.isError\">Error!</span>\n * <ul v-else>\n * <li v-for=\"post in combined.data\" :key=\"post.id\">{{ post.title }}</li>\n * </ul>\n * </template>\n * ```\n * @example\n * Typing `select` via {@link queryOptions}. Note that spreading a `queryOptions` result and overriding\n * `select` inline still falls back to `unknown` — wrap the spread in `queryOptions` again so the override is\n * resolved before it reaches `useQueries`:\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, useQueries } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ id: number }>()\n *\n * const postOptions = (id: number) =>\n * queryOptions({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * })\n *\n * const [{ data: broken }] = useQueries({\n * queries: () => [\n * {\n * ...postOptions(props.id),\n * // ❌ `data` is `unknown` here\n * select: (data) => data.title,\n * },\n * ],\n * })\n *\n * const [{ data: fixed }] = useQueries({\n * queries: () => [\n * queryOptions({\n * ...postOptions(props.id),\n * // ✅ `data` is `Post`\n * select: (data) => data.title,\n * }),\n * ],\n * })\n * </script>\n *\n * <template>\n * <h1>{{ fixed }}</h1>\n * </template>\n * ```\n */\nexport function useQueries<\n T extends Array<any>,\n TCombinedResult = UseQueriesResults<T>,\n>(\n {\n queries,\n ...options\n }: ShallowOption & {\n queries:\n | (() => MaybeRefDeep<UseQueriesOptionsArg<T>>)\n | MaybeRefDeep<UseQueriesOptionsArg<T>>\n | MaybeRefDeep<\n readonly [\n ...{ [K in keyof T]: GetUseQueryOptionsForUseQueries<T[K]> },\n ]\n >\n combine?: (result: UseQueriesResults<T>) => TCombinedResult\n },\n queryClient?: QueryClient,\n): Readonly<Ref<TCombinedResult>> {\n if (process.env.NODE_ENV === 'development') {\n if (!getCurrentScope()) {\n console.warn(\n 'vue-query composable like \"useQuery()\" should only be used inside a \"setup()\" function or a running effect scope. They might otherwise lead to memory leaks.',\n )\n }\n }\n\n const client = queryClient || useQueryClient()\n\n const defaultedQueries = computed(() => {\n const resolvedQueries =\n typeof queries === 'function'\n ? (queries as () => MaybeRefDeep<UseQueriesOptionsArg<T>>)()\n : queries\n // Only unref the top level array.\n const queriesRaw = unref(resolvedQueries) as ReadonlyArray<any>\n\n // Unref the rest for each element in the top level array.\n return queriesRaw.map((queryOptions) => {\n const clonedOptions = cloneDeepUnref(queryOptions)\n\n // A zero-arg function is a Vue getter and must run here so its refs are tracked.\n // `(query) => boolean` is query-core's callback and is left for core to call.\n if (\n typeof clonedOptions.enabled === 'function' &&\n clonedOptions.enabled.length === 0\n ) {\n clonedOptions.enabled = clonedOptions.enabled()\n }\n\n const defaulted = client.defaultQueryOptions(clonedOptions)\n defaulted._optimisticResults = client.isRestoring?.value\n ? 'isRestoring'\n : 'optimistic'\n\n return defaulted\n })\n })\n\n const observer = new QueriesObserver<TCombinedResult>(\n client,\n defaultedQueries.value,\n options as QueriesObserverOptions<TCombinedResult>,\n )\n\n const getOptimisticResult = () => {\n const [results, getCombinedResult] = observer.getOptimisticResult(\n defaultedQueries.value,\n (options as QueriesObserverOptions<TCombinedResult>).combine,\n )\n\n return getCombinedResult(\n results.map((result, index) => {\n return {\n ...result,\n refetch: async (...args: Array<any>) => {\n const [{ [index]: query }] = observer.getOptimisticResult(\n defaultedQueries.value,\n (options as QueriesObserverOptions<TCombinedResult>).combine,\n )\n\n return query!.refetch(...args)\n },\n }\n }),\n )\n }\n\n const state = shallowRef(getOptimisticResult())\n\n let unsubscribe = () => {\n // noop\n }\n\n if (client.isRestoring) {\n watch(\n client.isRestoring,\n (isRestoring) => {\n if (!isRestoring) {\n unsubscribe()\n unsubscribe = observer.subscribe(() => {\n state.value = getOptimisticResult()\n })\n\n state.value = getOptimisticResult()\n }\n },\n { immediate: true },\n )\n }\n\n watch(defaultedQueries, (queriesValue) => {\n observer.setQueries(\n queriesValue,\n options as QueriesObserverOptions<TCombinedResult>,\n )\n state.value = getOptimisticResult()\n })\n\n onScopeDispose(() => {\n unsubscribe()\n })\n\n return options.shallow\n ? shallowReadonly(state)\n : (readonly(state) as Readonly<Ref<TCombinedResult>>)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgWA,SAAgB,WAId,EACE,SACA,GAAG,WAYL,aACgC;CAChC,IAAI,QAAQ,IAAI,aAAa,eACvB;MAAA,CAAC,gBAAgB,GACnB,QAAQ,KACN,kKACF;CAAA;CAIJ,MAAM,SAAS,eAAe,eAAe;CAE7C,MAAM,mBAAmB,eAAe;EACtC,MAAM,kBACJ,OAAO,YAAY,aACd,QAAwD,IACzD;EAKN,OAHmB,MAAM,eAGT,CAAC,CAAC,KAAK,iBAAiB;GACtC,MAAM,gBAAgB,eAAe,YAAY;GAIjD,IACE,OAAO,cAAc,YAAY,cACjC,cAAc,QAAQ,WAAW,GAEjC,cAAc,UAAU,cAAc,QAAQ;GAGhD,MAAM,YAAY,OAAO,oBAAoB,aAAa;GAC1D,UAAU,qBAAqB,OAAO,aAAa,QAC/C,gBACA;GAEJ,OAAO;EACT,CAAC;CACH,CAAC;CAED,MAAM,WAAW,IAAI,gBACnB,QACA,iBAAiB,OACjB,OACF;CAEA,MAAM,4BAA4B;EAChC,MAAM,CAAC,SAAS,qBAAqB,SAAS,oBAC5C,iBAAiB,OAChB,QAAoD,OACvD;EAEA,OAAO,kBACL,QAAQ,KAAK,QAAQ,UAAU;GAC7B,OAAO;IACL,GAAG;IACH,SAAS,OAAO,GAAG,SAAqB;KACtC,MAAM,CAAC,GAAG,QAAQ,WAAW,SAAS,oBACpC,iBAAiB,OAChB,QAAoD,OACvD;KAEA,OAAO,MAAO,QAAQ,GAAG,IAAI;IAC/B;GACF;EACF,CAAC,CACH;CACF;CAEA,MAAM,QAAQ,WAAW,oBAAoB,CAAC;CAE9C,IAAI,oBAAoB,CAExB;CAEA,IAAI,OAAO,aACT,MACE,OAAO,cACN,gBAAgB;EACf,IAAI,CAAC,aAAa;GAChB,YAAY;GACZ,cAAc,SAAS,gBAAgB;IACrC,MAAM,QAAQ,oBAAoB;GACpC,CAAC;GAED,MAAM,QAAQ,oBAAoB;EACpC;CACF,GACA,EAAE,WAAW,KAAK,CACpB;CAGF,MAAM,mBAAmB,iBAAiB;EACxC,SAAS,WACP,cACA,OACF;EACA,MAAM,QAAQ,oBAAoB;CACpC,CAAC;CAED,qBAAqB;EACnB,YAAY;CACd,CAAC;CAED,OAAO,QAAQ,UACX,gBAAgB,KAAK,IACpB,SAAS,KAAK;AACrB"}
@@ -1 +1 @@
1
- {"version":3,"file":"useQuery.cjs","names":["useBaseQuery","QueryObserver"],"sources":["../../src/useQuery.ts"],"sourcesContent":["import { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n DefaultError,\n DefinedQueryObserverResult,\n QueryKey,\n} from '@tanstack/query-core'\nimport type { UseBaseQueryReturnType } from './useBaseQuery'\nimport type { MaybeRefOrGetter } from './types'\nimport type { QueryClient } from './queryClient'\nimport type {\n DefinedInitialQueryOptions,\n UndefinedInitialQueryOptions,\n UseQueryOptions,\n} from './queryOptions'\n\n/**\n * The result of `useQuery` when `initialData` is omitted, may be `undefined`, or is a function that may\n * return `undefined` — `data` may be `undefined` while the query is `pending`. See\n * {@link UseBaseQueryReturnType}.\n */\nexport type UseQueryReturnType<TData, TError> = UseBaseQueryReturnType<\n TData,\n TError\n>\n\n/**\n * The result of `useQuery` when `initialData` is set — `data` is never `undefined` (unless a `select` changes\n * `TData` to include `undefined`).\n */\nexport type UseQueryDefinedReturnType<TData, TError> = UseBaseQueryReturnType<\n TData,\n TError,\n DefinedQueryObserverResult<TData, TError>\n>\n\n/**\n * This overload is selected when `initialData` is known to be defined, so the resulting `data` is never\n * `undefined` (unless a `select` changes `TData` to include `undefined`).\n *\n * `enabled` tracks reactive dependencies automatically as a `ref`, a plain value, or a reactive getter\n * (`() => ...`). `queryKey` reacts through a `ref` or a reactive getter for the array itself, or `ref`s and\n * reactive getters as individual entries. Other options are read once when passed as a plain value, and stay\n * reactive when passed as a `ref` or a `computed`.\n * @param options - The {@link DefinedInitialQueryOptions} to use — everything you can pass to `useQuery`,\n * with `initialData` known to be defined.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one provided by `VueQueryPlugin`\n * will be used.\n * @returns The current query result, typed so that `data` is never `undefined` (unless a `select` changes\n * `TData` to include `undefined`). `status` never resolves to `pending` in this overload's type, since\n * `initialData` guarantees data upfront.\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQuery } from '@tanstack/vue-query'\n *\n * // `data` is `Post[]`, never `undefined`, thanks to `initialData` — even if a refetch fails,\n * // so the list stays visible alongside the error.\n * const { data, isError, error } = useQuery({\n * queryKey: ['posts'],\n * queryFn: fetchPosts,\n * initialData: [],\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"isError\">Error: {{ error.message }}</span>\n * <ul>\n * <li v-for=\"post in data\" :key=\"post.id\">{{ post.title }}</li>\n * </ul>\n * </template>\n * ```\n */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n queryClient?: QueryClient,\n): UseQueryDefinedReturnType<TData, TError>\n\n/**\n * `enabled` tracks reactive dependencies automatically as a `ref`, a plain value, or a reactive getter\n * (`() => ...`). `queryKey` reacts through a `ref` or a reactive getter for the array itself, or `ref`s and\n * reactive getters as individual entries. Other options are read once when passed as a plain value, and stay\n * reactive when passed as a `ref` or a `computed`.\n * @param options - The {@link UndefinedInitialQueryOptions} to use — everything you can pass to `useQuery`.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one provided by `VueQueryPlugin`\n * will be used.\n * @returns The current query result. `status` is `pending` if there is no cached data to display, `error` if\n * the last fetch attempt failed, or `success` if the query has data to display.\n * @example\n * A query key built from a reactive `ref` — the query refetches whenever `postId` changes:\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { useQuery } from '@tanstack/vue-query'\n *\n * const postId = ref(1)\n * const { status, data, error } = useQuery({\n * queryKey: ['post', postId],\n * queryFn: () => fetchPost(postId.value),\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"status === 'pending'\">Loading...</span>\n * <span v-else-if=\"status === 'error'\">Error: {{ error.message }}</span>\n * <h1 v-else>{{ data.title }}</h1>\n * </template>\n * ```\n * @example\n * `select` derives whatever `data` a component needs from the cached value, without changing what's\n * actually stored in the cache — the cache still holds the full `Post[]`, but `data` here is a `number`:\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQuery } from '@tanstack/vue-query'\n *\n * const { data, isPending, isError, error } = useQuery({\n * queryKey: ['posts'],\n * queryFn: fetchPosts,\n * select: (posts) => posts.length,\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"isPending\">Loading...</span>\n * <span v-else-if=\"isError\">Error: {{ error.message }}</span>\n * <span v-else>{{ data }} posts</span>\n * </template>\n * ```\n * @example\n * A dependent query, only enabled once `postId` is set — use `isLoading`, not `isPending`, so the\n * loading state doesn't show while the query is disabled:\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { useQuery } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ postId: number | undefined }>()\n *\n * const { data, isLoading, isError, error } = useQuery({\n * queryKey: ['post', props.postId],\n * queryFn: () => fetchPost(props.postId!),\n * enabled: () => props.postId != null,\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"props.postId == null\">Select a post</span>\n * <span v-else-if=\"isLoading\">Loading...</span>\n * <span v-else-if=\"isError\">Error: {{ error.message }}</span>\n * <h1 v-else>{{ data?.title }}</h1>\n * </template>\n * ```\n * @example\n * Seeding a detail query from an already-cached list, to skip the loading state. `initialDataUpdatedAt` carries\n * over the list's own fetch time, so that if you set a `staleTime`, it's measured from when the list was\n * fetched rather than from now:\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQuery, useQueryClient } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ postId: number }>()\n * const queryClient = useQueryClient()\n *\n * const { data, isError, error } = useQuery({\n * queryKey: ['post', props.postId],\n * queryFn: () => fetchPost(props.postId),\n * initialData: () =>\n * queryClient\n * .getQueryData<Array<Post>>(['posts'])\n * ?.find((post) => post.id === props.postId),\n * initialDataUpdatedAt: () =>\n * queryClient.getQueryState(['posts'])?.dataUpdatedAt,\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"isError\">Error: {{ error.message }}</span>\n * <h1 v-else>{{ data?.title }}</h1>\n * </template>\n * ```\n * @example\n * Paginated data, keeping the previous page's data visible while the next page loads:\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { keepPreviousData, useQuery } from '@tanstack/vue-query'\n *\n * const page = ref(0)\n *\n * const { data, isPlaceholderData, isError, error } = useQuery({\n * queryKey: ['posts', page],\n * queryFn: () => fetchPosts(page.value),\n * placeholderData: keepPreviousData,\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"isError\">Error: {{ error.message }}</span>\n * <template v-else>\n * <ul>\n * <li v-for=\"post in data\" :key=\"post.id\">{{ post.title }}</li>\n * </ul>\n * <button :disabled=\"isPlaceholderData\" @click=\"page++\">Next Page</button>\n * </template>\n * </template>\n * ```\n */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n queryClient?: QueryClient,\n): UseQueryReturnType<TData, TError>\n\n/**\n * Fallback overload for options whose `initialData` presence isn't statically known — for example, a\n * `ref`/reactive object built up conditionally, rather than a plain object literal. Prefer one of the other\n * overloads when possible, since they infer whether `data` can be `undefined` from `initialData` directly.\n *\n * `enabled` tracks reactive dependencies automatically as a `ref`, a plain value, or a reactive getter\n * (`() => ...`). `queryKey` reacts through a `ref` or a reactive getter for the array itself, or `ref`s and\n * reactive getters as individual entries.\n *\n * When `options` itself is a reactive getter, the whole object is re-evaluated on every change to its\n * dependencies, so any option inside it — not just `queryKey` and `enabled` — can change over time.\n * @param options - A `ref`, plain value, or reactive getter resolving to the {@link UseQueryOptions} to use.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one provided by `VueQueryPlugin`\n * will be used.\n * @returns The current query result, with `data` typed as possibly `undefined`.\n * @example\n * Passing a whole-options getter so `staleTime` reacts to a setting stored elsewhere, not just `queryKey`:\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQuery } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ id: number; staleTime: number }>()\n *\n * const { data } = useQuery(() => ({\n * queryKey: ['post', props.id],\n * queryFn: () => fetchPost(props.id),\n * staleTime: props.staleTime,\n * }))\n * </script>\n *\n * <template>\n * <h1 v-if=\"data\">{{ data.title }}</h1>\n * </template>\n * ```\n * @example\n * `skipToken` disables the query in a type-safe way, without a non-null assertion on `props.postId` —\n * `queryFn` is only ever called when it's defined. The whole-options getter re-evaluates `queryFn` on every\n * change to `props.postId`. `queryFn` can also be a `computed`, but never a bare getter, since a function\n * there is the query function itself. `refetch` doesn't work while `queryFn` is `skipToken` — use\n * `enabled: false` instead if you need to trigger the query manually:\n * ```vue\n * <script setup lang=\"ts\">\n * import { skipToken, useQuery } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ postId: number | undefined }>()\n *\n * const { data, isLoading, isError, error } = useQuery(() => {\n * const postId = props.postId\n * return {\n * queryKey: ['post', postId],\n * queryFn: postId != null ? () => fetchPost(postId) : skipToken,\n * }\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"props.postId == null\">Select a post</span>\n * <span v-else-if=\"isLoading\">Loading...</span>\n * <span v-else-if=\"isError\">Error: {{ error.message }}</span>\n * <h1 v-else>{{ data?.title }}</h1>\n * </template>\n * ```\n */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: MaybeRefOrGetter<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>\n >,\n queryClient?: QueryClient,\n): UseQueryReturnType<TData, TError>\n\nexport function useQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: MaybeRefOrGetter<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>\n >,\n queryClient?: QueryClient,\n):\n | UseQueryReturnType<TData, TError>\n | UseQueryDefinedReturnType<TData, TError> {\n return useBaseQuery(QueryObserver, options, queryClient)\n}\n"],"mappings":";;;;AAySA,SAAgB,SAMd,SAGA,aAG2C;CAC3C,OAAOA,qBAAAA,aAAaC,qBAAAA,eAAe,SAAS,WAAW;AACzD"}
1
+ {"version":3,"file":"useQuery.cjs","names":["useBaseQuery","QueryObserver"],"sources":["../../src/useQuery.ts"],"sourcesContent":["import { QueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n DefaultError,\n DefinedQueryObserverResult,\n QueryKey,\n} from '@tanstack/query-core'\nimport type { QueryClient } from './queryClient'\nimport type {\n DefinedInitialQueryOptions,\n UndefinedInitialQueryOptions,\n UseQueryOptions,\n} from './queryOptions'\nimport type { MaybeRefOrGetter } from './types'\nimport type { UseBaseQueryReturnType } from './useBaseQuery'\n\n/**\n * The result of `useQuery` when `initialData` is omitted, may be `undefined`, or is a function that may\n * return `undefined` — `data` may be `undefined` while the query is `pending`. See\n * {@link UseBaseQueryReturnType}.\n */\nexport type UseQueryReturnType<TData, TError> = UseBaseQueryReturnType<\n TData,\n TError\n>\n\n/**\n * The result of `useQuery` when `initialData` is set — `data` is never `undefined` (unless a `select` changes\n * `TData` to include `undefined`).\n */\nexport type UseQueryDefinedReturnType<TData, TError> = UseBaseQueryReturnType<\n TData,\n TError,\n DefinedQueryObserverResult<TData, TError>\n>\n\n/**\n * This overload is selected when `initialData` is known to be defined, so the resulting `data` is typed as never\n * `undefined` (unless a `select` changes `TData` to include `undefined`). At runtime, `data` is still `undefined`\n * if `select` throws on its first call.\n *\n * `enabled` accepts a `ref`, a plain boolean, or a zero-argument getter (`() => ...`): a `ref` or a getter is\n * tracked, while a plain boolean isn't tracked on its own. query-core's `(query) => boolean` callback is\n * accepted too and is passed through untracked. `queryKey` reacts through a `ref` or a reactive getter for the\n * array itself, or `ref`s and reactive getters as individual entries. Other options are read once when passed as\n * a plain value, and stay reactive when passed as a `ref` or a `computed`.\n * @param options - The {@link DefinedInitialQueryOptions} to use — everything you can pass to `useQuery`,\n * with `initialData` known to be defined.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one provided by `VueQueryPlugin`\n * will be used.\n * @returns The current query result, typed so that `status` is `success` or `error` (`status` never resolves\n * to `pending` in this overload's type, since `initialData` guarantees data upfront). `status` is `error` if\n * the query has an error from a fetch that failed after its retries or if `select` threw, and `success`\n * otherwise. `isSuccess`/`isError` are derived boolean `ref`s for convenience. `state` is that result as one\n * readonly reactive object — `state.data`, `state.isPending`, and the rest are plain values.\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQuery } from '@tanstack/vue-query'\n *\n * // `data` is `Post[]`, never `undefined`, thanks to `initialData` — even if a refetch fails,\n * // so the list stays visible alongside the error.\n * const { data, isError, error } = useQuery({\n * queryKey: ['posts'],\n * queryFn: fetchPosts,\n * initialData: [],\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"isError\">Error: {{ error.message }}</span>\n * <ul>\n * <li v-for=\"post in data\" :key=\"post.id\">{{ post.title }}</li>\n * </ul>\n * </template>\n * ```\n */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n queryClient?: QueryClient,\n): UseQueryDefinedReturnType<TData, TError>\n\n/**\n * `enabled` accepts a `ref`, a plain boolean, or a zero-argument getter (`() => ...`): a `ref` or a getter is\n * tracked, while a plain boolean isn't tracked on its own. query-core's `(query) => boolean` callback is\n * accepted too and is passed through untracked. `queryKey` reacts through a `ref` or a reactive getter for the\n * array itself, or `ref`s and reactive getters as individual entries. Other options are read once when passed as\n * a plain value, and stay reactive when passed as a `ref` or a `computed`.\n * @param options - The {@link UndefinedInitialQueryOptions} to use — everything you can pass to `useQuery`.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one provided by `VueQueryPlugin`\n * will be used.\n * @returns The current query result. `status` is `error` if the query has an error from a fetch that failed\n * after its retries or if `select` threw, `success` if the query has cached data (even if `select` returns\n * `undefined`) or data from `placeholderData`, and `pending` otherwise. `isPending`/`isSuccess`/`isError` are\n * derived boolean `ref`s for convenience. `state` is that result as one readonly reactive object —\n * `state.data`, `state.isPending`, and the rest are plain values, and `state.status === 'success'` narrows\n * `state.data` to `TData`.\n * @example\n * A query key built from a reactive `ref` — the query refetches whenever `postId` changes:\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { useQuery } from '@tanstack/vue-query'\n *\n * const postId = ref(1)\n * const { status, data, error } = useQuery({\n * queryKey: ['post', postId],\n * queryFn: () => fetchPost(postId.value),\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"status === 'pending'\">Loading...</span>\n * <span v-else-if=\"status === 'error'\">Error: {{ error.message }}</span>\n * <h1 v-else>{{ data.title }}</h1>\n * </template>\n * ```\n * @example\n * `select` derives whatever `data` a component needs from the cached value, without changing what's\n * actually stored in the cache — the cache still holds the full `Post[]`, but `data` here is a `number`:\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQuery } from '@tanstack/vue-query'\n *\n * const { data, isPending, isError, error } = useQuery({\n * queryKey: ['posts'],\n * queryFn: fetchPosts,\n * select: (posts) => posts.length,\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"isPending\">Loading...</span>\n * <span v-else-if=\"isError\">Error: {{ error.message }}</span>\n * <span v-else>{{ data }} posts</span>\n * </template>\n * ```\n * @example\n * A dependent query, only enabled once `postId` is set — use `isLoading`, not `isPending`, so the\n * loading state doesn't show while the query is disabled:\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { useQuery } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ postId: number | undefined }>()\n *\n * const { data, isLoading, isError, error } = useQuery({\n * queryKey: ['post', props.postId],\n * queryFn: () => fetchPost(props.postId!),\n * enabled: () => props.postId != null,\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"props.postId == null\">Select a post</span>\n * <span v-else-if=\"isLoading\">Loading...</span>\n * <span v-else-if=\"isError\">Error: {{ error.message }}</span>\n * <h1 v-else>{{ data?.title }}</h1>\n * </template>\n * ```\n * @example\n * Seeding a detail query from an already-cached list, to skip the loading state. `initialDataUpdatedAt` carries\n * over the list's own fetch time, so that if you set a `staleTime`, it's measured from when the list was\n * fetched rather than from now:\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQuery, useQueryClient } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ postId: number }>()\n * const queryClient = useQueryClient()\n *\n * const { data, isError, error } = useQuery({\n * queryKey: ['post', props.postId],\n * queryFn: () => fetchPost(props.postId),\n * initialData: () =>\n * queryClient\n * .getQueryData<Array<Post>>(['posts'])\n * ?.find((post) => post.id === props.postId),\n * initialDataUpdatedAt: () =>\n * queryClient.getQueryState(['posts'])?.dataUpdatedAt,\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"isError\">Error: {{ error.message }}</span>\n * <h1 v-else>{{ data?.title }}</h1>\n * </template>\n * ```\n * @example\n * Paginated data, keeping the previous page's data visible while the next page loads:\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { keepPreviousData, useQuery } from '@tanstack/vue-query'\n *\n * const page = ref(0)\n *\n * const { data, isPlaceholderData, isError, error } = useQuery({\n * queryKey: ['posts', page],\n * queryFn: () => fetchPosts(page.value),\n * placeholderData: keepPreviousData,\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"isError\">Error: {{ error.message }}</span>\n * <template v-else>\n * <ul>\n * <li v-for=\"post in data\" :key=\"post.id\">{{ post.title }}</li>\n * </ul>\n * <button :disabled=\"isPlaceholderData\" @click=\"page++\">Next Page</button>\n * </template>\n * </template>\n * ```\n * @example\n * `state` keeps `data`, `error`, `status`, and `isPending` on one reactive object, so a `status` check\n * narrows `data` and you never read `.value`:\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQuery } from '@tanstack/vue-query'\n *\n * const { state } = useQuery({\n * queryKey: ['post'],\n * queryFn: fetchPost,\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"state.status === 'pending'\">Loading...</span>\n * <span v-else-if=\"state.status === 'error'\">Error: {{ state.error.message }}</span>\n * <h1 v-else>{{ state.data.title }}</h1>\n * </template>\n * ```\n */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n queryClient?: QueryClient,\n): UseQueryReturnType<TData, TError>\n\n/**\n * Fallback overload for options whose `initialData` presence isn't statically known — for example, a\n * `ref`/reactive object built up conditionally, rather than a plain object literal. Prefer one of the other\n * overloads when possible, since they infer whether `data` can be `undefined` from `initialData` directly.\n *\n * `enabled` accepts a `ref`, a plain boolean, or a zero-argument getter (`() => ...`): a `ref` or a getter is\n * tracked, while a plain boolean isn't tracked on its own. query-core's `(query) => boolean` callback is\n * accepted too and is passed through untracked. `queryKey` reacts through a `ref` or a reactive getter for the\n * array itself, or `ref`s and reactive getters as individual entries.\n *\n * When `options` itself is a reactive getter, the whole object is re-evaluated on every change to its\n * dependencies, so any option inside it — not just `queryKey` and `enabled` — can change over time.\n * @param options - A `ref`, plain value, or reactive getter resolving to the {@link UseQueryOptions} to use.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one provided by `VueQueryPlugin`\n * will be used.\n * @returns The current query result. `status` is `error` if the query has an error from a fetch that failed\n * after its retries or if `select` threw, `success` if the query has cached data (even if `select` returns\n * `undefined`) or data from `placeholderData`, and `pending` otherwise. `isPending`/`isSuccess`/`isError` are\n * derived boolean `ref`s for convenience. `state` is that result as one readonly reactive object —\n * `state.data`, `state.isPending`, and the rest are plain values, and `state.status === 'success'` narrows\n * `state.data` to `TData`.\n * @example\n * Passing a whole-options getter so `staleTime` reacts to a setting stored elsewhere, not just `queryKey`:\n * ```vue\n * <script setup lang=\"ts\">\n * import { useQuery } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ id: number; staleTime: number }>()\n *\n * const { data } = useQuery(() => ({\n * queryKey: ['post', props.id],\n * queryFn: () => fetchPost(props.id),\n * staleTime: props.staleTime,\n * }))\n * </script>\n *\n * <template>\n * <h1 v-if=\"data\">{{ data.title }}</h1>\n * </template>\n * ```\n * @example\n * `skipToken` disables the query in a type-safe way, without a non-null assertion on `props.postId` —\n * `queryFn` is only ever called when it's defined. The whole-options getter re-evaluates `queryFn` on every\n * change to `props.postId`. `queryFn` can also be a `computed`, but never a bare getter, since a function\n * there is the query function itself. `refetch` doesn't work while `queryFn` is `skipToken` — use\n * `enabled: false` instead if you need to trigger the query manually:\n * ```vue\n * <script setup lang=\"ts\">\n * import { skipToken, useQuery } from '@tanstack/vue-query'\n *\n * const props = defineProps<{ postId: number | undefined }>()\n *\n * const { data, isLoading, isError, error } = useQuery(() => {\n * const postId = props.postId\n * return {\n * queryKey: ['post', postId],\n * queryFn: postId != null ? () => fetchPost(postId) : skipToken,\n * }\n * })\n * </script>\n *\n * <template>\n * <span v-if=\"props.postId == null\">Select a post</span>\n * <span v-else-if=\"isLoading\">Loading...</span>\n * <span v-else-if=\"isError\">Error: {{ error.message }}</span>\n * <h1 v-else>{{ data?.title }}</h1>\n * </template>\n * ```\n */\nexport function useQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: MaybeRefOrGetter<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>\n >,\n queryClient?: QueryClient,\n): UseQueryReturnType<TData, TError>\n\nexport function useQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: MaybeRefOrGetter<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>\n >,\n queryClient?: QueryClient,\n):\n | UseQueryReturnType<TData, TError>\n | UseQueryDefinedReturnType<TData, TError> {\n return useBaseQuery(QueryObserver, options, queryClient)\n}\n"],"mappings":";;;;AA2UA,SAAgB,SAMd,SAGA,aAG2C;CAC3C,OAAOA,qBAAAA,aAAaC,qBAAAA,eAAe,SAAS,WAAW;AACzD"}
@@ -1,7 +1,7 @@
1
1
  import { s as MaybeRefOrGetter } from "./types-u_Tu5Ybs.cjs";
2
- import { i as UndefinedInitialQueryOptions, o as UseQueryOptions, t as DefinedInitialQueryOptions } from "./queryOptions-BuZEBLtg.cjs";
3
- import { t as QueryClient$1 } from "./queryClient-BGn8uIej.cjs";
4
- import { c as UseBaseQueryReturnType } from "./infiniteQueryOptions-lJ_zR-As.cjs";
2
+ import { i as UndefinedInitialQueryOptions, o as UseQueryOptions, t as DefinedInitialQueryOptions } from "./queryOptions-nndmAASX.cjs";
3
+ import { t as QueryClient$1 } from "./queryClient-yJW8K_VP.cjs";
4
+ import { c as UseBaseQueryReturnType } from "./infiniteQueryOptions-CLfd_vOE.cjs";
5
5
  import { DefaultError, DefinedQueryObserverResult, QueryKey } from "@tanstack/query-core";
6
6
  /**
7
7
  * The result of `useQuery` when `initialData` is omitted, may be `undefined`, or is a function that may
@@ -15,20 +15,24 @@ export type UseQueryReturnType<TData, TError> = UseBaseQueryReturnType<TData, TE
15
15
  */
16
16
  export type UseQueryDefinedReturnType<TData, TError> = UseBaseQueryReturnType<TData, TError, DefinedQueryObserverResult<TData, TError>>;
17
17
  /**
18
- * This overload is selected when `initialData` is known to be defined, so the resulting `data` is never
19
- * `undefined` (unless a `select` changes `TData` to include `undefined`).
18
+ * This overload is selected when `initialData` is known to be defined, so the resulting `data` is typed as never
19
+ * `undefined` (unless a `select` changes `TData` to include `undefined`). At runtime, `data` is still `undefined`
20
+ * if `select` throws on its first call.
20
21
  *
21
- * `enabled` tracks reactive dependencies automatically as a `ref`, a plain value, or a reactive getter
22
- * (`() => ...`). `queryKey` reacts through a `ref` or a reactive getter for the array itself, or `ref`s and
23
- * reactive getters as individual entries. Other options are read once when passed as a plain value, and stay
24
- * reactive when passed as a `ref` or a `computed`.
22
+ * `enabled` accepts a `ref`, a plain boolean, or a zero-argument getter (`() => ...`): a `ref` or a getter is
23
+ * tracked, while a plain boolean isn't tracked on its own. query-core's `(query) => boolean` callback is
24
+ * accepted too and is passed through untracked. `queryKey` reacts through a `ref` or a reactive getter for the
25
+ * array itself, or `ref`s and reactive getters as individual entries. Other options are read once when passed as
26
+ * a plain value, and stay reactive when passed as a `ref` or a `computed`.
25
27
  * @param options - The {@link DefinedInitialQueryOptions} to use — everything you can pass to `useQuery`,
26
28
  * with `initialData` known to be defined.
27
29
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one provided by `VueQueryPlugin`
28
30
  * will be used.
29
- * @returns The current query result, typed so that `data` is never `undefined` (unless a `select` changes
30
- * `TData` to include `undefined`). `status` never resolves to `pending` in this overload's type, since
31
- * `initialData` guarantees data upfront.
31
+ * @returns The current query result, typed so that `status` is `success` or `error` (`status` never resolves
32
+ * to `pending` in this overload's type, since `initialData` guarantees data upfront). `status` is `error` if
33
+ * the query has an error from a fetch that failed after its retries or if `select` threw, and `success`
34
+ * otherwise. `isSuccess`/`isError` are derived boolean `ref`s for convenience. `state` is that result as one
35
+ * readonly reactive object — `state.data`, `state.isPending`, and the rest are plain values.
32
36
  * @example
33
37
  * ```vue
34
38
  * <script setup lang="ts">
@@ -53,15 +57,20 @@ export type UseQueryDefinedReturnType<TData, TError> = UseBaseQueryReturnType<TD
53
57
  */
54
58
  export declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient$1): UseQueryDefinedReturnType<TData, TError>;
55
59
  /**
56
- * `enabled` tracks reactive dependencies automatically as a `ref`, a plain value, or a reactive getter
57
- * (`() => ...`). `queryKey` reacts through a `ref` or a reactive getter for the array itself, or `ref`s and
58
- * reactive getters as individual entries. Other options are read once when passed as a plain value, and stay
59
- * reactive when passed as a `ref` or a `computed`.
60
+ * `enabled` accepts a `ref`, a plain boolean, or a zero-argument getter (`() => ...`): a `ref` or a getter is
61
+ * tracked, while a plain boolean isn't tracked on its own. query-core's `(query) => boolean` callback is
62
+ * accepted too and is passed through untracked. `queryKey` reacts through a `ref` or a reactive getter for the
63
+ * array itself, or `ref`s and reactive getters as individual entries. Other options are read once when passed as
64
+ * a plain value, and stay reactive when passed as a `ref` or a `computed`.
60
65
  * @param options - The {@link UndefinedInitialQueryOptions} to use — everything you can pass to `useQuery`.
61
66
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one provided by `VueQueryPlugin`
62
67
  * will be used.
63
- * @returns The current query result. `status` is `pending` if there is no cached data to display, `error` if
64
- * the last fetch attempt failed, or `success` if the query has data to display.
68
+ * @returns The current query result. `status` is `error` if the query has an error from a fetch that failed
69
+ * after its retries or if `select` threw, `success` if the query has cached data (even if `select` returns
70
+ * `undefined`) or data from `placeholderData`, and `pending` otherwise. `isPending`/`isSuccess`/`isError` are
71
+ * derived boolean `ref`s for convenience. `state` is that result as one readonly reactive object —
72
+ * `state.data`, `state.isPending`, and the rest are plain values, and `state.status === 'success'` narrows
73
+ * `state.data` to `TData`.
65
74
  * @example
66
75
  * A query key built from a reactive `ref` — the query refetches whenever `postId` changes:
67
76
  * ```vue
@@ -180,6 +189,25 @@ export declare function useQuery<TQueryFnData = unknown, TError = DefaultError,
180
189
  * </template>
181
190
  * </template>
182
191
  * ```
192
+ * @example
193
+ * `state` keeps `data`, `error`, `status`, and `isPending` on one reactive object, so a `status` check
194
+ * narrows `data` and you never read `.value`:
195
+ * ```vue
196
+ * <script setup lang="ts">
197
+ * import { useQuery } from '@tanstack/vue-query'
198
+ *
199
+ * const { state } = useQuery({
200
+ * queryKey: ['post'],
201
+ * queryFn: fetchPost,
202
+ * })
203
+ * </script>
204
+ *
205
+ * <template>
206
+ * <span v-if="state.status === 'pending'">Loading...</span>
207
+ * <span v-else-if="state.status === 'error'">Error: {{ state.error.message }}</span>
208
+ * <h1 v-else>{{ state.data.title }}</h1>
209
+ * </template>
210
+ * ```
183
211
  */
184
212
  export declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient$1): UseQueryReturnType<TData, TError>;
185
213
  /**
@@ -187,16 +215,22 @@ export declare function useQuery<TQueryFnData = unknown, TError = DefaultError,
187
215
  * `ref`/reactive object built up conditionally, rather than a plain object literal. Prefer one of the other
188
216
  * overloads when possible, since they infer whether `data` can be `undefined` from `initialData` directly.
189
217
  *
190
- * `enabled` tracks reactive dependencies automatically as a `ref`, a plain value, or a reactive getter
191
- * (`() => ...`). `queryKey` reacts through a `ref` or a reactive getter for the array itself, or `ref`s and
192
- * reactive getters as individual entries.
218
+ * `enabled` accepts a `ref`, a plain boolean, or a zero-argument getter (`() => ...`): a `ref` or a getter is
219
+ * tracked, while a plain boolean isn't tracked on its own. query-core's `(query) => boolean` callback is
220
+ * accepted too and is passed through untracked. `queryKey` reacts through a `ref` or a reactive getter for the
221
+ * array itself, or `ref`s and reactive getters as individual entries.
193
222
  *
194
223
  * When `options` itself is a reactive getter, the whole object is re-evaluated on every change to its
195
224
  * dependencies, so any option inside it — not just `queryKey` and `enabled` — can change over time.
196
225
  * @param options - A `ref`, plain value, or reactive getter resolving to the {@link UseQueryOptions} to use.
197
226
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one provided by `VueQueryPlugin`
198
227
  * will be used.
199
- * @returns The current query result, with `data` typed as possibly `undefined`.
228
+ * @returns The current query result. `status` is `error` if the query has an error from a fetch that failed
229
+ * after its retries or if `select` threw, `success` if the query has cached data (even if `select` returns
230
+ * `undefined`) or data from `placeholderData`, and `pending` otherwise. `isPending`/`isSuccess`/`isError` are
231
+ * derived boolean `ref`s for convenience. `state` is that result as one readonly reactive object —
232
+ * `state.data`, `state.isPending`, and the rest are plain values, and `state.status === 'success'` narrows
233
+ * `state.data` to `TData`.
200
234
  * @example
201
235
  * Passing a whole-options getter so `staleTime` reacts to a setting stored elsewhere, not just `queryKey`:
202
236
  * ```vue
@@ -1 +1 @@
1
- {"version":3,"file":"useQuery.d.cts","names":["QueryClient"],"sources":["../../src/useQuery.ts"],"mappings":";;;;;;;;;;YAqBY,mBAAmB,OAAO,UAAU,uBAC9C,OACA;;;;;YAOU,0BAA0B,OAAO,UAAU,uBACrD,OACA,QACA,2BAA2B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAwCpB,SACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,2BAA2B,cAAc,QAAQ,OAAO,YACjE,cAAcA,gBACb,0BAA0B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAmIpB,SACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,6BAA6B,cAAc,QAAQ,OAAO,YACnE,cAAcA,gBACb,mBAAmB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAiEb,SACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,iBACP,gBAAgB,cAAc,QAAQ,OAAO,cAAc,aAE7D,cAAcA,gBACb,mBAAmB,OAAO"}
1
+ {"version":3,"file":"useQuery.d.cts","names":["QueryClient"],"sources":["../../src/useQuery.ts"],"mappings":";;;;;;;;;;YAqBY,mBAAmB,OAAO,UAAU,uBAC9C,OACA;;;;;YAOU,0BAA0B,OAAO,UAAU,uBACrD,OACA,QACA,2BAA2B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA4CpB,SACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,2BAA2B,cAAc,QAAQ,OAAO,YACjE,cAAcA,gBACb,0BAA0B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA2JpB,SACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,6BAA6B,cAAc,QAAQ,OAAO,YACnE,cAAcA,gBACb,mBAAmB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAuEb,SACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,iBACP,gBAAgB,cAAc,QAAQ,OAAO,cAAc,aAE7D,cAAcA,gBACb,mBAAmB,OAAO"}