@tanstack/vue-query 5.103.2 → 5.104.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/legacy/devtools/devtools.d.cts +2 -3
- package/build/legacy/devtools/devtools.d.cts.map +1 -1
- package/build/legacy/devtools/devtools.d.ts +2 -3
- package/build/legacy/devtools/devtools.d.ts.map +1 -1
- package/build/legacy/devtools/utils.d.cts +5 -6
- package/build/legacy/devtools/utils.d.cts.map +1 -1
- package/build/legacy/devtools/utils.d.ts +5 -6
- package/build/legacy/devtools/utils.d.ts.map +1 -1
- package/build/legacy/index.d.cts +3 -3
- package/build/legacy/index.d.ts +3 -3
- package/build/legacy/{infiniteQueryOptions-qN6sOJM-.d.cts → infiniteQueryOptions-CnTRbIP5.d.cts} +16 -6
- package/build/legacy/infiniteQueryOptions-CnTRbIP5.d.cts.map +1 -0
- package/build/legacy/{infiniteQueryOptions-CEDiLwh5.d.ts → infiniteQueryOptions-NucMX_M_.d.ts} +16 -6
- package/build/legacy/infiniteQueryOptions-NucMX_M_.d.ts.map +1 -0
- package/build/legacy/infiniteQueryOptions.cjs.map +1 -1
- package/build/legacy/infiniteQueryOptions.d.cts +1 -1
- package/build/legacy/infiniteQueryOptions.d.ts +1 -1
- package/build/legacy/infiniteQueryOptions.js.map +1 -1
- package/build/legacy/mutationCache.d.cts +1 -2
- package/build/legacy/mutationCache.d.cts.map +1 -1
- package/build/legacy/mutationCache.d.ts +1 -2
- package/build/legacy/mutationCache.d.ts.map +1 -1
- package/build/legacy/mutationOptions.cjs.map +1 -1
- package/build/legacy/mutationOptions.d.cts +8 -5
- package/build/legacy/mutationOptions.d.cts.map +1 -1
- package/build/legacy/mutationOptions.d.ts +8 -5
- package/build/legacy/mutationOptions.d.ts.map +1 -1
- package/build/legacy/mutationOptions.js.map +1 -1
- package/build/legacy/queryCache.d.cts +1 -2
- package/build/legacy/queryCache.d.cts.map +1 -1
- package/build/legacy/queryCache.d.ts +1 -2
- package/build/legacy/queryCache.d.ts.map +1 -1
- package/build/legacy/{queryClient-Cv73nzNT.d.ts → queryClient-B6mLtXOj.d.ts} +9 -2
- package/build/legacy/queryClient-B6mLtXOj.d.ts.map +1 -0
- package/build/{modern/queryClient-CZeNAt68.d.cts → legacy/queryClient-Bn2Ql_Lu.d.cts} +9 -2
- package/build/legacy/queryClient-Bn2Ql_Lu.d.cts.map +1 -0
- package/build/legacy/queryClient.cjs +7 -0
- package/build/legacy/queryClient.cjs.map +1 -1
- package/build/legacy/queryClient.d.cts +1 -1
- package/build/legacy/queryClient.d.ts +1 -1
- package/build/legacy/queryClient.js +7 -0
- package/build/legacy/queryClient.js.map +1 -1
- package/build/{modern/queryOptions-DPDwdVBu.d.ts → legacy/queryOptions-CsM5TXD2.d.ts} +4 -3
- package/build/legacy/queryOptions-CsM5TXD2.d.ts.map +1 -0
- package/build/{modern/queryOptions-rkZ3sk6g.d.cts → legacy/queryOptions-CwqQgQmQ.d.cts} +4 -3
- package/build/legacy/queryOptions-CwqQgQmQ.d.cts.map +1 -0
- package/build/legacy/queryOptions.cjs.map +1 -1
- package/build/legacy/queryOptions.d.cts +1 -1
- package/build/legacy/queryOptions.d.ts +1 -1
- package/build/legacy/queryOptions.js.map +1 -1
- package/build/legacy/types-JpJB72CS.d.cts.map +1 -1
- package/build/legacy/types-JpJB72CS.d.ts.map +1 -1
- package/build/legacy/useBaseQuery.cjs.map +1 -1
- package/build/legacy/useBaseQuery.d.cts +1 -1
- package/build/legacy/useBaseQuery.d.ts +1 -1
- package/build/legacy/useBaseQuery.js.map +1 -1
- package/build/legacy/useInfiniteQuery.cjs.map +1 -1
- package/build/legacy/useInfiniteQuery.d.cts +1 -1
- package/build/legacy/useInfiniteQuery.d.ts +1 -1
- package/build/legacy/useInfiniteQuery.js.map +1 -1
- package/build/legacy/useIsFetching.cjs.map +1 -1
- package/build/legacy/useIsFetching.d.cts +3 -4
- package/build/legacy/useIsFetching.d.cts.map +1 -1
- package/build/legacy/useIsFetching.d.ts +3 -4
- package/build/legacy/useIsFetching.d.ts.map +1 -1
- package/build/legacy/useIsFetching.js.map +1 -1
- package/build/legacy/useMutation.d.cts +4 -5
- package/build/legacy/useMutation.d.cts.map +1 -1
- package/build/legacy/useMutation.d.ts +4 -5
- package/build/legacy/useMutation.d.ts.map +1 -1
- package/build/legacy/useMutationState.cjs.map +1 -1
- package/build/legacy/useMutationState.d.cts +5 -6
- package/build/legacy/useMutationState.d.cts.map +1 -1
- package/build/legacy/useMutationState.d.ts +5 -6
- package/build/legacy/useMutationState.d.ts.map +1 -1
- package/build/legacy/useMutationState.js.map +1 -1
- package/build/legacy/usePrefetchInfiniteQuery.d.cts +3 -4
- package/build/legacy/usePrefetchInfiniteQuery.d.cts.map +1 -1
- package/build/legacy/usePrefetchInfiniteQuery.d.ts +3 -4
- package/build/legacy/usePrefetchInfiniteQuery.d.ts.map +1 -1
- package/build/legacy/usePrefetchQuery.d.cts +3 -4
- package/build/legacy/usePrefetchQuery.d.cts.map +1 -1
- package/build/legacy/usePrefetchQuery.d.ts +3 -4
- package/build/legacy/usePrefetchQuery.d.ts.map +1 -1
- package/build/legacy/useQueries.d.cts +5 -6
- package/build/legacy/useQueries.d.cts.map +1 -1
- package/build/legacy/useQueries.d.ts +5 -6
- package/build/legacy/useQueries.d.ts.map +1 -1
- package/build/legacy/useQuery.cjs.map +1 -1
- package/build/legacy/useQuery.d.cts +18 -13
- package/build/legacy/useQuery.d.cts.map +1 -1
- package/build/legacy/useQuery.d.ts +18 -13
- package/build/legacy/useQuery.d.ts.map +1 -1
- package/build/legacy/useQuery.js.map +1 -1
- package/build/legacy/useQueryClient.d.cts +2 -3
- package/build/legacy/useQueryClient.d.cts.map +1 -1
- package/build/legacy/useQueryClient.d.ts +2 -3
- package/build/legacy/useQueryClient.d.ts.map +1 -1
- package/build/legacy/utils.d.cts +6 -7
- package/build/legacy/utils.d.cts.map +1 -1
- package/build/legacy/utils.d.ts +6 -7
- package/build/legacy/utils.d.ts.map +1 -1
- package/build/legacy/vueQueryPlugin.d.cts +3 -4
- package/build/legacy/vueQueryPlugin.d.cts.map +1 -1
- package/build/legacy/vueQueryPlugin.d.ts +3 -4
- package/build/legacy/vueQueryPlugin.d.ts.map +1 -1
- package/build/modern/devtools/devtools.d.cts +2 -3
- package/build/modern/devtools/devtools.d.cts.map +1 -1
- package/build/modern/devtools/devtools.d.ts +2 -3
- package/build/modern/devtools/devtools.d.ts.map +1 -1
- package/build/modern/devtools/utils.d.cts +5 -6
- package/build/modern/devtools/utils.d.cts.map +1 -1
- package/build/modern/devtools/utils.d.ts +5 -6
- package/build/modern/devtools/utils.d.ts.map +1 -1
- package/build/modern/index.d.cts +3 -3
- package/build/modern/index.d.ts +3 -3
- package/build/modern/{infiniteQueryOptions-qN6sOJM-.d.cts → infiniteQueryOptions-CnTRbIP5.d.cts} +16 -6
- package/build/modern/infiniteQueryOptions-CnTRbIP5.d.cts.map +1 -0
- package/build/modern/{infiniteQueryOptions-CEDiLwh5.d.ts → infiniteQueryOptions-NucMX_M_.d.ts} +16 -6
- package/build/modern/infiniteQueryOptions-NucMX_M_.d.ts.map +1 -0
- package/build/modern/infiniteQueryOptions.cjs.map +1 -1
- package/build/modern/infiniteQueryOptions.d.cts +1 -1
- package/build/modern/infiniteQueryOptions.d.ts +1 -1
- package/build/modern/infiniteQueryOptions.js.map +1 -1
- package/build/modern/mutationCache.d.cts +1 -2
- package/build/modern/mutationCache.d.cts.map +1 -1
- package/build/modern/mutationCache.d.ts +1 -2
- package/build/modern/mutationCache.d.ts.map +1 -1
- package/build/modern/mutationOptions.cjs.map +1 -1
- package/build/modern/mutationOptions.d.cts +8 -5
- package/build/modern/mutationOptions.d.cts.map +1 -1
- package/build/modern/mutationOptions.d.ts +8 -5
- package/build/modern/mutationOptions.d.ts.map +1 -1
- package/build/modern/mutationOptions.js.map +1 -1
- package/build/modern/queryCache.d.cts +1 -2
- package/build/modern/queryCache.d.cts.map +1 -1
- package/build/modern/queryCache.d.ts +1 -2
- package/build/modern/queryCache.d.ts.map +1 -1
- package/build/modern/{queryClient-Cv73nzNT.d.ts → queryClient-B6mLtXOj.d.ts} +9 -2
- package/build/modern/queryClient-B6mLtXOj.d.ts.map +1 -0
- package/build/{legacy/queryClient-CZeNAt68.d.cts → modern/queryClient-Bn2Ql_Lu.d.cts} +9 -2
- package/build/modern/queryClient-Bn2Ql_Lu.d.cts.map +1 -0
- package/build/modern/queryClient.cjs +7 -0
- package/build/modern/queryClient.cjs.map +1 -1
- package/build/modern/queryClient.d.cts +1 -1
- package/build/modern/queryClient.d.ts +1 -1
- package/build/modern/queryClient.js +7 -0
- package/build/modern/queryClient.js.map +1 -1
- package/build/{legacy/queryOptions-DPDwdVBu.d.ts → modern/queryOptions-CsM5TXD2.d.ts} +4 -3
- package/build/modern/queryOptions-CsM5TXD2.d.ts.map +1 -0
- package/build/{legacy/queryOptions-rkZ3sk6g.d.cts → modern/queryOptions-CwqQgQmQ.d.cts} +4 -3
- package/build/modern/queryOptions-CwqQgQmQ.d.cts.map +1 -0
- package/build/modern/queryOptions.cjs.map +1 -1
- package/build/modern/queryOptions.d.cts +1 -1
- package/build/modern/queryOptions.d.ts +1 -1
- package/build/modern/queryOptions.js.map +1 -1
- package/build/modern/types-JpJB72CS.d.cts.map +1 -1
- package/build/modern/types-JpJB72CS.d.ts.map +1 -1
- package/build/modern/useBaseQuery.cjs.map +1 -1
- package/build/modern/useBaseQuery.d.cts +1 -1
- package/build/modern/useBaseQuery.d.ts +1 -1
- package/build/modern/useBaseQuery.js.map +1 -1
- package/build/modern/useInfiniteQuery.cjs.map +1 -1
- package/build/modern/useInfiniteQuery.d.cts +1 -1
- package/build/modern/useInfiniteQuery.d.ts +1 -1
- package/build/modern/useInfiniteQuery.js.map +1 -1
- package/build/modern/useIsFetching.cjs.map +1 -1
- package/build/modern/useIsFetching.d.cts +3 -4
- package/build/modern/useIsFetching.d.cts.map +1 -1
- package/build/modern/useIsFetching.d.ts +3 -4
- package/build/modern/useIsFetching.d.ts.map +1 -1
- package/build/modern/useIsFetching.js.map +1 -1
- package/build/modern/useMutation.d.cts +4 -5
- package/build/modern/useMutation.d.cts.map +1 -1
- package/build/modern/useMutation.d.ts +4 -5
- package/build/modern/useMutation.d.ts.map +1 -1
- package/build/modern/useMutationState.cjs.map +1 -1
- package/build/modern/useMutationState.d.cts +5 -6
- package/build/modern/useMutationState.d.cts.map +1 -1
- package/build/modern/useMutationState.d.ts +5 -6
- package/build/modern/useMutationState.d.ts.map +1 -1
- package/build/modern/useMutationState.js.map +1 -1
- package/build/modern/usePrefetchInfiniteQuery.d.cts +3 -4
- package/build/modern/usePrefetchInfiniteQuery.d.cts.map +1 -1
- package/build/modern/usePrefetchInfiniteQuery.d.ts +3 -4
- package/build/modern/usePrefetchInfiniteQuery.d.ts.map +1 -1
- package/build/modern/usePrefetchQuery.d.cts +3 -4
- package/build/modern/usePrefetchQuery.d.cts.map +1 -1
- package/build/modern/usePrefetchQuery.d.ts +3 -4
- package/build/modern/usePrefetchQuery.d.ts.map +1 -1
- package/build/modern/useQueries.d.cts +5 -6
- package/build/modern/useQueries.d.cts.map +1 -1
- package/build/modern/useQueries.d.ts +5 -6
- package/build/modern/useQueries.d.ts.map +1 -1
- package/build/modern/useQuery.cjs.map +1 -1
- package/build/modern/useQuery.d.cts +18 -13
- package/build/modern/useQuery.d.cts.map +1 -1
- package/build/modern/useQuery.d.ts +18 -13
- package/build/modern/useQuery.d.ts.map +1 -1
- package/build/modern/useQuery.js.map +1 -1
- package/build/modern/useQueryClient.d.cts +2 -3
- package/build/modern/useQueryClient.d.cts.map +1 -1
- package/build/modern/useQueryClient.d.ts +2 -3
- package/build/modern/useQueryClient.d.ts.map +1 -1
- package/build/modern/utils.d.cts +6 -7
- package/build/modern/utils.d.cts.map +1 -1
- package/build/modern/utils.d.ts +6 -7
- package/build/modern/utils.d.ts.map +1 -1
- package/build/modern/vueQueryPlugin.d.cts +3 -4
- package/build/modern/vueQueryPlugin.d.cts.map +1 -1
- package/build/modern/vueQueryPlugin.d.ts +3 -4
- package/build/modern/vueQueryPlugin.d.ts.map +1 -1
- package/package.json +9 -9
- package/src/infiniteQueryOptions.ts +3 -2
- package/src/mutationOptions.ts +4 -0
- package/src/queryClient.ts +7 -0
- package/src/queryOptions.ts +29 -26
- package/src/useBaseQuery.ts +9 -3
- package/src/useInfiniteQuery.ts +11 -8
- package/src/useIsFetching.ts +1 -2
- package/src/useMutationState.ts +1 -2
- package/src/useQuery.ts +11 -6
- package/build/legacy/infiniteQueryOptions-CEDiLwh5.d.ts.map +0 -1
- package/build/legacy/infiniteQueryOptions-qN6sOJM-.d.cts.map +0 -1
- package/build/legacy/queryClient-CZeNAt68.d.cts.map +0 -1
- package/build/legacy/queryClient-Cv73nzNT.d.ts.map +0 -1
- package/build/legacy/queryOptions-DPDwdVBu.d.ts.map +0 -1
- package/build/legacy/queryOptions-rkZ3sk6g.d.cts.map +0 -1
- package/build/modern/infiniteQueryOptions-CEDiLwh5.d.ts.map +0 -1
- package/build/modern/infiniteQueryOptions-qN6sOJM-.d.cts.map +0 -1
- package/build/modern/queryClient-CZeNAt68.d.cts.map +0 -1
- package/build/modern/queryClient-Cv73nzNT.d.ts.map +0 -1
- package/build/modern/queryOptions-DPDwdVBu.d.ts.map +0 -1
- package/build/modern/queryOptions-rkZ3sk6g.d.cts.map +0 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { l as NoUnknown, o as MaybeRefDeep, u as QueryClientConfig } from "./types-JpJB72CS.js";
|
|
2
|
-
import { o as UseQueryOptions } from "./queryOptions-
|
|
2
|
+
import { o as UseQueryOptions } from "./queryOptions-CsM5TXD2.js";
|
|
3
3
|
import { CancelOptions, DefaultError, DefaultOptions, EnsureQueryDataOptions, FetchInfiniteQueryOptions, FetchQueryOptions, InferDataFromTag, InfiniteData, InfiniteQueryExecuteOptions, InvalidateOptions, InvalidateQueryFilters, MutationFilters, MutationKey, MutationObserverOptions, OmitKeyof, QueryClient, QueryExecuteOptions, QueryFilters, QueryKey, QueryObserverOptions, QueryState, RefetchOptions, RefetchQueryFilters, ResetOptions, SetDataOptions, Updater } from "@tanstack/query-core";
|
|
4
4
|
import { Ref } from "vue-demi";
|
|
5
5
|
//#region src/queryClient.d.ts
|
|
@@ -8,6 +8,13 @@ import { Ref } from "vue-demi";
|
|
|
8
8
|
* `CancelOptions` or `InvalidateOptions`) or filters (such as the `QueryFilters` accepted by
|
|
9
9
|
* `invalidateQueries`) also accept a {@link MaybeRefDeep} version of it, so you can pass `ref`s directly
|
|
10
10
|
* without unwrapping them yourself — e.g. `queryClient.invalidateQueries({ queryKey: ['post', myRef] })`.
|
|
11
|
+
*
|
|
12
|
+
* `ref` entries in a `queryKey` are unwrapped this way on every method, but reactive getter entries
|
|
13
|
+
* (`() => id.value`) are only unwrapped when the `queryKey` is passed as a `queryKey` property of a
|
|
14
|
+
* filters/options object (e.g. `invalidateQueries({ queryKey: ['post', idGetter] })`) — methods like
|
|
15
|
+
* `getQueryData` that take the `queryKey` array as their own argument do not unwrap getter entries there,
|
|
16
|
+
* and the getter function itself ends up in the cache key.
|
|
17
|
+
*
|
|
11
18
|
* Install one on your app with `VueQueryPlugin`, or retrieve it with `useQueryClient`.
|
|
12
19
|
*/
|
|
13
20
|
declare class QueryClient$1 extends QueryClient {
|
|
@@ -68,4 +75,4 @@ declare class QueryClient$1 extends QueryClient {
|
|
|
68
75
|
}
|
|
69
76
|
//#endregion
|
|
70
77
|
export { QueryClient$1 as t };
|
|
71
|
-
//# sourceMappingURL=queryClient-
|
|
78
|
+
//# sourceMappingURL=queryClient-B6mLtXOj.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"queryClient-B6mLtXOj.d.ts","names":["QueryClient","QC"],"sources":["../../src/queryClient.ts"],"mappings":";;;;;;;;;;;;;;;;;;;cAkDaA,sBAAoBC;EACnB,YAAA,SAAQ;;;;;EAapB,cAAc;EAEd,WAAW,UAAS,aAAa;EAIjC,WAAW,UAAS,aAAa;EAIjC,aAAa,iBAAiB,wBAAwB,WAAW,UAC/D,UAAU,kBACT,iBAAiB,OAAO;EAC3B,aAAa,iBACX,UAAU,aAAa,YACtB;;;;EAUH,gBACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,uBAAuB,cAAc,QAAQ,OAAO,aAC5D,QAAQ;EACX,gBACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,aACP,uBAAuB,cAAc,QAAQ,OAAO,cAErD,QAAQ;EAeX,eAAe,iBACb,SAAS,aAAa,gBACrB,OAAO,UAAU;EAIpB,aACE,wBACA,wBAAwB,WAAW,UACnC,uBAAuB,iBAAiB,cAAc,kBAEtD,UAAU,iBACV,SAAS,QACP,QAAQ,mCACR,QAAQ,oCAEV,UAAU,aAAa,kBACtB,QAAQ;EACX,aAAa,cAAc,QAAQ,UAAU,eAC3C,UAAU,aAAa,WACvB,SAAS,QAAQ,QAAQ,oBAAoB,QAAQ,qBACrD,UAAU,aAAa,kBACtB,QAAQ;EAaX,eAAe,OACb,SAAS,aAAa,eACtB,SAAS,QAAQ,mBAAmB,oBACpC,UAAS,aAAa,kBACrB,OAAO,UAAU;EAQpB,cAAc,iBAAiB,SAAS,cACtC,UAAU,aAAa,YACtB,WAAW,OAAO;EAIrB,cAAc,wBAAwB,WAAW,UAC/C,UAAU,aAAa;EAMzB,aAAa,wBAAwB,WAAW,UAC9C,UAAU,aAAa,kBACvB,UAAU,aAAa,gBACtB;EAQH,cAAc,wBAAwB,WAAW,UAC/C,UAAU,aAAa,kBACvB,UAAU,aAAa,iBACtB;EAQH,kBAAkB,wBAAwB,WAAW,UACnD,UACI,uBAAuB,0BAChB,uBAAuB,mBAClC,UAAU,aAAa,qBACtB;EAmCH,eAAe,wBAAwB,WAAW,UAChD,UAAU,oBAAoB,kBAC9B,UAAU,aAAa,kBACtB;EAaH,MACE,cACA,SAAS,cACT,QAAQ,cACR,aAAa,cACb,kBAAkB,WAAW,UAC7B,oBAEA,SAAS,oBACP,cACA,QACA,OACA,YACA,WACA,cAED,QAAQ;EACX,MACE,cACA,SAAS,cACT,QAAQ,cACR,aAAa,cACb,kBAAkB,WAAW,UAC7B,oBAEA,SAAS,aACP,oBACE,cACA,QACA,OACA,YACA,WACA,eAGH,QAAQ;;;;EA0BX,WACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAC7B,oBAEA,SAAS,kBACP,cACA,QACA,OACA,WACA,cAED,QAAQ;EACX,WACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAC7B,oBAEA,SACI,aACE,kBAAkB,cAAc,QAAQ,OAAO,WAAW,sBAErD,kBACL,cACA,QACA,OACA,WACA,eAEL,QAAQ;;;;EAmBX,cACE,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,kBAAkB,cAAc,QAAQ,OAAO,aACvD;EACH,cACE,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,aACP,kBAAkB,cAAc,QAAQ,OAAO,cAEhD;EAiBH,cACE,wBACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,4BACP,cACA,QACA,OACA,WACA,cAED,QACD,MAAM,eAAe,MAAM,aAAa,iBACpC,aAAa,cAAc,cAC3B;EAEN,cACE,wBACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,aACP,4BACE,cACA,QACA,OACA,WACA,eAGH,QACD,MAAM,eAAe,MAAM,aAAa,iBACpC,aAAa,cAAc,cAC3B;;;;EA6BN,mBACE,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,0BACP,cACA,QACA,OACA,WACA,cAED,QAAQ,aAAa,OAAO;EAC/B,mBACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,aACP,0BACE,cACA,QACA,OACA,WACA,eAGH,QAAQ,aAAa,OAAO;;;;EAyB/B,sBACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,0BACP,cACA,QACA,OACA,WACA,cAED;EACH,sBACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,aACP,0BACE,cACA,QACA,OACA,WACA,eAGH;EAsBH,kBAAkB,SAAS,aAAa;EAIxC,iBACE,wBACA,SAAS,cACT,QAAQ,cACR,aAAa,cAEb,UAAU,aAAa,WACvB,SAAS,aACP,KAAK,gBAAgB,cAAc,QAAQ,OAAO;EAMtD,iBACE,UAAU,aAAa,YACtB,UAAU;EAIb,oBACE,iBACA,SAAS,cACT,mBACA,2BAEA,aAAa,aAAa,cAC1B,SAAS,aACP,wBAAwB,OAAO,QAAQ,YAAY;EASvD,oBACE,aAAa,aAAa,eACzB"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { l as NoUnknown, o as MaybeRefDeep, u as QueryClientConfig } from "./types-JpJB72CS.cjs";
|
|
2
|
-
import { o as UseQueryOptions } from "./queryOptions-
|
|
2
|
+
import { o as UseQueryOptions } from "./queryOptions-CwqQgQmQ.cjs";
|
|
3
3
|
import { CancelOptions, DefaultError, DefaultOptions, EnsureQueryDataOptions, FetchInfiniteQueryOptions, FetchQueryOptions, InferDataFromTag, InfiniteData, InfiniteQueryExecuteOptions, InvalidateOptions, InvalidateQueryFilters, MutationFilters, MutationKey, MutationObserverOptions, OmitKeyof, QueryClient, QueryExecuteOptions, QueryFilters, QueryKey, QueryObserverOptions, QueryState, RefetchOptions, RefetchQueryFilters, ResetOptions, SetDataOptions, Updater } from "@tanstack/query-core";
|
|
4
4
|
import { Ref } from "vue-demi";
|
|
5
5
|
//#region src/queryClient.d.ts
|
|
@@ -8,6 +8,13 @@ import { Ref } from "vue-demi";
|
|
|
8
8
|
* `CancelOptions` or `InvalidateOptions`) or filters (such as the `QueryFilters` accepted by
|
|
9
9
|
* `invalidateQueries`) also accept a {@link MaybeRefDeep} version of it, so you can pass `ref`s directly
|
|
10
10
|
* without unwrapping them yourself — e.g. `queryClient.invalidateQueries({ queryKey: ['post', myRef] })`.
|
|
11
|
+
*
|
|
12
|
+
* `ref` entries in a `queryKey` are unwrapped this way on every method, but reactive getter entries
|
|
13
|
+
* (`() => id.value`) are only unwrapped when the `queryKey` is passed as a `queryKey` property of a
|
|
14
|
+
* filters/options object (e.g. `invalidateQueries({ queryKey: ['post', idGetter] })`) — methods like
|
|
15
|
+
* `getQueryData` that take the `queryKey` array as their own argument do not unwrap getter entries there,
|
|
16
|
+
* and the getter function itself ends up in the cache key.
|
|
17
|
+
*
|
|
11
18
|
* Install one on your app with `VueQueryPlugin`, or retrieve it with `useQueryClient`.
|
|
12
19
|
*/
|
|
13
20
|
declare class QueryClient$1 extends QueryClient {
|
|
@@ -68,4 +75,4 @@ declare class QueryClient$1 extends QueryClient {
|
|
|
68
75
|
}
|
|
69
76
|
//#endregion
|
|
70
77
|
export { QueryClient$1 as t };
|
|
71
|
-
//# sourceMappingURL=queryClient-
|
|
78
|
+
//# sourceMappingURL=queryClient-Bn2Ql_Lu.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"queryClient-Bn2Ql_Lu.d.cts","names":["QueryClient","QC"],"sources":["../../src/queryClient.ts"],"mappings":";;;;;;;;;;;;;;;;;;;cAkDaA,sBAAoBC;EACnB,YAAA,SAAQ;;;;;EAapB,cAAc;EAEd,WAAW,UAAS,aAAa;EAIjC,WAAW,UAAS,aAAa;EAIjC,aAAa,iBAAiB,wBAAwB,WAAW,UAC/D,UAAU,kBACT,iBAAiB,OAAO;EAC3B,aAAa,iBACX,UAAU,aAAa,YACtB;;;;EAUH,gBACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,uBAAuB,cAAc,QAAQ,OAAO,aAC5D,QAAQ;EACX,gBACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,aACP,uBAAuB,cAAc,QAAQ,OAAO,cAErD,QAAQ;EAeX,eAAe,iBACb,SAAS,aAAa,gBACrB,OAAO,UAAU;EAIpB,aACE,wBACA,wBAAwB,WAAW,UACnC,uBAAuB,iBAAiB,cAAc,kBAEtD,UAAU,iBACV,SAAS,QACP,QAAQ,mCACR,QAAQ,oCAEV,UAAU,aAAa,kBACtB,QAAQ;EACX,aAAa,cAAc,QAAQ,UAAU,eAC3C,UAAU,aAAa,WACvB,SAAS,QAAQ,QAAQ,oBAAoB,QAAQ,qBACrD,UAAU,aAAa,kBACtB,QAAQ;EAaX,eAAe,OACb,SAAS,aAAa,eACtB,SAAS,QAAQ,mBAAmB,oBACpC,UAAS,aAAa,kBACrB,OAAO,UAAU;EAQpB,cAAc,iBAAiB,SAAS,cACtC,UAAU,aAAa,YACtB,WAAW,OAAO;EAIrB,cAAc,wBAAwB,WAAW,UAC/C,UAAU,aAAa;EAMzB,aAAa,wBAAwB,WAAW,UAC9C,UAAU,aAAa,kBACvB,UAAU,aAAa,gBACtB;EAQH,cAAc,wBAAwB,WAAW,UAC/C,UAAU,aAAa,kBACvB,UAAU,aAAa,iBACtB;EAQH,kBAAkB,wBAAwB,WAAW,UACnD,UACI,uBAAuB,0BAChB,uBAAuB,mBAClC,UAAU,aAAa,qBACtB;EAmCH,eAAe,wBAAwB,WAAW,UAChD,UAAU,oBAAoB,kBAC9B,UAAU,aAAa,kBACtB;EAaH,MACE,cACA,SAAS,cACT,QAAQ,cACR,aAAa,cACb,kBAAkB,WAAW,UAC7B,oBAEA,SAAS,oBACP,cACA,QACA,OACA,YACA,WACA,cAED,QAAQ;EACX,MACE,cACA,SAAS,cACT,QAAQ,cACR,aAAa,cACb,kBAAkB,WAAW,UAC7B,oBAEA,SAAS,aACP,oBACE,cACA,QACA,OACA,YACA,WACA,eAGH,QAAQ;;;;EA0BX,WACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAC7B,oBAEA,SAAS,kBACP,cACA,QACA,OACA,WACA,cAED,QAAQ;EACX,WACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAC7B,oBAEA,SACI,aACE,kBAAkB,cAAc,QAAQ,OAAO,WAAW,sBAErD,kBACL,cACA,QACA,OACA,WACA,eAEL,QAAQ;;;;EAmBX,cACE,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,kBAAkB,cAAc,QAAQ,OAAO,aACvD;EACH,cACE,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,aACP,kBAAkB,cAAc,QAAQ,OAAO,cAEhD;EAiBH,cACE,wBACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,4BACP,cACA,QACA,OACA,WACA,cAED,QACD,MAAM,eAAe,MAAM,aAAa,iBACpC,aAAa,cAAc,cAC3B;EAEN,cACE,wBACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,aACP,4BACE,cACA,QACA,OACA,WACA,eAGH,QACD,MAAM,eAAe,MAAM,aAAa,iBACpC,aAAa,cAAc,cAC3B;;;;EA6BN,mBACE,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,0BACP,cACA,QACA,OACA,WACA,cAED,QAAQ,aAAa,OAAO;EAC/B,mBACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,aACP,0BACE,cACA,QACA,OACA,WACA,eAGH,QAAQ,aAAa,OAAO;;;;EAyB/B,sBACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,0BACP,cACA,QACA,OACA,WACA,cAED;EACH,sBACE,cACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,aACP,0BACE,cACA,QACA,OACA,WACA,eAGH;EAsBH,kBAAkB,SAAS,aAAa;EAIxC,iBACE,wBACA,SAAS,cACT,QAAQ,cACR,aAAa,cAEb,UAAU,aAAa,WACvB,SAAS,aACP,KAAK,gBAAgB,cAAc,QAAQ,OAAO;EAMtD,iBACE,UAAU,aAAa,YACtB,UAAU;EAIb,oBACE,iBACA,SAAS,cACT,mBACA,2BAEA,aAAa,aAAa,cAC1B,SAAS,aACP,wBAAwB,OAAO,QAAQ,YAAY;EASvD,oBACE,aAAa,aAAa,eACzB"}
|
|
@@ -10,6 +10,13 @@ let vue_demi = require("vue-demi");
|
|
|
10
10
|
* `CancelOptions` or `InvalidateOptions`) or filters (such as the `QueryFilters` accepted by
|
|
11
11
|
* `invalidateQueries`) also accept a {@link MaybeRefDeep} version of it, so you can pass `ref`s directly
|
|
12
12
|
* without unwrapping them yourself — e.g. `queryClient.invalidateQueries({ queryKey: ['post', myRef] })`.
|
|
13
|
+
*
|
|
14
|
+
* `ref` entries in a `queryKey` are unwrapped this way on every method, but reactive getter entries
|
|
15
|
+
* (`() => id.value`) are only unwrapped when the `queryKey` is passed as a `queryKey` property of a
|
|
16
|
+
* filters/options object (e.g. `invalidateQueries({ queryKey: ['post', idGetter] })`) — methods like
|
|
17
|
+
* `getQueryData` that take the `queryKey` array as their own argument do not unwrap getter entries there,
|
|
18
|
+
* and the getter function itself ends up in the cache key.
|
|
19
|
+
*
|
|
13
20
|
* Install one on your app with `VueQueryPlugin`, or retrieve it with `useQueryClient`.
|
|
14
21
|
*/
|
|
15
22
|
var QueryClient = class extends _tanstack_query_core.QueryClient {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"queryClient.cjs","names":["QC","QueryCache","MutationCache","ref","cloneDeepUnref","nextTick"],"sources":["../../src/queryClient.ts"],"sourcesContent":["import { nextTick, ref } from 'vue-demi'\nimport { QueryClient as QC } from '@tanstack/query-core'\nimport { cloneDeepUnref } from './utils'\nimport { QueryCache } from './queryCache'\nimport { MutationCache } from './mutationCache'\nimport type { UseQueryOptions } from './queryOptions'\nimport type { Ref } from 'vue-demi'\nimport type { MaybeRefDeep, NoUnknown, QueryClientConfig } from './types'\nimport type {\n CancelOptions,\n DefaultError,\n DefaultOptions,\n EnsureQueryDataOptions,\n FetchInfiniteQueryOptions,\n FetchQueryOptions,\n InferDataFromTag,\n InfiniteData,\n InfiniteQueryExecuteOptions,\n InvalidateOptions,\n InvalidateQueryFilters,\n MutationFilters,\n MutationKey,\n MutationObserverOptions,\n OmitKeyof,\n QueryExecuteOptions,\n QueryFilters,\n QueryKey,\n QueryObserverOptions,\n QueryState,\n RefetchOptions,\n RefetchQueryFilters,\n ResetOptions,\n SetDataOptions,\n Updater,\n} from '@tanstack/query-core'\n\n/**\n * Vue-aware subclass of `@tanstack/query-core`'s `QueryClient`. Methods that accept `options` (such as\n * `CancelOptions` or `InvalidateOptions`) or filters (such as the `QueryFilters` accepted by\n * `invalidateQueries`) also accept a {@link MaybeRefDeep} version of it, so you can pass `ref`s directly\n * without unwrapping them yourself — e.g. `queryClient.invalidateQueries({ queryKey: ['post', myRef] })`.\n * Install one on your app with `VueQueryPlugin`, or retrieve it with `useQueryClient`.\n */\nexport class QueryClient extends QC {\n constructor(config: QueryClientConfig = {}) {\n const vueQueryConfig = {\n defaultOptions: config.defaultOptions,\n queryCache: config.queryCache || new QueryCache(),\n mutationCache: config.mutationCache || new MutationCache(),\n }\n super(vueQueryConfig)\n }\n\n /**\n * `true` while a `clientPersister` passed to `VueQueryPlugin` is restoring the cache. Queries don't fetch\n * while this is `true`. Defaults to `false` if no persister is configured.\n */\n isRestoring?: Ref<boolean> = ref(false)\n\n isFetching(filters: MaybeRefDeep<QueryFilters> = {}): number {\n return super.isFetching(cloneDeepUnref(filters))\n }\n\n isMutating(filters: MaybeRefDeep<MutationFilters> = {}): number {\n return super.isMutating(cloneDeepUnref(filters))\n }\n\n getQueryData<TData = unknown, TTaggedQueryKey extends QueryKey = QueryKey>(\n queryKey: TTaggedQueryKey,\n ): InferDataFromTag<TData, TTaggedQueryKey> | undefined\n getQueryData<TData = unknown>(\n queryKey: MaybeRefDeep<QueryKey>,\n ): TData | undefined\n getQueryData<TData = unknown>(\n queryKey: MaybeRefDeep<QueryKey>,\n ): TData | undefined {\n return super.getQueryData(cloneDeepUnref(queryKey))\n }\n\n /**\n * @deprecated Use queryClient.query({ ...options, staleTime: 'static' }) instead. This method will be removed in the next major version.\n */\n ensureQueryData<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>,\n ): Promise<TData>\n ensureQueryData<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<TData>\n ensureQueryData<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<TData> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.ensureQueryData(cloneDeepUnref(options))\n }\n\n getQueriesData<TData = unknown>(\n filters: MaybeRefDeep<QueryFilters>,\n ): Array<[QueryKey, TData | undefined]> {\n return super.getQueriesData(cloneDeepUnref(filters))\n }\n\n setQueryData<\n TQueryFnData = unknown,\n TTaggedQueryKey extends QueryKey = QueryKey,\n TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>,\n >(\n queryKey: TTaggedQueryKey,\n updater: Updater<\n NoInfer<TInferredQueryFnData> | undefined,\n NoInfer<TInferredQueryFnData> | undefined\n >,\n options?: MaybeRefDeep<SetDataOptions>,\n ): NoInfer<TInferredQueryFnData> | undefined\n setQueryData<TQueryFnData, TData = NoUnknown<TQueryFnData>>(\n queryKey: MaybeRefDeep<QueryKey>,\n updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,\n options?: MaybeRefDeep<SetDataOptions>,\n ): NoInfer<TData> | undefined\n setQueryData<TData>(\n queryKey: MaybeRefDeep<QueryKey>,\n updater: Updater<TData | undefined, TData | undefined>,\n options: MaybeRefDeep<SetDataOptions> = {},\n ): NoInfer<TData> | undefined {\n return super.setQueryData<TData>(\n cloneDeepUnref(queryKey),\n updater,\n cloneDeepUnref(options),\n )\n }\n\n setQueriesData<TData>(\n filters: MaybeRefDeep<QueryFilters>,\n updater: Updater<TData | undefined, TData | undefined>,\n options: MaybeRefDeep<SetDataOptions> = {},\n ): Array<[QueryKey, TData | undefined]> {\n return super.setQueriesData(\n cloneDeepUnref(filters),\n updater,\n cloneDeepUnref(options),\n )\n }\n\n getQueryState<TData = unknown, TError = DefaultError>(\n queryKey: MaybeRefDeep<QueryKey>,\n ): QueryState<TData, TError> | undefined {\n return super.getQueryState(cloneDeepUnref(queryKey))\n }\n\n removeQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: QueryFilters<TTaggedQueryKey>,\n ): void\n removeQueries(filters: MaybeRefDeep<QueryFilters> = {}): void {\n return super.removeQueries(cloneDeepUnref(filters))\n }\n\n resetQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: QueryFilters<TTaggedQueryKey>,\n options?: MaybeRefDeep<ResetOptions>,\n ): Promise<void>\n resetQueries(\n filters: MaybeRefDeep<QueryFilters> = {},\n options: MaybeRefDeep<ResetOptions> = {},\n ): Promise<void> {\n return super.resetQueries(cloneDeepUnref(filters), cloneDeepUnref(options))\n }\n\n cancelQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: QueryFilters<TTaggedQueryKey>,\n options?: MaybeRefDeep<CancelOptions>,\n ): Promise<void>\n cancelQueries(\n filters: MaybeRefDeep<QueryFilters> = {},\n options: MaybeRefDeep<CancelOptions> = {},\n ): Promise<void> {\n return super.cancelQueries(cloneDeepUnref(filters), cloneDeepUnref(options))\n }\n\n invalidateQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?:\n | InvalidateQueryFilters<TTaggedQueryKey>\n | (() => InvalidateQueryFilters<TTaggedQueryKey>),\n options?: MaybeRefDeep<InvalidateOptions>,\n ): Promise<void>\n invalidateQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters:\n | MaybeRefDeep<InvalidateQueryFilters<TTaggedQueryKey>>\n | (() => InvalidateQueryFilters<TTaggedQueryKey>) = {},\n options: MaybeRefDeep<InvalidateOptions> | (() => InvalidateOptions) = {},\n ): Promise<void> {\n const filtersCloned = cloneDeepUnref(\n filters as MaybeRefDeep<InvalidateQueryFilters<TTaggedQueryKey>>,\n )\n const optionsCloned = cloneDeepUnref(\n options as MaybeRefDeep<InvalidateOptions>,\n )\n\n super.invalidateQueries(\n { ...filtersCloned, refetchType: 'none' },\n optionsCloned,\n )\n\n if (filtersCloned.refetchType === 'none') {\n return Promise.resolve()\n }\n\n const refetchFilters: RefetchQueryFilters<TTaggedQueryKey> = {\n ...filtersCloned,\n type: filtersCloned.refetchType ?? filtersCloned.type ?? 'active',\n }\n\n // (dosipiuk): We need to delay `refetchQueries` execution to next macro task for all reactive values to be updated.\n // This ensures that `context` in `queryFn` while `invalidating` along reactive variable change has correct\n return nextTick().then(() => {\n return super.refetchQueries(refetchFilters, optionsCloned)\n })\n }\n\n refetchQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: RefetchQueryFilters<TTaggedQueryKey>,\n options?: MaybeRefDeep<RefetchOptions>,\n ): Promise<void>\n refetchQueries(\n filters: MaybeRefDeep<RefetchQueryFilters> = {},\n options: MaybeRefDeep<RefetchOptions> = {},\n ): Promise<void> {\n return super.refetchQueries(\n cloneDeepUnref(filters),\n cloneDeepUnref(options),\n )\n }\n\n // These one-shot imperative methods do not resolve top-level option getters.\n // Resolve getters explicitly before calling, e.g. queryClient.query(options()).\n query<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: QueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<TData>\n query<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: MaybeRefDeep<\n QueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<TData>\n query<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: MaybeRefDeep<\n QueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<TData> {\n return super.query(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated Use queryClient.query(options) instead. This method will be removed in the next major version.\n */\n fetchQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: FetchQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<TData>\n fetchQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options:\n | MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>\n >\n | (() => FetchQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >),\n ): Promise<TData>\n fetchQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>\n >,\n ): Promise<TData> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.fetchQuery(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated Use queryClient.query(options) instead. You can swallow errors with `.catch(noop)`. This method will be removed in the next major version.\n */\n prefetchQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n ): Promise<void>\n prefetchQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<void>\n prefetchQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<void> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.prefetchQuery(cloneDeepUnref(options))\n }\n\n // These one-shot imperative methods do not resolve top-level option getters.\n // Resolve getters explicitly before calling, e.g. queryClient.infiniteQuery(options()).\n infiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: InfiniteQueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<\n Array<TData> extends Array<InfiniteData<TQueryFnData>>\n ? InfiniteData<TQueryFnData, TPageParam>\n : TData\n >\n infiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n InfiniteQueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<\n Array<TData> extends Array<InfiniteData<TQueryFnData>>\n ? InfiniteData<TQueryFnData, TPageParam>\n : TData\n >\n infiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n InfiniteQueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<\n Array<TData> extends Array<InfiniteData<TQueryFnData>>\n ? InfiniteData<TQueryFnData, TPageParam>\n : TData\n > {\n return super.infiniteQuery(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated Use queryClient.infiniteQuery(options) instead. This method will be removed in the next major version.\n */\n fetchInfiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<InfiniteData<TData, TPageParam>>\n fetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<InfiniteData<TData, TPageParam>>\n fetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<InfiniteData<TData, TPageParam>> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.fetchInfiniteQuery(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated use void queryClient.infiniteQuery(options) instead. You can swallow errors with `.catch(noop)`. This method will be removed in the next major version.\n */\n prefetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<void>\n prefetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<void>\n prefetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<void> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.prefetchInfiniteQuery(cloneDeepUnref(options))\n }\n\n setDefaultOptions(options: MaybeRefDeep<DefaultOptions>): void {\n super.setDefaultOptions(cloneDeepUnref(options))\n }\n\n setQueryDefaults<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n >(\n queryKey: MaybeRefDeep<QueryKey>,\n options: MaybeRefDeep<\n Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryData>, 'queryKey'>\n >,\n ): void {\n super.setQueryDefaults(cloneDeepUnref(queryKey), cloneDeepUnref(options))\n }\n\n getQueryDefaults(\n queryKey: MaybeRefDeep<QueryKey>,\n ): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'> {\n return super.getQueryDefaults(cloneDeepUnref(queryKey))\n }\n\n setMutationDefaults<\n TData = unknown,\n TError = DefaultError,\n TVariables = void,\n TOnMutateResult = unknown,\n >(\n mutationKey: MaybeRefDeep<MutationKey>,\n options: MaybeRefDeep<\n MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>\n >,\n ): void {\n super.setMutationDefaults(\n cloneDeepUnref(mutationKey),\n cloneDeepUnref(options),\n )\n }\n\n getMutationDefaults(\n mutationKey: MaybeRefDeep<MutationKey>,\n ): MutationObserverOptions<any, any, any, any> {\n return super.getMutationDefaults(cloneDeepUnref(mutationKey))\n }\n}\n"],"mappings":";;;;;;;;;;;;;;AA2CA,IAAa,cAAb,cAAiCA,qBAAAA,YAAG;CAClC,YAAY,SAA4B,CAAC,GAAG;EAC1C,MAAM,iBAAiB;GACrB,gBAAgB,OAAO;GACvB,YAAY,OAAO,cAAc,IAAIC,mBAAAA,WAAW;GAChD,eAAe,OAAO,iBAAiB,IAAIC,sBAAAA,cAAc;EAC3D;EACA,MAAM,cAAc;EAOtB,KAAA,eAAA,GAA6BC,SAAAA,IAAAA,CAAI,KAAK;CANtC;CAQA,WAAW,UAAsC,CAAC,GAAW;EAC3D,OAAO,MAAM,WAAWC,cAAAA,eAAe,OAAO,CAAC;CACjD;CAEA,WAAW,UAAyC,CAAC,GAAW;EAC9D,OAAO,MAAM,WAAWA,cAAAA,eAAe,OAAO,CAAC;CACjD;CAQA,aACE,UACmB;EACnB,OAAO,MAAM,aAAaA,cAAAA,eAAe,QAAQ,CAAC;CACpD;CAuBA,gBAME,SAGgB;EAEhB,OAAO,MAAM,gBAAgBA,cAAAA,eAAe,OAAO,CAAC;CACtD;CAEA,eACE,SACsC;EACtC,OAAO,MAAM,eAAeA,cAAAA,eAAe,OAAO,CAAC;CACrD;CAmBA,aACE,UACA,SACA,UAAwC,CAAC,GACb;EAC5B,OAAO,MAAM,aACXA,cAAAA,eAAe,QAAQ,GACvB,SACAA,cAAAA,eAAe,OAAO,CACxB;CACF;CAEA,eACE,SACA,SACA,UAAwC,CAAC,GACH;EACtC,OAAO,MAAM,eACXA,cAAAA,eAAe,OAAO,GACtB,SACAA,cAAAA,eAAe,OAAO,CACxB;CACF;CAEA,cACE,UACuC;EACvC,OAAO,MAAM,cAAcA,cAAAA,eAAe,QAAQ,CAAC;CACrD;CAKA,cAAc,UAAsC,CAAC,GAAS;EAC5D,OAAO,MAAM,cAAcA,cAAAA,eAAe,OAAO,CAAC;CACpD;CAMA,aACE,UAAsC,CAAC,GACvC,UAAsC,CAAC,GACxB;EACf,OAAO,MAAM,aAAaA,cAAAA,eAAe,OAAO,GAAGA,cAAAA,eAAe,OAAO,CAAC;CAC5E;CAMA,cACE,UAAsC,CAAC,GACvC,UAAuC,CAAC,GACzB;EACf,OAAO,MAAM,cAAcA,cAAAA,eAAe,OAAO,GAAGA,cAAAA,eAAe,OAAO,CAAC;CAC7E;CAQA,kBACE,UAEsD,CAAC,GACvD,UAAuE,CAAC,GACzD;EACf,MAAM,gBAAgBA,cAAAA,eACpB,OACF;EACA,MAAM,gBAAgBA,cAAAA,eACpB,OACF;EAEA,MAAM,kBACJ;GAAE,GAAG;GAAe,aAAa;EAAO,GACxC,aACF;EAEA,IAAI,cAAc,gBAAgB,QAChC,OAAO,QAAQ,QAAQ;EAGzB,MAAM,iBAAuD;GAC3D,GAAG;GACH,MAAM,cAAc,eAAe,cAAc,QAAQ;EAC3D;EAIA,QAAA,GAAOC,SAAAA,SAAAA,CAAS,CAAC,CAAC,WAAW;GAC3B,OAAO,MAAM,eAAe,gBAAgB,aAAa;EAC3D,CAAC;CACH;CAMA,eACE,UAA6C,CAAC,GAC9C,UAAwC,CAAC,GAC1B;EACf,OAAO,MAAM,eACXD,cAAAA,eAAe,OAAO,GACtBA,cAAAA,eAAe,OAAO,CACxB;CACF;CAwCA,MAQE,SAUgB;EAChB,OAAO,MAAM,MAAMA,cAAAA,eAAe,OAAO,CAAC;CAC5C;CAuCA,WAOE,SAGgB;EAEhB,OAAO,MAAM,WAAWA,cAAAA,eAAe,OAAO,CAAC;CACjD;CAuBA,cAME,SAGe;EAEf,OAAO,MAAM,cAAcA,cAAAA,eAAe,OAAO,CAAC;CACpD;CA4CA,cAOE,SAaA;EACA,OAAO,MAAM,cAAcA,cAAAA,eAAe,OAAO,CAAC;CACpD;CAqCA,mBAOE,SAS0C;EAE1C,OAAO,MAAM,mBAAmBA,cAAAA,eAAe,OAAO,CAAC;CACzD;CAqCA,sBAOE,SASe;EAEf,OAAO,MAAM,sBAAsBA,cAAAA,eAAe,OAAO,CAAC;CAC5D;CAEA,kBAAkB,SAA6C;EAC7D,MAAM,kBAAkBA,cAAAA,eAAe,OAAO,CAAC;CACjD;CAEA,iBAME,UACA,SAGM;EACN,MAAM,iBAAiBA,cAAAA,eAAe,QAAQ,GAAGA,cAAAA,eAAe,OAAO,CAAC;CAC1E;CAEA,iBACE,UACsE;EACtE,OAAO,MAAM,iBAAiBA,cAAAA,eAAe,QAAQ,CAAC;CACxD;CAEA,oBAME,aACA,SAGM;EACN,MAAM,oBACJA,cAAAA,eAAe,WAAW,GAC1BA,cAAAA,eAAe,OAAO,CACxB;CACF;CAEA,oBACE,aAC6C;EAC7C,OAAO,MAAM,oBAAoBA,cAAAA,eAAe,WAAW,CAAC;CAC9D;AACF"}
|
|
1
|
+
{"version":3,"file":"queryClient.cjs","names":["QC","QueryCache","MutationCache","ref","cloneDeepUnref","nextTick"],"sources":["../../src/queryClient.ts"],"sourcesContent":["import { nextTick, ref } from 'vue-demi'\nimport { QueryClient as QC } from '@tanstack/query-core'\nimport { cloneDeepUnref } from './utils'\nimport { QueryCache } from './queryCache'\nimport { MutationCache } from './mutationCache'\nimport type { UseQueryOptions } from './queryOptions'\nimport type { Ref } from 'vue-demi'\nimport type { MaybeRefDeep, NoUnknown, QueryClientConfig } from './types'\nimport type {\n CancelOptions,\n DefaultError,\n DefaultOptions,\n EnsureQueryDataOptions,\n FetchInfiniteQueryOptions,\n FetchQueryOptions,\n InferDataFromTag,\n InfiniteData,\n InfiniteQueryExecuteOptions,\n InvalidateOptions,\n InvalidateQueryFilters,\n MutationFilters,\n MutationKey,\n MutationObserverOptions,\n OmitKeyof,\n QueryExecuteOptions,\n QueryFilters,\n QueryKey,\n QueryObserverOptions,\n QueryState,\n RefetchOptions,\n RefetchQueryFilters,\n ResetOptions,\n SetDataOptions,\n Updater,\n} from '@tanstack/query-core'\n\n/**\n * Vue-aware subclass of `@tanstack/query-core`'s `QueryClient`. Methods that accept `options` (such as\n * `CancelOptions` or `InvalidateOptions`) or filters (such as the `QueryFilters` accepted by\n * `invalidateQueries`) also accept a {@link MaybeRefDeep} version of it, so you can pass `ref`s directly\n * without unwrapping them yourself — e.g. `queryClient.invalidateQueries({ queryKey: ['post', myRef] })`.\n *\n * `ref` entries in a `queryKey` are unwrapped this way on every method, but reactive getter entries\n * (`() => id.value`) are only unwrapped when the `queryKey` is passed as a `queryKey` property of a\n * filters/options object (e.g. `invalidateQueries({ queryKey: ['post', idGetter] })`) — methods like\n * `getQueryData` that take the `queryKey` array as their own argument do not unwrap getter entries there,\n * and the getter function itself ends up in the cache key.\n *\n * Install one on your app with `VueQueryPlugin`, or retrieve it with `useQueryClient`.\n */\nexport class QueryClient extends QC {\n constructor(config: QueryClientConfig = {}) {\n const vueQueryConfig = {\n defaultOptions: config.defaultOptions,\n queryCache: config.queryCache || new QueryCache(),\n mutationCache: config.mutationCache || new MutationCache(),\n }\n super(vueQueryConfig)\n }\n\n /**\n * `true` while a `clientPersister` passed to `VueQueryPlugin` is restoring the cache. Queries don't fetch\n * while this is `true`. Defaults to `false` if no persister is configured.\n */\n isRestoring?: Ref<boolean> = ref(false)\n\n isFetching(filters: MaybeRefDeep<QueryFilters> = {}): number {\n return super.isFetching(cloneDeepUnref(filters))\n }\n\n isMutating(filters: MaybeRefDeep<MutationFilters> = {}): number {\n return super.isMutating(cloneDeepUnref(filters))\n }\n\n getQueryData<TData = unknown, TTaggedQueryKey extends QueryKey = QueryKey>(\n queryKey: TTaggedQueryKey,\n ): InferDataFromTag<TData, TTaggedQueryKey> | undefined\n getQueryData<TData = unknown>(\n queryKey: MaybeRefDeep<QueryKey>,\n ): TData | undefined\n getQueryData<TData = unknown>(\n queryKey: MaybeRefDeep<QueryKey>,\n ): TData | undefined {\n return super.getQueryData(cloneDeepUnref(queryKey))\n }\n\n /**\n * @deprecated Use queryClient.query({ ...options, staleTime: 'static' }) instead. This method will be removed in the next major version.\n */\n ensureQueryData<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>,\n ): Promise<TData>\n ensureQueryData<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<TData>\n ensureQueryData<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<TData> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.ensureQueryData(cloneDeepUnref(options))\n }\n\n getQueriesData<TData = unknown>(\n filters: MaybeRefDeep<QueryFilters>,\n ): Array<[QueryKey, TData | undefined]> {\n return super.getQueriesData(cloneDeepUnref(filters))\n }\n\n setQueryData<\n TQueryFnData = unknown,\n TTaggedQueryKey extends QueryKey = QueryKey,\n TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>,\n >(\n queryKey: TTaggedQueryKey,\n updater: Updater<\n NoInfer<TInferredQueryFnData> | undefined,\n NoInfer<TInferredQueryFnData> | undefined\n >,\n options?: MaybeRefDeep<SetDataOptions>,\n ): NoInfer<TInferredQueryFnData> | undefined\n setQueryData<TQueryFnData, TData = NoUnknown<TQueryFnData>>(\n queryKey: MaybeRefDeep<QueryKey>,\n updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,\n options?: MaybeRefDeep<SetDataOptions>,\n ): NoInfer<TData> | undefined\n setQueryData<TData>(\n queryKey: MaybeRefDeep<QueryKey>,\n updater: Updater<TData | undefined, TData | undefined>,\n options: MaybeRefDeep<SetDataOptions> = {},\n ): NoInfer<TData> | undefined {\n return super.setQueryData<TData>(\n cloneDeepUnref(queryKey),\n updater,\n cloneDeepUnref(options),\n )\n }\n\n setQueriesData<TData>(\n filters: MaybeRefDeep<QueryFilters>,\n updater: Updater<TData | undefined, TData | undefined>,\n options: MaybeRefDeep<SetDataOptions> = {},\n ): Array<[QueryKey, TData | undefined]> {\n return super.setQueriesData(\n cloneDeepUnref(filters),\n updater,\n cloneDeepUnref(options),\n )\n }\n\n getQueryState<TData = unknown, TError = DefaultError>(\n queryKey: MaybeRefDeep<QueryKey>,\n ): QueryState<TData, TError> | undefined {\n return super.getQueryState(cloneDeepUnref(queryKey))\n }\n\n removeQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: QueryFilters<TTaggedQueryKey>,\n ): void\n removeQueries(filters: MaybeRefDeep<QueryFilters> = {}): void {\n return super.removeQueries(cloneDeepUnref(filters))\n }\n\n resetQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: QueryFilters<TTaggedQueryKey>,\n options?: MaybeRefDeep<ResetOptions>,\n ): Promise<void>\n resetQueries(\n filters: MaybeRefDeep<QueryFilters> = {},\n options: MaybeRefDeep<ResetOptions> = {},\n ): Promise<void> {\n return super.resetQueries(cloneDeepUnref(filters), cloneDeepUnref(options))\n }\n\n cancelQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: QueryFilters<TTaggedQueryKey>,\n options?: MaybeRefDeep<CancelOptions>,\n ): Promise<void>\n cancelQueries(\n filters: MaybeRefDeep<QueryFilters> = {},\n options: MaybeRefDeep<CancelOptions> = {},\n ): Promise<void> {\n return super.cancelQueries(cloneDeepUnref(filters), cloneDeepUnref(options))\n }\n\n invalidateQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?:\n | InvalidateQueryFilters<TTaggedQueryKey>\n | (() => InvalidateQueryFilters<TTaggedQueryKey>),\n options?: MaybeRefDeep<InvalidateOptions>,\n ): Promise<void>\n invalidateQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters:\n | MaybeRefDeep<InvalidateQueryFilters<TTaggedQueryKey>>\n | (() => InvalidateQueryFilters<TTaggedQueryKey>) = {},\n options: MaybeRefDeep<InvalidateOptions> | (() => InvalidateOptions) = {},\n ): Promise<void> {\n const filtersCloned = cloneDeepUnref(\n filters as MaybeRefDeep<InvalidateQueryFilters<TTaggedQueryKey>>,\n )\n const optionsCloned = cloneDeepUnref(\n options as MaybeRefDeep<InvalidateOptions>,\n )\n\n super.invalidateQueries(\n { ...filtersCloned, refetchType: 'none' },\n optionsCloned,\n )\n\n if (filtersCloned.refetchType === 'none') {\n return Promise.resolve()\n }\n\n const refetchFilters: RefetchQueryFilters<TTaggedQueryKey> = {\n ...filtersCloned,\n type: filtersCloned.refetchType ?? filtersCloned.type ?? 'active',\n }\n\n // (dosipiuk): We need to delay `refetchQueries` execution to next macro task for all reactive values to be updated.\n // This ensures that `context` in `queryFn` while `invalidating` along reactive variable change has correct\n return nextTick().then(() => {\n return super.refetchQueries(refetchFilters, optionsCloned)\n })\n }\n\n refetchQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: RefetchQueryFilters<TTaggedQueryKey>,\n options?: MaybeRefDeep<RefetchOptions>,\n ): Promise<void>\n refetchQueries(\n filters: MaybeRefDeep<RefetchQueryFilters> = {},\n options: MaybeRefDeep<RefetchOptions> = {},\n ): Promise<void> {\n return super.refetchQueries(\n cloneDeepUnref(filters),\n cloneDeepUnref(options),\n )\n }\n\n // These one-shot imperative methods do not resolve top-level option getters.\n // Resolve getters explicitly before calling, e.g. queryClient.query(options()).\n query<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: QueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<TData>\n query<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: MaybeRefDeep<\n QueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<TData>\n query<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: MaybeRefDeep<\n QueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<TData> {\n return super.query(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated Use queryClient.query(options) instead. This method will be removed in the next major version.\n */\n fetchQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: FetchQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<TData>\n fetchQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options:\n | MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>\n >\n | (() => FetchQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >),\n ): Promise<TData>\n fetchQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>\n >,\n ): Promise<TData> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.fetchQuery(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated Use queryClient.query(options) instead. You can swallow errors with `.catch(noop)`. This method will be removed in the next major version.\n */\n prefetchQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n ): Promise<void>\n prefetchQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<void>\n prefetchQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<void> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.prefetchQuery(cloneDeepUnref(options))\n }\n\n // These one-shot imperative methods do not resolve top-level option getters.\n // Resolve getters explicitly before calling, e.g. queryClient.infiniteQuery(options()).\n infiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: InfiniteQueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<\n Array<TData> extends Array<InfiniteData<TQueryFnData>>\n ? InfiniteData<TQueryFnData, TPageParam>\n : TData\n >\n infiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n InfiniteQueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<\n Array<TData> extends Array<InfiniteData<TQueryFnData>>\n ? InfiniteData<TQueryFnData, TPageParam>\n : TData\n >\n infiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n InfiniteQueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<\n Array<TData> extends Array<InfiniteData<TQueryFnData>>\n ? InfiniteData<TQueryFnData, TPageParam>\n : TData\n > {\n return super.infiniteQuery(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated Use queryClient.infiniteQuery(options) instead. This method will be removed in the next major version.\n */\n fetchInfiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<InfiniteData<TData, TPageParam>>\n fetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<InfiniteData<TData, TPageParam>>\n fetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<InfiniteData<TData, TPageParam>> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.fetchInfiniteQuery(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated use void queryClient.infiniteQuery(options) instead. You can swallow errors with `.catch(noop)`. This method will be removed in the next major version.\n */\n prefetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<void>\n prefetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<void>\n prefetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<void> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.prefetchInfiniteQuery(cloneDeepUnref(options))\n }\n\n setDefaultOptions(options: MaybeRefDeep<DefaultOptions>): void {\n super.setDefaultOptions(cloneDeepUnref(options))\n }\n\n setQueryDefaults<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n >(\n queryKey: MaybeRefDeep<QueryKey>,\n options: MaybeRefDeep<\n Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryData>, 'queryKey'>\n >,\n ): void {\n super.setQueryDefaults(cloneDeepUnref(queryKey), cloneDeepUnref(options))\n }\n\n getQueryDefaults(\n queryKey: MaybeRefDeep<QueryKey>,\n ): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'> {\n return super.getQueryDefaults(cloneDeepUnref(queryKey))\n }\n\n setMutationDefaults<\n TData = unknown,\n TError = DefaultError,\n TVariables = void,\n TOnMutateResult = unknown,\n >(\n mutationKey: MaybeRefDeep<MutationKey>,\n options: MaybeRefDeep<\n MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>\n >,\n ): void {\n super.setMutationDefaults(\n cloneDeepUnref(mutationKey),\n cloneDeepUnref(options),\n )\n }\n\n getMutationDefaults(\n mutationKey: MaybeRefDeep<MutationKey>,\n ): MutationObserverOptions<any, any, any, any> {\n return super.getMutationDefaults(cloneDeepUnref(mutationKey))\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAkDA,IAAa,cAAb,cAAiCA,qBAAAA,YAAG;CAClC,YAAY,SAA4B,CAAC,GAAG;EAC1C,MAAM,iBAAiB;GACrB,gBAAgB,OAAO;GACvB,YAAY,OAAO,cAAc,IAAIC,mBAAAA,WAAW;GAChD,eAAe,OAAO,iBAAiB,IAAIC,sBAAAA,cAAc;EAC3D;EACA,MAAM,cAAc;EAOtB,KAAA,eAAA,GAA6BC,SAAAA,IAAAA,CAAI,KAAK;CANtC;CAQA,WAAW,UAAsC,CAAC,GAAW;EAC3D,OAAO,MAAM,WAAWC,cAAAA,eAAe,OAAO,CAAC;CACjD;CAEA,WAAW,UAAyC,CAAC,GAAW;EAC9D,OAAO,MAAM,WAAWA,cAAAA,eAAe,OAAO,CAAC;CACjD;CAQA,aACE,UACmB;EACnB,OAAO,MAAM,aAAaA,cAAAA,eAAe,QAAQ,CAAC;CACpD;CAuBA,gBAME,SAGgB;EAEhB,OAAO,MAAM,gBAAgBA,cAAAA,eAAe,OAAO,CAAC;CACtD;CAEA,eACE,SACsC;EACtC,OAAO,MAAM,eAAeA,cAAAA,eAAe,OAAO,CAAC;CACrD;CAmBA,aACE,UACA,SACA,UAAwC,CAAC,GACb;EAC5B,OAAO,MAAM,aACXA,cAAAA,eAAe,QAAQ,GACvB,SACAA,cAAAA,eAAe,OAAO,CACxB;CACF;CAEA,eACE,SACA,SACA,UAAwC,CAAC,GACH;EACtC,OAAO,MAAM,eACXA,cAAAA,eAAe,OAAO,GACtB,SACAA,cAAAA,eAAe,OAAO,CACxB;CACF;CAEA,cACE,UACuC;EACvC,OAAO,MAAM,cAAcA,cAAAA,eAAe,QAAQ,CAAC;CACrD;CAKA,cAAc,UAAsC,CAAC,GAAS;EAC5D,OAAO,MAAM,cAAcA,cAAAA,eAAe,OAAO,CAAC;CACpD;CAMA,aACE,UAAsC,CAAC,GACvC,UAAsC,CAAC,GACxB;EACf,OAAO,MAAM,aAAaA,cAAAA,eAAe,OAAO,GAAGA,cAAAA,eAAe,OAAO,CAAC;CAC5E;CAMA,cACE,UAAsC,CAAC,GACvC,UAAuC,CAAC,GACzB;EACf,OAAO,MAAM,cAAcA,cAAAA,eAAe,OAAO,GAAGA,cAAAA,eAAe,OAAO,CAAC;CAC7E;CAQA,kBACE,UAEsD,CAAC,GACvD,UAAuE,CAAC,GACzD;EACf,MAAM,gBAAgBA,cAAAA,eACpB,OACF;EACA,MAAM,gBAAgBA,cAAAA,eACpB,OACF;EAEA,MAAM,kBACJ;GAAE,GAAG;GAAe,aAAa;EAAO,GACxC,aACF;EAEA,IAAI,cAAc,gBAAgB,QAChC,OAAO,QAAQ,QAAQ;EAGzB,MAAM,iBAAuD;GAC3D,GAAG;GACH,MAAM,cAAc,eAAe,cAAc,QAAQ;EAC3D;EAIA,QAAA,GAAOC,SAAAA,SAAAA,CAAS,CAAC,CAAC,WAAW;GAC3B,OAAO,MAAM,eAAe,gBAAgB,aAAa;EAC3D,CAAC;CACH;CAMA,eACE,UAA6C,CAAC,GAC9C,UAAwC,CAAC,GAC1B;EACf,OAAO,MAAM,eACXD,cAAAA,eAAe,OAAO,GACtBA,cAAAA,eAAe,OAAO,CACxB;CACF;CAwCA,MAQE,SAUgB;EAChB,OAAO,MAAM,MAAMA,cAAAA,eAAe,OAAO,CAAC;CAC5C;CAuCA,WAOE,SAGgB;EAEhB,OAAO,MAAM,WAAWA,cAAAA,eAAe,OAAO,CAAC;CACjD;CAuBA,cAME,SAGe;EAEf,OAAO,MAAM,cAAcA,cAAAA,eAAe,OAAO,CAAC;CACpD;CA4CA,cAOE,SAaA;EACA,OAAO,MAAM,cAAcA,cAAAA,eAAe,OAAO,CAAC;CACpD;CAqCA,mBAOE,SAS0C;EAE1C,OAAO,MAAM,mBAAmBA,cAAAA,eAAe,OAAO,CAAC;CACzD;CAqCA,sBAOE,SASe;EAEf,OAAO,MAAM,sBAAsBA,cAAAA,eAAe,OAAO,CAAC;CAC5D;CAEA,kBAAkB,SAA6C;EAC7D,MAAM,kBAAkBA,cAAAA,eAAe,OAAO,CAAC;CACjD;CAEA,iBAME,UACA,SAGM;EACN,MAAM,iBAAiBA,cAAAA,eAAe,QAAQ,GAAGA,cAAAA,eAAe,OAAO,CAAC;CAC1E;CAEA,iBACE,UACsE;EACtE,OAAO,MAAM,iBAAiBA,cAAAA,eAAe,QAAQ,CAAC;CACxD;CAEA,oBAME,aACA,SAGM;EACN,MAAM,oBACJA,cAAAA,eAAe,WAAW,GAC1BA,cAAAA,eAAe,OAAO,CACxB;CACF;CAEA,oBACE,aAC6C;EAC7C,OAAO,MAAM,oBAAoBA,cAAAA,eAAe,WAAW,CAAC;CAC9D;AACF"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { t as QueryClient } from "./queryClient-
|
|
1
|
+
import { t as QueryClient } from "./queryClient-Bn2Ql_Lu.cjs";
|
|
2
2
|
export { QueryClient };
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { t as QueryClient } from "./queryClient-
|
|
1
|
+
import { t as QueryClient } from "./queryClient-B6mLtXOj.js";
|
|
2
2
|
export { QueryClient };
|
|
@@ -9,6 +9,13 @@ import { nextTick, ref } from "vue-demi";
|
|
|
9
9
|
* `CancelOptions` or `InvalidateOptions`) or filters (such as the `QueryFilters` accepted by
|
|
10
10
|
* `invalidateQueries`) also accept a {@link MaybeRefDeep} version of it, so you can pass `ref`s directly
|
|
11
11
|
* without unwrapping them yourself — e.g. `queryClient.invalidateQueries({ queryKey: ['post', myRef] })`.
|
|
12
|
+
*
|
|
13
|
+
* `ref` entries in a `queryKey` are unwrapped this way on every method, but reactive getter entries
|
|
14
|
+
* (`() => id.value`) are only unwrapped when the `queryKey` is passed as a `queryKey` property of a
|
|
15
|
+
* filters/options object (e.g. `invalidateQueries({ queryKey: ['post', idGetter] })`) — methods like
|
|
16
|
+
* `getQueryData` that take the `queryKey` array as their own argument do not unwrap getter entries there,
|
|
17
|
+
* and the getter function itself ends up in the cache key.
|
|
18
|
+
*
|
|
12
19
|
* Install one on your app with `VueQueryPlugin`, or retrieve it with `useQueryClient`.
|
|
13
20
|
*/
|
|
14
21
|
var QueryClient = class extends QueryClient$1 {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"queryClient.js","names":["QC","QueryCache","MutationCache"],"sources":["../../src/queryClient.ts"],"sourcesContent":["import { nextTick, ref } from 'vue-demi'\nimport { QueryClient as QC } from '@tanstack/query-core'\nimport { cloneDeepUnref } from './utils'\nimport { QueryCache } from './queryCache'\nimport { MutationCache } from './mutationCache'\nimport type { UseQueryOptions } from './queryOptions'\nimport type { Ref } from 'vue-demi'\nimport type { MaybeRefDeep, NoUnknown, QueryClientConfig } from './types'\nimport type {\n CancelOptions,\n DefaultError,\n DefaultOptions,\n EnsureQueryDataOptions,\n FetchInfiniteQueryOptions,\n FetchQueryOptions,\n InferDataFromTag,\n InfiniteData,\n InfiniteQueryExecuteOptions,\n InvalidateOptions,\n InvalidateQueryFilters,\n MutationFilters,\n MutationKey,\n MutationObserverOptions,\n OmitKeyof,\n QueryExecuteOptions,\n QueryFilters,\n QueryKey,\n QueryObserverOptions,\n QueryState,\n RefetchOptions,\n RefetchQueryFilters,\n ResetOptions,\n SetDataOptions,\n Updater,\n} from '@tanstack/query-core'\n\n/**\n * Vue-aware subclass of `@tanstack/query-core`'s `QueryClient`. Methods that accept `options` (such as\n * `CancelOptions` or `InvalidateOptions`) or filters (such as the `QueryFilters` accepted by\n * `invalidateQueries`) also accept a {@link MaybeRefDeep} version of it, so you can pass `ref`s directly\n * without unwrapping them yourself — e.g. `queryClient.invalidateQueries({ queryKey: ['post', myRef] })`.\n * Install one on your app with `VueQueryPlugin`, or retrieve it with `useQueryClient`.\n */\nexport class QueryClient extends QC {\n constructor(config: QueryClientConfig = {}) {\n const vueQueryConfig = {\n defaultOptions: config.defaultOptions,\n queryCache: config.queryCache || new QueryCache(),\n mutationCache: config.mutationCache || new MutationCache(),\n }\n super(vueQueryConfig)\n }\n\n /**\n * `true` while a `clientPersister` passed to `VueQueryPlugin` is restoring the cache. Queries don't fetch\n * while this is `true`. Defaults to `false` if no persister is configured.\n */\n isRestoring?: Ref<boolean> = ref(false)\n\n isFetching(filters: MaybeRefDeep<QueryFilters> = {}): number {\n return super.isFetching(cloneDeepUnref(filters))\n }\n\n isMutating(filters: MaybeRefDeep<MutationFilters> = {}): number {\n return super.isMutating(cloneDeepUnref(filters))\n }\n\n getQueryData<TData = unknown, TTaggedQueryKey extends QueryKey = QueryKey>(\n queryKey: TTaggedQueryKey,\n ): InferDataFromTag<TData, TTaggedQueryKey> | undefined\n getQueryData<TData = unknown>(\n queryKey: MaybeRefDeep<QueryKey>,\n ): TData | undefined\n getQueryData<TData = unknown>(\n queryKey: MaybeRefDeep<QueryKey>,\n ): TData | undefined {\n return super.getQueryData(cloneDeepUnref(queryKey))\n }\n\n /**\n * @deprecated Use queryClient.query({ ...options, staleTime: 'static' }) instead. This method will be removed in the next major version.\n */\n ensureQueryData<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>,\n ): Promise<TData>\n ensureQueryData<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<TData>\n ensureQueryData<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<TData> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.ensureQueryData(cloneDeepUnref(options))\n }\n\n getQueriesData<TData = unknown>(\n filters: MaybeRefDeep<QueryFilters>,\n ): Array<[QueryKey, TData | undefined]> {\n return super.getQueriesData(cloneDeepUnref(filters))\n }\n\n setQueryData<\n TQueryFnData = unknown,\n TTaggedQueryKey extends QueryKey = QueryKey,\n TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>,\n >(\n queryKey: TTaggedQueryKey,\n updater: Updater<\n NoInfer<TInferredQueryFnData> | undefined,\n NoInfer<TInferredQueryFnData> | undefined\n >,\n options?: MaybeRefDeep<SetDataOptions>,\n ): NoInfer<TInferredQueryFnData> | undefined\n setQueryData<TQueryFnData, TData = NoUnknown<TQueryFnData>>(\n queryKey: MaybeRefDeep<QueryKey>,\n updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,\n options?: MaybeRefDeep<SetDataOptions>,\n ): NoInfer<TData> | undefined\n setQueryData<TData>(\n queryKey: MaybeRefDeep<QueryKey>,\n updater: Updater<TData | undefined, TData | undefined>,\n options: MaybeRefDeep<SetDataOptions> = {},\n ): NoInfer<TData> | undefined {\n return super.setQueryData<TData>(\n cloneDeepUnref(queryKey),\n updater,\n cloneDeepUnref(options),\n )\n }\n\n setQueriesData<TData>(\n filters: MaybeRefDeep<QueryFilters>,\n updater: Updater<TData | undefined, TData | undefined>,\n options: MaybeRefDeep<SetDataOptions> = {},\n ): Array<[QueryKey, TData | undefined]> {\n return super.setQueriesData(\n cloneDeepUnref(filters),\n updater,\n cloneDeepUnref(options),\n )\n }\n\n getQueryState<TData = unknown, TError = DefaultError>(\n queryKey: MaybeRefDeep<QueryKey>,\n ): QueryState<TData, TError> | undefined {\n return super.getQueryState(cloneDeepUnref(queryKey))\n }\n\n removeQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: QueryFilters<TTaggedQueryKey>,\n ): void\n removeQueries(filters: MaybeRefDeep<QueryFilters> = {}): void {\n return super.removeQueries(cloneDeepUnref(filters))\n }\n\n resetQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: QueryFilters<TTaggedQueryKey>,\n options?: MaybeRefDeep<ResetOptions>,\n ): Promise<void>\n resetQueries(\n filters: MaybeRefDeep<QueryFilters> = {},\n options: MaybeRefDeep<ResetOptions> = {},\n ): Promise<void> {\n return super.resetQueries(cloneDeepUnref(filters), cloneDeepUnref(options))\n }\n\n cancelQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: QueryFilters<TTaggedQueryKey>,\n options?: MaybeRefDeep<CancelOptions>,\n ): Promise<void>\n cancelQueries(\n filters: MaybeRefDeep<QueryFilters> = {},\n options: MaybeRefDeep<CancelOptions> = {},\n ): Promise<void> {\n return super.cancelQueries(cloneDeepUnref(filters), cloneDeepUnref(options))\n }\n\n invalidateQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?:\n | InvalidateQueryFilters<TTaggedQueryKey>\n | (() => InvalidateQueryFilters<TTaggedQueryKey>),\n options?: MaybeRefDeep<InvalidateOptions>,\n ): Promise<void>\n invalidateQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters:\n | MaybeRefDeep<InvalidateQueryFilters<TTaggedQueryKey>>\n | (() => InvalidateQueryFilters<TTaggedQueryKey>) = {},\n options: MaybeRefDeep<InvalidateOptions> | (() => InvalidateOptions) = {},\n ): Promise<void> {\n const filtersCloned = cloneDeepUnref(\n filters as MaybeRefDeep<InvalidateQueryFilters<TTaggedQueryKey>>,\n )\n const optionsCloned = cloneDeepUnref(\n options as MaybeRefDeep<InvalidateOptions>,\n )\n\n super.invalidateQueries(\n { ...filtersCloned, refetchType: 'none' },\n optionsCloned,\n )\n\n if (filtersCloned.refetchType === 'none') {\n return Promise.resolve()\n }\n\n const refetchFilters: RefetchQueryFilters<TTaggedQueryKey> = {\n ...filtersCloned,\n type: filtersCloned.refetchType ?? filtersCloned.type ?? 'active',\n }\n\n // (dosipiuk): We need to delay `refetchQueries` execution to next macro task for all reactive values to be updated.\n // This ensures that `context` in `queryFn` while `invalidating` along reactive variable change has correct\n return nextTick().then(() => {\n return super.refetchQueries(refetchFilters, optionsCloned)\n })\n }\n\n refetchQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: RefetchQueryFilters<TTaggedQueryKey>,\n options?: MaybeRefDeep<RefetchOptions>,\n ): Promise<void>\n refetchQueries(\n filters: MaybeRefDeep<RefetchQueryFilters> = {},\n options: MaybeRefDeep<RefetchOptions> = {},\n ): Promise<void> {\n return super.refetchQueries(\n cloneDeepUnref(filters),\n cloneDeepUnref(options),\n )\n }\n\n // These one-shot imperative methods do not resolve top-level option getters.\n // Resolve getters explicitly before calling, e.g. queryClient.query(options()).\n query<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: QueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<TData>\n query<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: MaybeRefDeep<\n QueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<TData>\n query<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: MaybeRefDeep<\n QueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<TData> {\n return super.query(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated Use queryClient.query(options) instead. This method will be removed in the next major version.\n */\n fetchQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: FetchQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<TData>\n fetchQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options:\n | MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>\n >\n | (() => FetchQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >),\n ): Promise<TData>\n fetchQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>\n >,\n ): Promise<TData> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.fetchQuery(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated Use queryClient.query(options) instead. You can swallow errors with `.catch(noop)`. This method will be removed in the next major version.\n */\n prefetchQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n ): Promise<void>\n prefetchQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<void>\n prefetchQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<void> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.prefetchQuery(cloneDeepUnref(options))\n }\n\n // These one-shot imperative methods do not resolve top-level option getters.\n // Resolve getters explicitly before calling, e.g. queryClient.infiniteQuery(options()).\n infiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: InfiniteQueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<\n Array<TData> extends Array<InfiniteData<TQueryFnData>>\n ? InfiniteData<TQueryFnData, TPageParam>\n : TData\n >\n infiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n InfiniteQueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<\n Array<TData> extends Array<InfiniteData<TQueryFnData>>\n ? InfiniteData<TQueryFnData, TPageParam>\n : TData\n >\n infiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n InfiniteQueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<\n Array<TData> extends Array<InfiniteData<TQueryFnData>>\n ? InfiniteData<TQueryFnData, TPageParam>\n : TData\n > {\n return super.infiniteQuery(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated Use queryClient.infiniteQuery(options) instead. This method will be removed in the next major version.\n */\n fetchInfiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<InfiniteData<TData, TPageParam>>\n fetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<InfiniteData<TData, TPageParam>>\n fetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<InfiniteData<TData, TPageParam>> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.fetchInfiniteQuery(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated use void queryClient.infiniteQuery(options) instead. You can swallow errors with `.catch(noop)`. This method will be removed in the next major version.\n */\n prefetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<void>\n prefetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<void>\n prefetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<void> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.prefetchInfiniteQuery(cloneDeepUnref(options))\n }\n\n setDefaultOptions(options: MaybeRefDeep<DefaultOptions>): void {\n super.setDefaultOptions(cloneDeepUnref(options))\n }\n\n setQueryDefaults<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n >(\n queryKey: MaybeRefDeep<QueryKey>,\n options: MaybeRefDeep<\n Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryData>, 'queryKey'>\n >,\n ): void {\n super.setQueryDefaults(cloneDeepUnref(queryKey), cloneDeepUnref(options))\n }\n\n getQueryDefaults(\n queryKey: MaybeRefDeep<QueryKey>,\n ): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'> {\n return super.getQueryDefaults(cloneDeepUnref(queryKey))\n }\n\n setMutationDefaults<\n TData = unknown,\n TError = DefaultError,\n TVariables = void,\n TOnMutateResult = unknown,\n >(\n mutationKey: MaybeRefDeep<MutationKey>,\n options: MaybeRefDeep<\n MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>\n >,\n ): void {\n super.setMutationDefaults(\n cloneDeepUnref(mutationKey),\n cloneDeepUnref(options),\n )\n }\n\n getMutationDefaults(\n mutationKey: MaybeRefDeep<MutationKey>,\n ): MutationObserverOptions<any, any, any, any> {\n return super.getMutationDefaults(cloneDeepUnref(mutationKey))\n }\n}\n"],"mappings":";;;;;;;;;;;;;AA2CA,IAAa,cAAb,cAAiCA,cAAG;CAClC,YAAY,SAA4B,CAAC,GAAG;EAC1C,MAAM,iBAAiB;GACrB,gBAAgB,OAAO;GACvB,YAAY,OAAO,cAAc,IAAIC,aAAW;GAChD,eAAe,OAAO,iBAAiB,IAAIC,gBAAc;EAC3D;EACA,MAAM,cAAc;EAOtB,KAAA,cAA6B,IAAI,KAAK;CANtC;CAQA,WAAW,UAAsC,CAAC,GAAW;EAC3D,OAAO,MAAM,WAAW,eAAe,OAAO,CAAC;CACjD;CAEA,WAAW,UAAyC,CAAC,GAAW;EAC9D,OAAO,MAAM,WAAW,eAAe,OAAO,CAAC;CACjD;CAQA,aACE,UACmB;EACnB,OAAO,MAAM,aAAa,eAAe,QAAQ,CAAC;CACpD;CAuBA,gBAME,SAGgB;EAEhB,OAAO,MAAM,gBAAgB,eAAe,OAAO,CAAC;CACtD;CAEA,eACE,SACsC;EACtC,OAAO,MAAM,eAAe,eAAe,OAAO,CAAC;CACrD;CAmBA,aACE,UACA,SACA,UAAwC,CAAC,GACb;EAC5B,OAAO,MAAM,aACX,eAAe,QAAQ,GACvB,SACA,eAAe,OAAO,CACxB;CACF;CAEA,eACE,SACA,SACA,UAAwC,CAAC,GACH;EACtC,OAAO,MAAM,eACX,eAAe,OAAO,GACtB,SACA,eAAe,OAAO,CACxB;CACF;CAEA,cACE,UACuC;EACvC,OAAO,MAAM,cAAc,eAAe,QAAQ,CAAC;CACrD;CAKA,cAAc,UAAsC,CAAC,GAAS;EAC5D,OAAO,MAAM,cAAc,eAAe,OAAO,CAAC;CACpD;CAMA,aACE,UAAsC,CAAC,GACvC,UAAsC,CAAC,GACxB;EACf,OAAO,MAAM,aAAa,eAAe,OAAO,GAAG,eAAe,OAAO,CAAC;CAC5E;CAMA,cACE,UAAsC,CAAC,GACvC,UAAuC,CAAC,GACzB;EACf,OAAO,MAAM,cAAc,eAAe,OAAO,GAAG,eAAe,OAAO,CAAC;CAC7E;CAQA,kBACE,UAEsD,CAAC,GACvD,UAAuE,CAAC,GACzD;EACf,MAAM,gBAAgB,eACpB,OACF;EACA,MAAM,gBAAgB,eACpB,OACF;EAEA,MAAM,kBACJ;GAAE,GAAG;GAAe,aAAa;EAAO,GACxC,aACF;EAEA,IAAI,cAAc,gBAAgB,QAChC,OAAO,QAAQ,QAAQ;EAGzB,MAAM,iBAAuD;GAC3D,GAAG;GACH,MAAM,cAAc,eAAe,cAAc,QAAQ;EAC3D;EAIA,OAAO,SAAS,CAAC,CAAC,WAAW;GAC3B,OAAO,MAAM,eAAe,gBAAgB,aAAa;EAC3D,CAAC;CACH;CAMA,eACE,UAA6C,CAAC,GAC9C,UAAwC,CAAC,GAC1B;EACf,OAAO,MAAM,eACX,eAAe,OAAO,GACtB,eAAe,OAAO,CACxB;CACF;CAwCA,MAQE,SAUgB;EAChB,OAAO,MAAM,MAAM,eAAe,OAAO,CAAC;CAC5C;CAuCA,WAOE,SAGgB;EAEhB,OAAO,MAAM,WAAW,eAAe,OAAO,CAAC;CACjD;CAuBA,cAME,SAGe;EAEf,OAAO,MAAM,cAAc,eAAe,OAAO,CAAC;CACpD;CA4CA,cAOE,SAaA;EACA,OAAO,MAAM,cAAc,eAAe,OAAO,CAAC;CACpD;CAqCA,mBAOE,SAS0C;EAE1C,OAAO,MAAM,mBAAmB,eAAe,OAAO,CAAC;CACzD;CAqCA,sBAOE,SASe;EAEf,OAAO,MAAM,sBAAsB,eAAe,OAAO,CAAC;CAC5D;CAEA,kBAAkB,SAA6C;EAC7D,MAAM,kBAAkB,eAAe,OAAO,CAAC;CACjD;CAEA,iBAME,UACA,SAGM;EACN,MAAM,iBAAiB,eAAe,QAAQ,GAAG,eAAe,OAAO,CAAC;CAC1E;CAEA,iBACE,UACsE;EACtE,OAAO,MAAM,iBAAiB,eAAe,QAAQ,CAAC;CACxD;CAEA,oBAME,aACA,SAGM;EACN,MAAM,oBACJ,eAAe,WAAW,GAC1B,eAAe,OAAO,CACxB;CACF;CAEA,oBACE,aAC6C;EAC7C,OAAO,MAAM,oBAAoB,eAAe,WAAW,CAAC;CAC9D;AACF"}
|
|
1
|
+
{"version":3,"file":"queryClient.js","names":["QC","QueryCache","MutationCache"],"sources":["../../src/queryClient.ts"],"sourcesContent":["import { nextTick, ref } from 'vue-demi'\nimport { QueryClient as QC } from '@tanstack/query-core'\nimport { cloneDeepUnref } from './utils'\nimport { QueryCache } from './queryCache'\nimport { MutationCache } from './mutationCache'\nimport type { UseQueryOptions } from './queryOptions'\nimport type { Ref } from 'vue-demi'\nimport type { MaybeRefDeep, NoUnknown, QueryClientConfig } from './types'\nimport type {\n CancelOptions,\n DefaultError,\n DefaultOptions,\n EnsureQueryDataOptions,\n FetchInfiniteQueryOptions,\n FetchQueryOptions,\n InferDataFromTag,\n InfiniteData,\n InfiniteQueryExecuteOptions,\n InvalidateOptions,\n InvalidateQueryFilters,\n MutationFilters,\n MutationKey,\n MutationObserverOptions,\n OmitKeyof,\n QueryExecuteOptions,\n QueryFilters,\n QueryKey,\n QueryObserverOptions,\n QueryState,\n RefetchOptions,\n RefetchQueryFilters,\n ResetOptions,\n SetDataOptions,\n Updater,\n} from '@tanstack/query-core'\n\n/**\n * Vue-aware subclass of `@tanstack/query-core`'s `QueryClient`. Methods that accept `options` (such as\n * `CancelOptions` or `InvalidateOptions`) or filters (such as the `QueryFilters` accepted by\n * `invalidateQueries`) also accept a {@link MaybeRefDeep} version of it, so you can pass `ref`s directly\n * without unwrapping them yourself — e.g. `queryClient.invalidateQueries({ queryKey: ['post', myRef] })`.\n *\n * `ref` entries in a `queryKey` are unwrapped this way on every method, but reactive getter entries\n * (`() => id.value`) are only unwrapped when the `queryKey` is passed as a `queryKey` property of a\n * filters/options object (e.g. `invalidateQueries({ queryKey: ['post', idGetter] })`) — methods like\n * `getQueryData` that take the `queryKey` array as their own argument do not unwrap getter entries there,\n * and the getter function itself ends up in the cache key.\n *\n * Install one on your app with `VueQueryPlugin`, or retrieve it with `useQueryClient`.\n */\nexport class QueryClient extends QC {\n constructor(config: QueryClientConfig = {}) {\n const vueQueryConfig = {\n defaultOptions: config.defaultOptions,\n queryCache: config.queryCache || new QueryCache(),\n mutationCache: config.mutationCache || new MutationCache(),\n }\n super(vueQueryConfig)\n }\n\n /**\n * `true` while a `clientPersister` passed to `VueQueryPlugin` is restoring the cache. Queries don't fetch\n * while this is `true`. Defaults to `false` if no persister is configured.\n */\n isRestoring?: Ref<boolean> = ref(false)\n\n isFetching(filters: MaybeRefDeep<QueryFilters> = {}): number {\n return super.isFetching(cloneDeepUnref(filters))\n }\n\n isMutating(filters: MaybeRefDeep<MutationFilters> = {}): number {\n return super.isMutating(cloneDeepUnref(filters))\n }\n\n getQueryData<TData = unknown, TTaggedQueryKey extends QueryKey = QueryKey>(\n queryKey: TTaggedQueryKey,\n ): InferDataFromTag<TData, TTaggedQueryKey> | undefined\n getQueryData<TData = unknown>(\n queryKey: MaybeRefDeep<QueryKey>,\n ): TData | undefined\n getQueryData<TData = unknown>(\n queryKey: MaybeRefDeep<QueryKey>,\n ): TData | undefined {\n return super.getQueryData(cloneDeepUnref(queryKey))\n }\n\n /**\n * @deprecated Use queryClient.query({ ...options, staleTime: 'static' }) instead. This method will be removed in the next major version.\n */\n ensureQueryData<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>,\n ): Promise<TData>\n ensureQueryData<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<TData>\n ensureQueryData<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<TData> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.ensureQueryData(cloneDeepUnref(options))\n }\n\n getQueriesData<TData = unknown>(\n filters: MaybeRefDeep<QueryFilters>,\n ): Array<[QueryKey, TData | undefined]> {\n return super.getQueriesData(cloneDeepUnref(filters))\n }\n\n setQueryData<\n TQueryFnData = unknown,\n TTaggedQueryKey extends QueryKey = QueryKey,\n TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>,\n >(\n queryKey: TTaggedQueryKey,\n updater: Updater<\n NoInfer<TInferredQueryFnData> | undefined,\n NoInfer<TInferredQueryFnData> | undefined\n >,\n options?: MaybeRefDeep<SetDataOptions>,\n ): NoInfer<TInferredQueryFnData> | undefined\n setQueryData<TQueryFnData, TData = NoUnknown<TQueryFnData>>(\n queryKey: MaybeRefDeep<QueryKey>,\n updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,\n options?: MaybeRefDeep<SetDataOptions>,\n ): NoInfer<TData> | undefined\n setQueryData<TData>(\n queryKey: MaybeRefDeep<QueryKey>,\n updater: Updater<TData | undefined, TData | undefined>,\n options: MaybeRefDeep<SetDataOptions> = {},\n ): NoInfer<TData> | undefined {\n return super.setQueryData<TData>(\n cloneDeepUnref(queryKey),\n updater,\n cloneDeepUnref(options),\n )\n }\n\n setQueriesData<TData>(\n filters: MaybeRefDeep<QueryFilters>,\n updater: Updater<TData | undefined, TData | undefined>,\n options: MaybeRefDeep<SetDataOptions> = {},\n ): Array<[QueryKey, TData | undefined]> {\n return super.setQueriesData(\n cloneDeepUnref(filters),\n updater,\n cloneDeepUnref(options),\n )\n }\n\n getQueryState<TData = unknown, TError = DefaultError>(\n queryKey: MaybeRefDeep<QueryKey>,\n ): QueryState<TData, TError> | undefined {\n return super.getQueryState(cloneDeepUnref(queryKey))\n }\n\n removeQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: QueryFilters<TTaggedQueryKey>,\n ): void\n removeQueries(filters: MaybeRefDeep<QueryFilters> = {}): void {\n return super.removeQueries(cloneDeepUnref(filters))\n }\n\n resetQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: QueryFilters<TTaggedQueryKey>,\n options?: MaybeRefDeep<ResetOptions>,\n ): Promise<void>\n resetQueries(\n filters: MaybeRefDeep<QueryFilters> = {},\n options: MaybeRefDeep<ResetOptions> = {},\n ): Promise<void> {\n return super.resetQueries(cloneDeepUnref(filters), cloneDeepUnref(options))\n }\n\n cancelQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: QueryFilters<TTaggedQueryKey>,\n options?: MaybeRefDeep<CancelOptions>,\n ): Promise<void>\n cancelQueries(\n filters: MaybeRefDeep<QueryFilters> = {},\n options: MaybeRefDeep<CancelOptions> = {},\n ): Promise<void> {\n return super.cancelQueries(cloneDeepUnref(filters), cloneDeepUnref(options))\n }\n\n invalidateQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?:\n | InvalidateQueryFilters<TTaggedQueryKey>\n | (() => InvalidateQueryFilters<TTaggedQueryKey>),\n options?: MaybeRefDeep<InvalidateOptions>,\n ): Promise<void>\n invalidateQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters:\n | MaybeRefDeep<InvalidateQueryFilters<TTaggedQueryKey>>\n | (() => InvalidateQueryFilters<TTaggedQueryKey>) = {},\n options: MaybeRefDeep<InvalidateOptions> | (() => InvalidateOptions) = {},\n ): Promise<void> {\n const filtersCloned = cloneDeepUnref(\n filters as MaybeRefDeep<InvalidateQueryFilters<TTaggedQueryKey>>,\n )\n const optionsCloned = cloneDeepUnref(\n options as MaybeRefDeep<InvalidateOptions>,\n )\n\n super.invalidateQueries(\n { ...filtersCloned, refetchType: 'none' },\n optionsCloned,\n )\n\n if (filtersCloned.refetchType === 'none') {\n return Promise.resolve()\n }\n\n const refetchFilters: RefetchQueryFilters<TTaggedQueryKey> = {\n ...filtersCloned,\n type: filtersCloned.refetchType ?? filtersCloned.type ?? 'active',\n }\n\n // (dosipiuk): We need to delay `refetchQueries` execution to next macro task for all reactive values to be updated.\n // This ensures that `context` in `queryFn` while `invalidating` along reactive variable change has correct\n return nextTick().then(() => {\n return super.refetchQueries(refetchFilters, optionsCloned)\n })\n }\n\n refetchQueries<TTaggedQueryKey extends QueryKey = QueryKey>(\n filters?: RefetchQueryFilters<TTaggedQueryKey>,\n options?: MaybeRefDeep<RefetchOptions>,\n ): Promise<void>\n refetchQueries(\n filters: MaybeRefDeep<RefetchQueryFilters> = {},\n options: MaybeRefDeep<RefetchOptions> = {},\n ): Promise<void> {\n return super.refetchQueries(\n cloneDeepUnref(filters),\n cloneDeepUnref(options),\n )\n }\n\n // These one-shot imperative methods do not resolve top-level option getters.\n // Resolve getters explicitly before calling, e.g. queryClient.query(options()).\n query<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: QueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<TData>\n query<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: MaybeRefDeep<\n QueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<TData>\n query<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: MaybeRefDeep<\n QueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<TData> {\n return super.query(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated Use queryClient.query(options) instead. This method will be removed in the next major version.\n */\n fetchQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: FetchQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<TData>\n fetchQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options:\n | MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>\n >\n | (() => FetchQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >),\n ): Promise<TData>\n fetchQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = never,\n >(\n options: MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>\n >,\n ): Promise<TData> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.fetchQuery(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated Use queryClient.query(options) instead. You can swallow errors with `.catch(noop)`. This method will be removed in the next major version.\n */\n prefetchQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n ): Promise<void>\n prefetchQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<void>\n prefetchQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >(\n options: MaybeRefDeep<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n >,\n ): Promise<void> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.prefetchQuery(cloneDeepUnref(options))\n }\n\n // These one-shot imperative methods do not resolve top-level option getters.\n // Resolve getters explicitly before calling, e.g. queryClient.infiniteQuery(options()).\n infiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: InfiniteQueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<\n Array<TData> extends Array<InfiniteData<TQueryFnData>>\n ? InfiniteData<TQueryFnData, TPageParam>\n : TData\n >\n infiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n InfiniteQueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<\n Array<TData> extends Array<InfiniteData<TQueryFnData>>\n ? InfiniteData<TQueryFnData, TPageParam>\n : TData\n >\n infiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n InfiniteQueryExecuteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<\n Array<TData> extends Array<InfiniteData<TQueryFnData>>\n ? InfiniteData<TQueryFnData, TPageParam>\n : TData\n > {\n return super.infiniteQuery(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated Use queryClient.infiniteQuery(options) instead. This method will be removed in the next major version.\n */\n fetchInfiniteQuery<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<InfiniteData<TData, TPageParam>>\n fetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<InfiniteData<TData, TPageParam>>\n fetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<InfiniteData<TData, TPageParam>> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.fetchInfiniteQuery(cloneDeepUnref(options))\n }\n\n /**\n * @deprecated use void queryClient.infiniteQuery(options) instead. You can swallow errors with `.catch(noop)`. This method will be removed in the next major version.\n */\n prefetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n ): Promise<void>\n prefetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<void>\n prefetchInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n >(\n options: MaybeRefDeep<\n FetchInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n >,\n ): Promise<void> {\n // eslint-disable-next-line no-restricted-syntax -- grandfathered deprecated wrapper implementation\n return super.prefetchInfiniteQuery(cloneDeepUnref(options))\n }\n\n setDefaultOptions(options: MaybeRefDeep<DefaultOptions>): void {\n super.setDefaultOptions(cloneDeepUnref(options))\n }\n\n setQueryDefaults<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n >(\n queryKey: MaybeRefDeep<QueryKey>,\n options: MaybeRefDeep<\n Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryData>, 'queryKey'>\n >,\n ): void {\n super.setQueryDefaults(cloneDeepUnref(queryKey), cloneDeepUnref(options))\n }\n\n getQueryDefaults(\n queryKey: MaybeRefDeep<QueryKey>,\n ): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'> {\n return super.getQueryDefaults(cloneDeepUnref(queryKey))\n }\n\n setMutationDefaults<\n TData = unknown,\n TError = DefaultError,\n TVariables = void,\n TOnMutateResult = unknown,\n >(\n mutationKey: MaybeRefDeep<MutationKey>,\n options: MaybeRefDeep<\n MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>\n >,\n ): void {\n super.setMutationDefaults(\n cloneDeepUnref(mutationKey),\n cloneDeepUnref(options),\n )\n }\n\n getMutationDefaults(\n mutationKey: MaybeRefDeep<MutationKey>,\n ): MutationObserverOptions<any, any, any, any> {\n return super.getMutationDefaults(cloneDeepUnref(mutationKey))\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAkDA,IAAa,cAAb,cAAiCA,cAAG;CAClC,YAAY,SAA4B,CAAC,GAAG;EAC1C,MAAM,iBAAiB;GACrB,gBAAgB,OAAO;GACvB,YAAY,OAAO,cAAc,IAAIC,aAAW;GAChD,eAAe,OAAO,iBAAiB,IAAIC,gBAAc;EAC3D;EACA,MAAM,cAAc;EAOtB,KAAA,cAA6B,IAAI,KAAK;CANtC;CAQA,WAAW,UAAsC,CAAC,GAAW;EAC3D,OAAO,MAAM,WAAW,eAAe,OAAO,CAAC;CACjD;CAEA,WAAW,UAAyC,CAAC,GAAW;EAC9D,OAAO,MAAM,WAAW,eAAe,OAAO,CAAC;CACjD;CAQA,aACE,UACmB;EACnB,OAAO,MAAM,aAAa,eAAe,QAAQ,CAAC;CACpD;CAuBA,gBAME,SAGgB;EAEhB,OAAO,MAAM,gBAAgB,eAAe,OAAO,CAAC;CACtD;CAEA,eACE,SACsC;EACtC,OAAO,MAAM,eAAe,eAAe,OAAO,CAAC;CACrD;CAmBA,aACE,UACA,SACA,UAAwC,CAAC,GACb;EAC5B,OAAO,MAAM,aACX,eAAe,QAAQ,GACvB,SACA,eAAe,OAAO,CACxB;CACF;CAEA,eACE,SACA,SACA,UAAwC,CAAC,GACH;EACtC,OAAO,MAAM,eACX,eAAe,OAAO,GACtB,SACA,eAAe,OAAO,CACxB;CACF;CAEA,cACE,UACuC;EACvC,OAAO,MAAM,cAAc,eAAe,QAAQ,CAAC;CACrD;CAKA,cAAc,UAAsC,CAAC,GAAS;EAC5D,OAAO,MAAM,cAAc,eAAe,OAAO,CAAC;CACpD;CAMA,aACE,UAAsC,CAAC,GACvC,UAAsC,CAAC,GACxB;EACf,OAAO,MAAM,aAAa,eAAe,OAAO,GAAG,eAAe,OAAO,CAAC;CAC5E;CAMA,cACE,UAAsC,CAAC,GACvC,UAAuC,CAAC,GACzB;EACf,OAAO,MAAM,cAAc,eAAe,OAAO,GAAG,eAAe,OAAO,CAAC;CAC7E;CAQA,kBACE,UAEsD,CAAC,GACvD,UAAuE,CAAC,GACzD;EACf,MAAM,gBAAgB,eACpB,OACF;EACA,MAAM,gBAAgB,eACpB,OACF;EAEA,MAAM,kBACJ;GAAE,GAAG;GAAe,aAAa;EAAO,GACxC,aACF;EAEA,IAAI,cAAc,gBAAgB,QAChC,OAAO,QAAQ,QAAQ;EAGzB,MAAM,iBAAuD;GAC3D,GAAG;GACH,MAAM,cAAc,eAAe,cAAc,QAAQ;EAC3D;EAIA,OAAO,SAAS,CAAC,CAAC,WAAW;GAC3B,OAAO,MAAM,eAAe,gBAAgB,aAAa;EAC3D,CAAC;CACH;CAMA,eACE,UAA6C,CAAC,GAC9C,UAAwC,CAAC,GAC1B;EACf,OAAO,MAAM,eACX,eAAe,OAAO,GACtB,eAAe,OAAO,CACxB;CACF;CAwCA,MAQE,SAUgB;EAChB,OAAO,MAAM,MAAM,eAAe,OAAO,CAAC;CAC5C;CAuCA,WAOE,SAGgB;EAEhB,OAAO,MAAM,WAAW,eAAe,OAAO,CAAC;CACjD;CAuBA,cAME,SAGe;EAEf,OAAO,MAAM,cAAc,eAAe,OAAO,CAAC;CACpD;CA4CA,cAOE,SAaA;EACA,OAAO,MAAM,cAAc,eAAe,OAAO,CAAC;CACpD;CAqCA,mBAOE,SAS0C;EAE1C,OAAO,MAAM,mBAAmB,eAAe,OAAO,CAAC;CACzD;CAqCA,sBAOE,SASe;EAEf,OAAO,MAAM,sBAAsB,eAAe,OAAO,CAAC;CAC5D;CAEA,kBAAkB,SAA6C;EAC7D,MAAM,kBAAkB,eAAe,OAAO,CAAC;CACjD;CAEA,iBAME,UACA,SAGM;EACN,MAAM,iBAAiB,eAAe,QAAQ,GAAG,eAAe,OAAO,CAAC;CAC1E;CAEA,iBACE,UACsE;EACtE,OAAO,MAAM,iBAAiB,eAAe,QAAQ,CAAC;CACxD;CAEA,oBAME,aACA,SAGM;EACN,MAAM,oBACJ,eAAe,WAAW,GAC1B,eAAe,OAAO,CACxB;CACF;CAEA,oBACE,aAC6C;EAC7C,OAAO,MAAM,oBAAoB,eAAe,WAAW,CAAC;CAC9D;AACF"}
|
|
@@ -73,7 +73,7 @@ type WithDefinedInitialData<TQueryFnData> = {
|
|
|
73
73
|
type UndefinedInitialQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & WithUndefinedInitialData<TQueryFnData>;
|
|
74
74
|
/**
|
|
75
75
|
* The options accepted by the `queryOptions` overload selected when `initialData` is set — `data` is never
|
|
76
|
-
* `undefined
|
|
76
|
+
* `undefined` (unless a `select` changes `TData` to include `undefined`).
|
|
77
77
|
*
|
|
78
78
|
* @template TQueryFnData - The type your `queryFn` resolves to.
|
|
79
79
|
* @template TError - The type of errors your `queryFn` may throw.
|
|
@@ -88,7 +88,8 @@ type DefinedInitialQueryOptionsWithDataTag<TQueryFnData = unknown, TError = Defa
|
|
|
88
88
|
* be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and
|
|
89
89
|
* is the query key to generate options for.
|
|
90
90
|
*
|
|
91
|
-
* This overload is selected when `initialData` is set, so the resulting `data` is never `undefined
|
|
91
|
+
* This overload is selected when `initialData` is set, so the resulting `data` is never `undefined` (unless
|
|
92
|
+
* a `select` changes `TData` to include `undefined`).
|
|
92
93
|
*
|
|
93
94
|
* @see {@link useQuery} to run a query with these options.
|
|
94
95
|
* @param options - The {@link DefinedInitialQueryOptions} to use — everything you can pass to `useQuery`, with
|
|
@@ -224,4 +225,4 @@ declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TDa
|
|
|
224
225
|
declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: () => UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>): () => UndefinedInitialQueryOptionsWithDataTag<TQueryFnData, TError, TData, TQueryKey>;
|
|
225
226
|
//#endregion
|
|
226
227
|
export { UndefinedInitialQueryOptionsWithDataTag as a, UndefinedInitialQueryOptions as i, DefinedInitialQueryOptionsWithDataTag as n, UseQueryOptions as o, QueryOptions as r, queryOptions as s, DefinedInitialQueryOptions as t };
|
|
227
|
-
//# sourceMappingURL=queryOptions-
|
|
228
|
+
//# sourceMappingURL=queryOptions-CsM5TXD2.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"queryOptions-CsM5TXD2.d.ts","names":[],"sources":["../../src/queryOptions.ts"],"mappings":";;;;;;;;;;;;;;;KA6BY,aACV,wBACA,SAAS,cACT,QAAQ,cACR,aAAa,cACb,kBAAkB,WAAW,eAG3B,kBAAkB,qBAChB,cACA,QACA,OACA,YACA,aAED,6BACG,+CACO,mBACL,cACA,QACA,YACA,cAAc,eAElB,8BACE,iBAAiB,aACjB,qBACE,cACA,QACA,OACA,YACA,cAAc,YACd,eACN;KAGC;;;;;;;;;;;;;;;;;;;;;;;;;;KA2BO,gBACV,wBACA,SAAS,cACT,QAAQ,cACR,aAAa,cACb,kBAAkB,WAAW,YAC3B,YAGE,kBAAkB,qBAChB,cACA,QACA,OACA,YACA,aAED,0CACC,aACE,cACA,QACA,OACA,YACA,WACA,YACF,6BACE,aACI,aACE,cACA,QACA,OACA,YACA,WACA,YACF,wBAEJ,aACE,aACE,cACA,QACA,OACA,YACA,WACA,gBAER;KAGD,yBAAyB;;;;;;;;EAQ5B,0BAEI,oBAAoB,kBAAkB,iBACtC,kBAAkB;;KAGnB,uBAAuB;;;;;;;;EAQ1B,aACE,kBAAkB,uBAAuB,kBAAkB;;;;;;;;;;;KAYnD,6BACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,gBAAgB,cAAc,QAAQ,OAAO,cAAc,aAC7D,yBAAyB;;;;;;;;;;KAWf,2BACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,gBAAgB,cAAc,QAAQ,OAAO,cAAc,aAC7D,uBAAuB;KAEb,wCACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,aAAa,cAAc,QAAQ,OAAO,cAAc,aAC1D,yBAAyB,gBACzB,oBAAoB,WAAW,cAAc;KAEnC,sCACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,aAAa,cAAc,QAAQ,OAAO,cAAc,aAC1D,uBAAuB,gBACvB,oBAAoB,WAAW,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgC/B,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,2BAA2B,cAAc,QAAQ,OAAO,aAChE,sCAAsC,cAAc,QAAQ,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA8BtD,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,eAAe,2BACb,cACA,QACA,OACA,mBAEK,sCACP,cACA,QACA,OACA;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6Bc,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,6BAA6B,cAAc,QAAQ,OAAO,aAClE,wCACD,cACA,QACA,OACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAuDc,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,eAAe,6BACb,cACA,QACA,OACA,mBAEK,wCACP,cACA,QACA,OACA"}
|
|
@@ -73,7 +73,7 @@ type WithDefinedInitialData<TQueryFnData> = {
|
|
|
73
73
|
type UndefinedInitialQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & WithUndefinedInitialData<TQueryFnData>;
|
|
74
74
|
/**
|
|
75
75
|
* The options accepted by the `queryOptions` overload selected when `initialData` is set — `data` is never
|
|
76
|
-
* `undefined
|
|
76
|
+
* `undefined` (unless a `select` changes `TData` to include `undefined`).
|
|
77
77
|
*
|
|
78
78
|
* @template TQueryFnData - The type your `queryFn` resolves to.
|
|
79
79
|
* @template TError - The type of errors your `queryFn` may throw.
|
|
@@ -88,7 +88,8 @@ type DefinedInitialQueryOptionsWithDataTag<TQueryFnData = unknown, TError = Defa
|
|
|
88
88
|
* be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and
|
|
89
89
|
* is the query key to generate options for.
|
|
90
90
|
*
|
|
91
|
-
* This overload is selected when `initialData` is set, so the resulting `data` is never `undefined
|
|
91
|
+
* This overload is selected when `initialData` is set, so the resulting `data` is never `undefined` (unless
|
|
92
|
+
* a `select` changes `TData` to include `undefined`).
|
|
92
93
|
*
|
|
93
94
|
* @see {@link useQuery} to run a query with these options.
|
|
94
95
|
* @param options - The {@link DefinedInitialQueryOptions} to use — everything you can pass to `useQuery`, with
|
|
@@ -224,4 +225,4 @@ declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TDa
|
|
|
224
225
|
declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: () => UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>): () => UndefinedInitialQueryOptionsWithDataTag<TQueryFnData, TError, TData, TQueryKey>;
|
|
225
226
|
//#endregion
|
|
226
227
|
export { UndefinedInitialQueryOptionsWithDataTag as a, UndefinedInitialQueryOptions as i, DefinedInitialQueryOptionsWithDataTag as n, UseQueryOptions as o, QueryOptions as r, queryOptions as s, DefinedInitialQueryOptions as t };
|
|
227
|
-
//# sourceMappingURL=queryOptions-
|
|
228
|
+
//# sourceMappingURL=queryOptions-CwqQgQmQ.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"queryOptions-CwqQgQmQ.d.cts","names":[],"sources":["../../src/queryOptions.ts"],"mappings":";;;;;;;;;;;;;;;KA6BY,aACV,wBACA,SAAS,cACT,QAAQ,cACR,aAAa,cACb,kBAAkB,WAAW,eAG3B,kBAAkB,qBAChB,cACA,QACA,OACA,YACA,aAED,6BACG,+CACO,mBACL,cACA,QACA,YACA,cAAc,eAElB,8BACE,iBAAiB,aACjB,qBACE,cACA,QACA,OACA,YACA,cAAc,YACd,eACN;KAGC;;;;;;;;;;;;;;;;;;;;;;;;;;KA2BO,gBACV,wBACA,SAAS,cACT,QAAQ,cACR,aAAa,cACb,kBAAkB,WAAW,YAC3B,YAGE,kBAAkB,qBAChB,cACA,QACA,OACA,YACA,aAED,0CACC,aACE,cACA,QACA,OACA,YACA,WACA,YACF,6BACE,aACI,aACE,cACA,QACA,OACA,YACA,WACA,YACF,wBAEJ,aACE,aACE,cACA,QACA,OACA,YACA,WACA,gBAER;KAGD,yBAAyB;;;;;;;;EAQ5B,0BAEI,oBAAoB,kBAAkB,iBACtC,kBAAkB;;KAGnB,uBAAuB;;;;;;;;EAQ1B,aACE,kBAAkB,uBAAuB,kBAAkB;;;;;;;;;;;KAYnD,6BACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,gBAAgB,cAAc,QAAQ,OAAO,cAAc,aAC7D,yBAAyB;;;;;;;;;;KAWf,2BACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,gBAAgB,cAAc,QAAQ,OAAO,cAAc,aAC7D,uBAAuB;KAEb,wCACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,aAAa,cAAc,QAAQ,OAAO,cAAc,aAC1D,yBAAyB,gBACzB,oBAAoB,WAAW,cAAc;KAEnC,sCACV,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,YAC3B,aAAa,cAAc,QAAQ,OAAO,cAAc,aAC1D,uBAAuB,gBACvB,oBAAoB,WAAW,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgC/B,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,2BAA2B,cAAc,QAAQ,OAAO,aAChE,sCAAsC,cAAc,QAAQ,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA8BtD,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,eAAe,2BACb,cACA,QACA,OACA,mBAEK,sCACP,cACA,QACA,OACA;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6Bc,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,SAAS,6BAA6B,cAAc,QAAQ,OAAO,aAClE,wCACD,cACA,QACA,OACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAuDc,aACd,wBACA,SAAS,cACT,QAAQ,cACR,kBAAkB,WAAW,UAE7B,eAAe,6BACb,cACA,QACA,OACA,mBAEK,wCACP,cACA,QACA,OACA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"queryOptions.cjs","names":[],"sources":["../../src/queryOptions.ts"],"sourcesContent":["import type {\n DeepUnwrapRef,\n MaybeRef,\n MaybeRefDeep,\n MaybeRefOrGetter,\n ShallowOption,\n} from './types'\nimport type {\n DefaultError,\n InitialDataFunction,\n NonUndefinedGuard,\n QueryBooleanOption,\n QueryKey,\n QueryKeyWithDataTag,\n QueryObserverOptions,\n} from '@tanstack/query-core'\n\n/**\n * The plain, unwrapped options that `queryOptions` hands back, and what `useQuery`, `useQueries`, and the\n * `queryClient` methods see once `ref`s have been resolved. To pass options in, use\n * {@link UseQueryOptions}, which accepts the same options as `ref`s and `computed`s too.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryData - The type of data stored in the cache, before `select` runs. Defaults to\n * `TQueryFnData` and can be configured independently of it.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type QueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = {\n [Property in keyof QueryObserverOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >]: Property extends 'enabled'\n ?\n | MaybeRefOrGetter<boolean | undefined>\n | (() => QueryBooleanOption<\n TQueryFnData,\n TError,\n TQueryData,\n DeepUnwrapRef<TQueryKey>\n >)\n : Property extends 'queryKey'\n ? MaybeRefOrGetter<TQueryKey>\n : QueryObserverOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n DeepUnwrapRef<TQueryKey>\n >[Property]\n} & ShallowOption\n\n// Widen the type of the symbol to enable type inference even if skipToken is not immutable.\ntype SkipTokenForUseQuery = symbol\n\n/**\n * The options accepted by `queryOptions`, `useQuery`, and the other query hooks. `enabled` tracks reactive\n * dependencies automatically as a `ref`, a plain value, or a reactive getter (`() => ...`). `queryKey` reacts\n * through a `ref` or a reactive getter for the array itself, or `ref`s and reactive getters as individual\n * entries. Other options are read once when passed as a plain value, and stay reactive when passed as a `ref`\n * or a `computed`. Only `enabled` and `queryKey` read a function as a getter, so `queryFn` reacts through a\n * `computed`: a function there is the query function itself.\n *\n * If you instead pass a getter for the whole options object (`useQuery(() => ({ ... }))`), every option\n * inside it — including `staleTime`, `retry`, and `select` — is re-evaluated whenever the getter's own\n * reactive dependencies change, since the entire object is recomputed.\n *\n * `select` only re-runs when `data` changes, or when the `select` function's own reference changes. Since a\n * Vue `setup()` function runs only once per component instance, an inline `select` function passed directly\n * to `queryOptions`/`useQuery` already has a stable reference across reactive updates. An inline `select`\n * created inside a whole-options getter is recreated — and so can change reference — every time that getter\n * re-evaluates.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryData - The type of data stored in the cache, before `select` runs. Defaults to\n * `TQueryFnData` and can be configured independently of it.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type UseQueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = MaybeRef<\n {\n [Property in keyof QueryObserverOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >]: Property extends 'enabled' | 'queryKey'\n ? QueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >[Property]\n : Property extends 'queryFn'\n ? MaybeRefDeep<\n | QueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >[Property]\n | SkipTokenForUseQuery\n >\n : MaybeRefDeep<\n QueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >[Property]\n >\n } & ShallowOption\n>\n\ntype WithUndefinedInitialData<TQueryFnData> = {\n /**\n * If set, this value will be used as the initial data for the query cache (as long as the query hasn't been\n * created or cached yet). If set to a function, the function will be called **once** during the shared/root\n * query initialization, and be expected to synchronously return the initial data. Initial data is\n * considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the\n * cache. Unlike `queryKey`/`enabled`, this is not reactive — it isn't re-evaluated on `ref` changes.\n */\n initialData?:\n | undefined\n | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>\n | NonUndefinedGuard<TQueryFnData>\n}\n\ntype WithDefinedInitialData<TQueryFnData> = {\n /**\n * If set, this value will be used as the initial data for the query cache (as long as the query hasn't been\n * created or cached yet). If set to a function, the function will be called **once** during the shared/root\n * query initialization, and be expected to synchronously return the initial data. Initial data is\n * considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the\n * cache. Unlike `queryKey`/`enabled`, this is not reactive — it isn't re-evaluated on `ref` changes.\n */\n initialData:\n | NonUndefinedGuard<TQueryFnData>\n | (() => NonUndefinedGuard<TQueryFnData>)\n}\n\n/**\n * The options accepted by the `queryOptions` overload selected when no `initialData` is set — `data` may be\n * `undefined` while the query is `pending`.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type UndefinedInitialQueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithUndefinedInitialData<TQueryFnData>\n\n/**\n * The options accepted by the `queryOptions` overload selected when `initialData` is set — `data` is never\n * `undefined`.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type DefinedInitialQueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithDefinedInitialData<TQueryFnData>\n\nexport type UndefinedInitialQueryOptionsWithDataTag<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = QueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithUndefinedInitialData<TQueryFnData> &\n QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>\n\nexport type DefinedInitialQueryOptionsWithDataTag<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = QueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithDefinedInitialData<TQueryFnData> &\n QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>\n\n/**\n * You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can\n * be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and\n * is the query key to generate options for.\n *\n * This overload is selected when `initialData` is set, so the resulting `data` is never `undefined`.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - The {@link DefinedInitialQueryOptions} to use — everything you can pass to `useQuery`, with\n * `initialData` set.\n * @returns The same options object, typed so that `queryKey` carries the inferred data type.\n *\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, useQuery } from '@tanstack/vue-query'\n *\n * const postsOptions = queryOptions({\n * queryKey: ['posts'],\n * queryFn: fetchPosts,\n * initialData: [],\n * })\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(postsOptions)\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): DefinedInitialQueryOptionsWithDataTag<TQueryFnData, TError, TData, TQueryKey>\n\n/**\n * Same as the plain-object overload, but for options that close over reactive state (`ref`s read inside the\n * function body). Wrap them in a getter so `queryClient` methods like `invalidateQueries`/`fetchQuery` always\n * read the current values instead of the ones captured when the options were created.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - A function returning the {@link DefinedInitialQueryOptions} to use, re-evaluated on demand.\n * @returns A function that returns the same options object, typed so that `queryKey` carries the inferred data\n * type.\n *\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { queryOptions, useQuery } from '@tanstack/vue-query'\n *\n * const postId = ref(1)\n * const postOptions = queryOptions(() => ({\n * queryKey: ['post', postId.value],\n * queryFn: () => fetchPost(postId.value),\n * initialData: { id: postId.value, title: '' },\n * }))\n *\n * // Pass the getter itself, not `postOptions()`, so the query keeps reacting to `postId` changes.\n * const { data } = useQuery(postOptions)\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: () => DefinedInitialQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >,\n): () => DefinedInitialQueryOptionsWithDataTag<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n>\n\n/**\n * You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can\n * be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and\n * is the query key to generate options for.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - The {@link UndefinedInitialQueryOptions} to use — everything you can pass to `useQuery`.\n * @returns The same options object, typed so that `queryKey` carries the inferred data type.\n *\n * @example\n * A parameterized factory, so the same options object can be reused per `id`:\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, useQuery } from '@tanstack/vue-query'\n *\n * function postOptions(id: string) {\n * return queryOptions({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * })\n * }\n *\n * const { data, isPending, isError, error } = useQuery(postOptions('1'))\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UndefinedInitialQueryOptionsWithDataTag<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n>\n\n/**\n * Same as the plain-object overload, but for options that close over reactive state (`ref`s read inside the\n * function body). Wrap them in a getter so the `queryKey` — and anything else derived from a `ref` — reacts\n * to changes, and so `queryClient` methods like `invalidateQueries`/`fetchQuery` always read the current\n * values instead of the ones captured when the options were created.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - A function returning the {@link UndefinedInitialQueryOptions} to use, re-evaluated on\n * demand.\n * @returns A function that returns the same options object, typed so that `queryKey` carries the inferred\n * data type.\n *\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { queryOptions, useQuery, useQueryClient } from '@tanstack/vue-query'\n *\n * const postId = ref(1)\n * const postOptions = queryOptions(() => ({\n * queryKey: ['post', postId.value],\n * queryFn: () => fetchPost(postId.value),\n * }))\n *\n * // Pass the getter itself, not `postOptions()`, so the query keeps reacting to `postId` changes.\n * const { data } = useQuery(postOptions)\n * const queryClient = useQueryClient()\n * // Here, call `postOptions()` so `invalidateQueries` reads the current `queryKey` right away.\n * queryClient.invalidateQueries(postOptions())\n * </script>\n * ```\n *\n * @example\n * A parameterized factory that disables the query, type safe, until `postId` is set. The whole-options getter\n * re-evaluates `queryFn` on every change to `postId`. `queryFn` can also be a `computed`, but never a bare\n * getter, since a function there is the query function itself:\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, skipToken, useQuery } from '@tanstack/vue-query'\n *\n * function postOptions(postId: number | undefined) {\n * return queryOptions(() => ({\n * queryKey: ['post', postId],\n * queryFn: postId != null ? () => fetchPost(postId) : skipToken,\n * }))\n * }\n *\n * const props = defineProps<{ postId: number | undefined }>()\n * const { data, isLoading, isError, error } = useQuery(postOptions(props.postId))\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: () => UndefinedInitialQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >,\n): () => UndefinedInitialQueryOptionsWithDataTag<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n>\n\nexport function queryOptions(options: unknown) {\n return options\n}\n"],"mappings":";;AA0ZA,SAAgB,aAAa,SAAkB;CAC7C,OAAO;AACT"}
|
|
1
|
+
{"version":3,"file":"queryOptions.cjs","names":[],"sources":["../../src/queryOptions.ts"],"sourcesContent":["import type {\n DeepUnwrapRef,\n MaybeRef,\n MaybeRefDeep,\n MaybeRefOrGetter,\n ShallowOption,\n} from './types'\nimport type {\n DefaultError,\n InitialDataFunction,\n NonUndefinedGuard,\n QueryBooleanOption,\n QueryKey,\n QueryKeyWithDataTag,\n QueryObserverOptions,\n} from '@tanstack/query-core'\n\n/**\n * The plain, unwrapped options that `queryOptions` hands back, and what `useQuery`, `useQueries`, and the\n * `queryClient` methods see once `ref`s have been resolved. To pass options in, use\n * {@link UseQueryOptions}, which accepts the same options as `ref`s and `computed`s too.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryData - The type of data stored in the cache, before `select` runs. Defaults to\n * `TQueryFnData` and can be configured independently of it.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type QueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = {\n [\n Property in keyof QueryObserverOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >\n ]: Property extends 'enabled'\n ? | MaybeRefOrGetter<boolean | undefined>\n | (() => QueryBooleanOption<\n TQueryFnData,\n TError,\n TQueryData,\n DeepUnwrapRef<TQueryKey>\n >)\n : Property extends 'queryKey'\n ? MaybeRefOrGetter<TQueryKey>\n : QueryObserverOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n DeepUnwrapRef<TQueryKey>\n >[Property]\n} & ShallowOption\n\n// Widen the type of the symbol to enable type inference even if skipToken is not immutable.\ntype SkipTokenForUseQuery = symbol\n\n/**\n * The options accepted by `queryOptions`, `useQuery`, and the other query hooks. `enabled` tracks reactive\n * dependencies automatically as a `ref`, a plain value, or a reactive getter (`() => ...`). `queryKey` reacts\n * through a `ref` or a reactive getter for the array itself, or `ref`s and reactive getters as individual\n * entries. Other options are read once when passed as a plain value, and stay reactive when passed as a `ref`\n * or a `computed`. Only `enabled` and `queryKey` read a function as a getter, so `queryFn` reacts through a\n * `computed`: a function there is the query function itself.\n *\n * If you instead pass a getter for the whole options object (`useQuery(() => ({ ... }))`), every option\n * inside it — including `staleTime`, `retry`, and `select` — is re-evaluated whenever the getter's own\n * reactive dependencies change, since the entire object is recomputed.\n *\n * `select` only re-runs when `data` changes, or when the `select` function's own reference changes. Since a\n * Vue `setup()` function runs only once per component instance, an inline `select` function passed directly\n * to `queryOptions`/`useQuery` already has a stable reference across reactive updates. An inline `select`\n * created inside a whole-options getter is recreated — and so can change reference — every time that getter\n * re-evaluates.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryData - The type of data stored in the cache, before `select` runs. Defaults to\n * `TQueryFnData` and can be configured independently of it.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type UseQueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = MaybeRef<\n {\n [\n Property in keyof QueryObserverOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >\n ]: Property extends 'enabled' | 'queryKey'\n ? QueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >[Property]\n : Property extends 'queryFn'\n ? MaybeRefDeep<\n | QueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >[Property]\n | SkipTokenForUseQuery\n >\n : MaybeRefDeep<\n QueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >[Property]\n >\n } & ShallowOption\n>\n\ntype WithUndefinedInitialData<TQueryFnData> = {\n /**\n * If set, this value will be used as the initial data for the query cache (as long as the query hasn't been\n * created or cached yet). If set to a function, the function will be called **once** during the shared/root\n * query initialization, and be expected to synchronously return the initial data. Initial data is\n * considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the\n * cache. Unlike `queryKey`/`enabled`, this is not reactive — it isn't re-evaluated on `ref` changes.\n */\n initialData?:\n | undefined\n | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>\n | NonUndefinedGuard<TQueryFnData>\n}\n\ntype WithDefinedInitialData<TQueryFnData> = {\n /**\n * If set, this value will be used as the initial data for the query cache (as long as the query hasn't been\n * created or cached yet). If set to a function, the function will be called **once** during the shared/root\n * query initialization, and be expected to synchronously return the initial data. Initial data is\n * considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the\n * cache. Unlike `queryKey`/`enabled`, this is not reactive — it isn't re-evaluated on `ref` changes.\n */\n initialData:\n NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>)\n}\n\n/**\n * The options accepted by the `queryOptions` overload selected when no `initialData` is set — `data` may be\n * `undefined` while the query is `pending`.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type UndefinedInitialQueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithUndefinedInitialData<TQueryFnData>\n\n/**\n * The options accepted by the `queryOptions` overload selected when `initialData` is set — `data` is never\n * `undefined` (unless a `select` changes `TData` to include `undefined`).\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type DefinedInitialQueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithDefinedInitialData<TQueryFnData>\n\nexport type UndefinedInitialQueryOptionsWithDataTag<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = QueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithUndefinedInitialData<TQueryFnData> &\n QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>\n\nexport type DefinedInitialQueryOptionsWithDataTag<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = QueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithDefinedInitialData<TQueryFnData> &\n QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>\n\n/**\n * You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can\n * be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and\n * is the query key to generate options for.\n *\n * This overload is selected when `initialData` is set, so the resulting `data` is never `undefined` (unless\n * a `select` changes `TData` to include `undefined`).\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - The {@link DefinedInitialQueryOptions} to use — everything you can pass to `useQuery`, with\n * `initialData` set.\n * @returns The same options object, typed so that `queryKey` carries the inferred data type.\n *\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, useQuery } from '@tanstack/vue-query'\n *\n * const postsOptions = queryOptions({\n * queryKey: ['posts'],\n * queryFn: fetchPosts,\n * initialData: [],\n * })\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(postsOptions)\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): DefinedInitialQueryOptionsWithDataTag<TQueryFnData, TError, TData, TQueryKey>\n\n/**\n * Same as the plain-object overload, but for options that close over reactive state (`ref`s read inside the\n * function body). Wrap them in a getter so `queryClient` methods like `invalidateQueries`/`fetchQuery` always\n * read the current values instead of the ones captured when the options were created.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - A function returning the {@link DefinedInitialQueryOptions} to use, re-evaluated on demand.\n * @returns A function that returns the same options object, typed so that `queryKey` carries the inferred data\n * type.\n *\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { queryOptions, useQuery } from '@tanstack/vue-query'\n *\n * const postId = ref(1)\n * const postOptions = queryOptions(() => ({\n * queryKey: ['post', postId.value],\n * queryFn: () => fetchPost(postId.value),\n * initialData: { id: postId.value, title: '' },\n * }))\n *\n * // Pass the getter itself, not `postOptions()`, so the query keeps reacting to `postId` changes.\n * const { data } = useQuery(postOptions)\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: () => DefinedInitialQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >,\n): () => DefinedInitialQueryOptionsWithDataTag<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n>\n\n/**\n * You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can\n * be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and\n * is the query key to generate options for.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - The {@link UndefinedInitialQueryOptions} to use — everything you can pass to `useQuery`.\n * @returns The same options object, typed so that `queryKey` carries the inferred data type.\n *\n * @example\n * A parameterized factory, so the same options object can be reused per `id`:\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, useQuery } from '@tanstack/vue-query'\n *\n * function postOptions(id: string) {\n * return queryOptions({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * })\n * }\n *\n * const { data, isPending, isError, error } = useQuery(postOptions('1'))\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UndefinedInitialQueryOptionsWithDataTag<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n>\n\n/**\n * Same as the plain-object overload, but for options that close over reactive state (`ref`s read inside the\n * function body). Wrap them in a getter so the `queryKey` — and anything else derived from a `ref` — reacts\n * to changes, and so `queryClient` methods like `invalidateQueries`/`fetchQuery` always read the current\n * values instead of the ones captured when the options were created.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - A function returning the {@link UndefinedInitialQueryOptions} to use, re-evaluated on\n * demand.\n * @returns A function that returns the same options object, typed so that `queryKey` carries the inferred\n * data type.\n *\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { queryOptions, useQuery, useQueryClient } from '@tanstack/vue-query'\n *\n * const postId = ref(1)\n * const postOptions = queryOptions(() => ({\n * queryKey: ['post', postId.value],\n * queryFn: () => fetchPost(postId.value),\n * }))\n *\n * // Pass the getter itself, not `postOptions()`, so the query keeps reacting to `postId` changes.\n * const { data } = useQuery(postOptions)\n * const queryClient = useQueryClient()\n * // Here, call `postOptions()` so `invalidateQueries` reads the current `queryKey` right away.\n * queryClient.invalidateQueries(postOptions())\n * </script>\n * ```\n *\n * @example\n * A parameterized factory that disables the query, type safe, until `postId` is set. The whole-options getter\n * re-evaluates `queryFn` on every change to `postId`. `queryFn` can also be a `computed`, but never a bare\n * getter, since a function there is the query function itself:\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, skipToken, useQuery } from '@tanstack/vue-query'\n *\n * function postOptions(postId: number | undefined) {\n * return queryOptions(() => ({\n * queryKey: ['post', postId],\n * queryFn: postId != null ? () => fetchPost(postId) : skipToken,\n * }))\n * }\n *\n * const props = defineProps<{ postId: number | undefined }>()\n * const { data, isLoading, isError, error } = useQuery(postOptions(props.postId))\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: () => UndefinedInitialQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >,\n): () => UndefinedInitialQueryOptionsWithDataTag<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n>\n\nexport function queryOptions(options: unknown) {\n return options\n}\n"],"mappings":";;AA6ZA,SAAgB,aAAa,SAAkB;CAC7C,OAAO;AACT"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { a as UndefinedInitialQueryOptionsWithDataTag, i as UndefinedInitialQueryOptions, n as DefinedInitialQueryOptionsWithDataTag, o as UseQueryOptions, r as QueryOptions, s as queryOptions, t as DefinedInitialQueryOptions } from "./queryOptions-
|
|
1
|
+
import { a as UndefinedInitialQueryOptionsWithDataTag, i as UndefinedInitialQueryOptions, n as DefinedInitialQueryOptionsWithDataTag, o as UseQueryOptions, r as QueryOptions, s as queryOptions, t as DefinedInitialQueryOptions } from "./queryOptions-CwqQgQmQ.cjs";
|
|
2
2
|
export { DefinedInitialQueryOptions, DefinedInitialQueryOptionsWithDataTag, QueryOptions, UndefinedInitialQueryOptions, UndefinedInitialQueryOptionsWithDataTag, UseQueryOptions, queryOptions };
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { a as UndefinedInitialQueryOptionsWithDataTag, i as UndefinedInitialQueryOptions, n as DefinedInitialQueryOptionsWithDataTag, o as UseQueryOptions, r as QueryOptions, s as queryOptions, t as DefinedInitialQueryOptions } from "./queryOptions-
|
|
1
|
+
import { a as UndefinedInitialQueryOptionsWithDataTag, i as UndefinedInitialQueryOptions, n as DefinedInitialQueryOptionsWithDataTag, o as UseQueryOptions, r as QueryOptions, s as queryOptions, t as DefinedInitialQueryOptions } from "./queryOptions-CsM5TXD2.js";
|
|
2
2
|
export { DefinedInitialQueryOptions, DefinedInitialQueryOptionsWithDataTag, QueryOptions, UndefinedInitialQueryOptions, UndefinedInitialQueryOptionsWithDataTag, UseQueryOptions, queryOptions };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"queryOptions.js","names":[],"sources":["../../src/queryOptions.ts"],"sourcesContent":["import type {\n DeepUnwrapRef,\n MaybeRef,\n MaybeRefDeep,\n MaybeRefOrGetter,\n ShallowOption,\n} from './types'\nimport type {\n DefaultError,\n InitialDataFunction,\n NonUndefinedGuard,\n QueryBooleanOption,\n QueryKey,\n QueryKeyWithDataTag,\n QueryObserverOptions,\n} from '@tanstack/query-core'\n\n/**\n * The plain, unwrapped options that `queryOptions` hands back, and what `useQuery`, `useQueries`, and the\n * `queryClient` methods see once `ref`s have been resolved. To pass options in, use\n * {@link UseQueryOptions}, which accepts the same options as `ref`s and `computed`s too.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryData - The type of data stored in the cache, before `select` runs. Defaults to\n * `TQueryFnData` and can be configured independently of it.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type QueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = {\n [Property in keyof QueryObserverOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >]: Property extends 'enabled'\n ?\n | MaybeRefOrGetter<boolean | undefined>\n | (() => QueryBooleanOption<\n TQueryFnData,\n TError,\n TQueryData,\n DeepUnwrapRef<TQueryKey>\n >)\n : Property extends 'queryKey'\n ? MaybeRefOrGetter<TQueryKey>\n : QueryObserverOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n DeepUnwrapRef<TQueryKey>\n >[Property]\n} & ShallowOption\n\n// Widen the type of the symbol to enable type inference even if skipToken is not immutable.\ntype SkipTokenForUseQuery = symbol\n\n/**\n * The options accepted by `queryOptions`, `useQuery`, and the other query hooks. `enabled` tracks reactive\n * dependencies automatically as a `ref`, a plain value, or a reactive getter (`() => ...`). `queryKey` reacts\n * through a `ref` or a reactive getter for the array itself, or `ref`s and reactive getters as individual\n * entries. Other options are read once when passed as a plain value, and stay reactive when passed as a `ref`\n * or a `computed`. Only `enabled` and `queryKey` read a function as a getter, so `queryFn` reacts through a\n * `computed`: a function there is the query function itself.\n *\n * If you instead pass a getter for the whole options object (`useQuery(() => ({ ... }))`), every option\n * inside it — including `staleTime`, `retry`, and `select` — is re-evaluated whenever the getter's own\n * reactive dependencies change, since the entire object is recomputed.\n *\n * `select` only re-runs when `data` changes, or when the `select` function's own reference changes. Since a\n * Vue `setup()` function runs only once per component instance, an inline `select` function passed directly\n * to `queryOptions`/`useQuery` already has a stable reference across reactive updates. An inline `select`\n * created inside a whole-options getter is recreated — and so can change reference — every time that getter\n * re-evaluates.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryData - The type of data stored in the cache, before `select` runs. Defaults to\n * `TQueryFnData` and can be configured independently of it.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type UseQueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = MaybeRef<\n {\n [Property in keyof QueryObserverOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >]: Property extends 'enabled' | 'queryKey'\n ? QueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >[Property]\n : Property extends 'queryFn'\n ? MaybeRefDeep<\n | QueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >[Property]\n | SkipTokenForUseQuery\n >\n : MaybeRefDeep<\n QueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >[Property]\n >\n } & ShallowOption\n>\n\ntype WithUndefinedInitialData<TQueryFnData> = {\n /**\n * If set, this value will be used as the initial data for the query cache (as long as the query hasn't been\n * created or cached yet). If set to a function, the function will be called **once** during the shared/root\n * query initialization, and be expected to synchronously return the initial data. Initial data is\n * considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the\n * cache. Unlike `queryKey`/`enabled`, this is not reactive — it isn't re-evaluated on `ref` changes.\n */\n initialData?:\n | undefined\n | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>\n | NonUndefinedGuard<TQueryFnData>\n}\n\ntype WithDefinedInitialData<TQueryFnData> = {\n /**\n * If set, this value will be used as the initial data for the query cache (as long as the query hasn't been\n * created or cached yet). If set to a function, the function will be called **once** during the shared/root\n * query initialization, and be expected to synchronously return the initial data. Initial data is\n * considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the\n * cache. Unlike `queryKey`/`enabled`, this is not reactive — it isn't re-evaluated on `ref` changes.\n */\n initialData:\n | NonUndefinedGuard<TQueryFnData>\n | (() => NonUndefinedGuard<TQueryFnData>)\n}\n\n/**\n * The options accepted by the `queryOptions` overload selected when no `initialData` is set — `data` may be\n * `undefined` while the query is `pending`.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type UndefinedInitialQueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithUndefinedInitialData<TQueryFnData>\n\n/**\n * The options accepted by the `queryOptions` overload selected when `initialData` is set — `data` is never\n * `undefined`.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type DefinedInitialQueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithDefinedInitialData<TQueryFnData>\n\nexport type UndefinedInitialQueryOptionsWithDataTag<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = QueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithUndefinedInitialData<TQueryFnData> &\n QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>\n\nexport type DefinedInitialQueryOptionsWithDataTag<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = QueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithDefinedInitialData<TQueryFnData> &\n QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>\n\n/**\n * You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can\n * be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and\n * is the query key to generate options for.\n *\n * This overload is selected when `initialData` is set, so the resulting `data` is never `undefined`.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - The {@link DefinedInitialQueryOptions} to use — everything you can pass to `useQuery`, with\n * `initialData` set.\n * @returns The same options object, typed so that `queryKey` carries the inferred data type.\n *\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, useQuery } from '@tanstack/vue-query'\n *\n * const postsOptions = queryOptions({\n * queryKey: ['posts'],\n * queryFn: fetchPosts,\n * initialData: [],\n * })\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(postsOptions)\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): DefinedInitialQueryOptionsWithDataTag<TQueryFnData, TError, TData, TQueryKey>\n\n/**\n * Same as the plain-object overload, but for options that close over reactive state (`ref`s read inside the\n * function body). Wrap them in a getter so `queryClient` methods like `invalidateQueries`/`fetchQuery` always\n * read the current values instead of the ones captured when the options were created.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - A function returning the {@link DefinedInitialQueryOptions} to use, re-evaluated on demand.\n * @returns A function that returns the same options object, typed so that `queryKey` carries the inferred data\n * type.\n *\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { queryOptions, useQuery } from '@tanstack/vue-query'\n *\n * const postId = ref(1)\n * const postOptions = queryOptions(() => ({\n * queryKey: ['post', postId.value],\n * queryFn: () => fetchPost(postId.value),\n * initialData: { id: postId.value, title: '' },\n * }))\n *\n * // Pass the getter itself, not `postOptions()`, so the query keeps reacting to `postId` changes.\n * const { data } = useQuery(postOptions)\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: () => DefinedInitialQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >,\n): () => DefinedInitialQueryOptionsWithDataTag<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n>\n\n/**\n * You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can\n * be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and\n * is the query key to generate options for.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - The {@link UndefinedInitialQueryOptions} to use — everything you can pass to `useQuery`.\n * @returns The same options object, typed so that `queryKey` carries the inferred data type.\n *\n * @example\n * A parameterized factory, so the same options object can be reused per `id`:\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, useQuery } from '@tanstack/vue-query'\n *\n * function postOptions(id: string) {\n * return queryOptions({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * })\n * }\n *\n * const { data, isPending, isError, error } = useQuery(postOptions('1'))\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UndefinedInitialQueryOptionsWithDataTag<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n>\n\n/**\n * Same as the plain-object overload, but for options that close over reactive state (`ref`s read inside the\n * function body). Wrap them in a getter so the `queryKey` — and anything else derived from a `ref` — reacts\n * to changes, and so `queryClient` methods like `invalidateQueries`/`fetchQuery` always read the current\n * values instead of the ones captured when the options were created.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - A function returning the {@link UndefinedInitialQueryOptions} to use, re-evaluated on\n * demand.\n * @returns A function that returns the same options object, typed so that `queryKey` carries the inferred\n * data type.\n *\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { queryOptions, useQuery, useQueryClient } from '@tanstack/vue-query'\n *\n * const postId = ref(1)\n * const postOptions = queryOptions(() => ({\n * queryKey: ['post', postId.value],\n * queryFn: () => fetchPost(postId.value),\n * }))\n *\n * // Pass the getter itself, not `postOptions()`, so the query keeps reacting to `postId` changes.\n * const { data } = useQuery(postOptions)\n * const queryClient = useQueryClient()\n * // Here, call `postOptions()` so `invalidateQueries` reads the current `queryKey` right away.\n * queryClient.invalidateQueries(postOptions())\n * </script>\n * ```\n *\n * @example\n * A parameterized factory that disables the query, type safe, until `postId` is set. The whole-options getter\n * re-evaluates `queryFn` on every change to `postId`. `queryFn` can also be a `computed`, but never a bare\n * getter, since a function there is the query function itself:\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, skipToken, useQuery } from '@tanstack/vue-query'\n *\n * function postOptions(postId: number | undefined) {\n * return queryOptions(() => ({\n * queryKey: ['post', postId],\n * queryFn: postId != null ? () => fetchPost(postId) : skipToken,\n * }))\n * }\n *\n * const props = defineProps<{ postId: number | undefined }>()\n * const { data, isLoading, isError, error } = useQuery(postOptions(props.postId))\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: () => UndefinedInitialQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >,\n): () => UndefinedInitialQueryOptionsWithDataTag<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n>\n\nexport function queryOptions(options: unknown) {\n return options\n}\n"],"mappings":";AA0ZA,SAAgB,aAAa,SAAkB;CAC7C,OAAO;AACT"}
|
|
1
|
+
{"version":3,"file":"queryOptions.js","names":[],"sources":["../../src/queryOptions.ts"],"sourcesContent":["import type {\n DeepUnwrapRef,\n MaybeRef,\n MaybeRefDeep,\n MaybeRefOrGetter,\n ShallowOption,\n} from './types'\nimport type {\n DefaultError,\n InitialDataFunction,\n NonUndefinedGuard,\n QueryBooleanOption,\n QueryKey,\n QueryKeyWithDataTag,\n QueryObserverOptions,\n} from '@tanstack/query-core'\n\n/**\n * The plain, unwrapped options that `queryOptions` hands back, and what `useQuery`, `useQueries`, and the\n * `queryClient` methods see once `ref`s have been resolved. To pass options in, use\n * {@link UseQueryOptions}, which accepts the same options as `ref`s and `computed`s too.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryData - The type of data stored in the cache, before `select` runs. Defaults to\n * `TQueryFnData` and can be configured independently of it.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type QueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = {\n [\n Property in keyof QueryObserverOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >\n ]: Property extends 'enabled'\n ? | MaybeRefOrGetter<boolean | undefined>\n | (() => QueryBooleanOption<\n TQueryFnData,\n TError,\n TQueryData,\n DeepUnwrapRef<TQueryKey>\n >)\n : Property extends 'queryKey'\n ? MaybeRefOrGetter<TQueryKey>\n : QueryObserverOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n DeepUnwrapRef<TQueryKey>\n >[Property]\n} & ShallowOption\n\n// Widen the type of the symbol to enable type inference even if skipToken is not immutable.\ntype SkipTokenForUseQuery = symbol\n\n/**\n * The options accepted by `queryOptions`, `useQuery`, and the other query hooks. `enabled` tracks reactive\n * dependencies automatically as a `ref`, a plain value, or a reactive getter (`() => ...`). `queryKey` reacts\n * through a `ref` or a reactive getter for the array itself, or `ref`s and reactive getters as individual\n * entries. Other options are read once when passed as a plain value, and stay reactive when passed as a `ref`\n * or a `computed`. Only `enabled` and `queryKey` read a function as a getter, so `queryFn` reacts through a\n * `computed`: a function there is the query function itself.\n *\n * If you instead pass a getter for the whole options object (`useQuery(() => ({ ... }))`), every option\n * inside it — including `staleTime`, `retry`, and `select` — is re-evaluated whenever the getter's own\n * reactive dependencies change, since the entire object is recomputed.\n *\n * `select` only re-runs when `data` changes, or when the `select` function's own reference changes. Since a\n * Vue `setup()` function runs only once per component instance, an inline `select` function passed directly\n * to `queryOptions`/`useQuery` already has a stable reference across reactive updates. An inline `select`\n * created inside a whole-options getter is recreated — and so can change reference — every time that getter\n * re-evaluates.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryData - The type of data stored in the cache, before `select` runs. Defaults to\n * `TQueryFnData` and can be configured independently of it.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type UseQueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = MaybeRef<\n {\n [\n Property in keyof QueryObserverOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >\n ]: Property extends 'enabled' | 'queryKey'\n ? QueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >[Property]\n : Property extends 'queryFn'\n ? MaybeRefDeep<\n | QueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >[Property]\n | SkipTokenForUseQuery\n >\n : MaybeRefDeep<\n QueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryData,\n TQueryKey\n >[Property]\n >\n } & ShallowOption\n>\n\ntype WithUndefinedInitialData<TQueryFnData> = {\n /**\n * If set, this value will be used as the initial data for the query cache (as long as the query hasn't been\n * created or cached yet). If set to a function, the function will be called **once** during the shared/root\n * query initialization, and be expected to synchronously return the initial data. Initial data is\n * considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the\n * cache. Unlike `queryKey`/`enabled`, this is not reactive — it isn't re-evaluated on `ref` changes.\n */\n initialData?:\n | undefined\n | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>\n | NonUndefinedGuard<TQueryFnData>\n}\n\ntype WithDefinedInitialData<TQueryFnData> = {\n /**\n * If set, this value will be used as the initial data for the query cache (as long as the query hasn't been\n * created or cached yet). If set to a function, the function will be called **once** during the shared/root\n * query initialization, and be expected to synchronously return the initial data. Initial data is\n * considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the\n * cache. Unlike `queryKey`/`enabled`, this is not reactive — it isn't re-evaluated on `ref` changes.\n */\n initialData:\n NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>)\n}\n\n/**\n * The options accepted by the `queryOptions` overload selected when no `initialData` is set — `data` may be\n * `undefined` while the query is `pending`.\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type UndefinedInitialQueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithUndefinedInitialData<TQueryFnData>\n\n/**\n * The options accepted by the `queryOptions` overload selected when `initialData` is set — `data` is never\n * `undefined` (unless a `select` changes `TData` to include `undefined`).\n *\n * @template TQueryFnData - The type your `queryFn` resolves to.\n * @template TError - The type of errors your `queryFn` may throw.\n * @template TData - The type `data` ends up as after `select` runs.\n * @template TQueryKey - The type of your `queryKey`.\n */\nexport type DefinedInitialQueryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithDefinedInitialData<TQueryFnData>\n\nexport type UndefinedInitialQueryOptionsWithDataTag<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = QueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithUndefinedInitialData<TQueryFnData> &\n QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>\n\nexport type DefinedInitialQueryOptionsWithDataTag<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = QueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> &\n WithDefinedInitialData<TQueryFnData> &\n QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>\n\n/**\n * You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can\n * be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and\n * is the query key to generate options for.\n *\n * This overload is selected when `initialData` is set, so the resulting `data` is never `undefined` (unless\n * a `select` changes `TData` to include `undefined`).\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - The {@link DefinedInitialQueryOptions} to use — everything you can pass to `useQuery`, with\n * `initialData` set.\n * @returns The same options object, typed so that `queryKey` carries the inferred data type.\n *\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, useQuery } from '@tanstack/vue-query'\n *\n * const postsOptions = queryOptions({\n * queryKey: ['posts'],\n * queryFn: fetchPosts,\n * initialData: [],\n * })\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(postsOptions)\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): DefinedInitialQueryOptionsWithDataTag<TQueryFnData, TError, TData, TQueryKey>\n\n/**\n * Same as the plain-object overload, but for options that close over reactive state (`ref`s read inside the\n * function body). Wrap them in a getter so `queryClient` methods like `invalidateQueries`/`fetchQuery` always\n * read the current values instead of the ones captured when the options were created.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - A function returning the {@link DefinedInitialQueryOptions} to use, re-evaluated on demand.\n * @returns A function that returns the same options object, typed so that `queryKey` carries the inferred data\n * type.\n *\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { queryOptions, useQuery } from '@tanstack/vue-query'\n *\n * const postId = ref(1)\n * const postOptions = queryOptions(() => ({\n * queryKey: ['post', postId.value],\n * queryFn: () => fetchPost(postId.value),\n * initialData: { id: postId.value, title: '' },\n * }))\n *\n * // Pass the getter itself, not `postOptions()`, so the query keeps reacting to `postId` changes.\n * const { data } = useQuery(postOptions)\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: () => DefinedInitialQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >,\n): () => DefinedInitialQueryOptionsWithDataTag<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n>\n\n/**\n * You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can\n * be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and\n * is the query key to generate options for.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - The {@link UndefinedInitialQueryOptions} to use — everything you can pass to `useQuery`.\n * @returns The same options object, typed so that `queryKey` carries the inferred data type.\n *\n * @example\n * A parameterized factory, so the same options object can be reused per `id`:\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, useQuery } from '@tanstack/vue-query'\n *\n * function postOptions(id: string) {\n * return queryOptions({\n * queryKey: ['post', id],\n * queryFn: () => fetchPost(id),\n * })\n * }\n *\n * const { data, isPending, isError, error } = useQuery(postOptions('1'))\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UndefinedInitialQueryOptionsWithDataTag<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n>\n\n/**\n * Same as the plain-object overload, but for options that close over reactive state (`ref`s read inside the\n * function body). Wrap them in a getter so the `queryKey` — and anything else derived from a `ref` — reacts\n * to changes, and so `queryClient` methods like `invalidateQueries`/`fetchQuery` always read the current\n * values instead of the ones captured when the options were created.\n *\n * @see {@link useQuery} to run a query with these options.\n * @param options - A function returning the {@link UndefinedInitialQueryOptions} to use, re-evaluated on\n * demand.\n * @returns A function that returns the same options object, typed so that `queryKey` carries the inferred\n * data type.\n *\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { ref } from 'vue'\n * import { queryOptions, useQuery, useQueryClient } from '@tanstack/vue-query'\n *\n * const postId = ref(1)\n * const postOptions = queryOptions(() => ({\n * queryKey: ['post', postId.value],\n * queryFn: () => fetchPost(postId.value),\n * }))\n *\n * // Pass the getter itself, not `postOptions()`, so the query keeps reacting to `postId` changes.\n * const { data } = useQuery(postOptions)\n * const queryClient = useQueryClient()\n * // Here, call `postOptions()` so `invalidateQueries` reads the current `queryKey` right away.\n * queryClient.invalidateQueries(postOptions())\n * </script>\n * ```\n *\n * @example\n * A parameterized factory that disables the query, type safe, until `postId` is set. The whole-options getter\n * re-evaluates `queryFn` on every change to `postId`. `queryFn` can also be a `computed`, but never a bare\n * getter, since a function there is the query function itself:\n * ```vue\n * <script setup lang=\"ts\">\n * import { queryOptions, skipToken, useQuery } from '@tanstack/vue-query'\n *\n * function postOptions(postId: number | undefined) {\n * return queryOptions(() => ({\n * queryKey: ['post', postId],\n * queryFn: postId != null ? () => fetchPost(postId) : skipToken,\n * }))\n * }\n *\n * const props = defineProps<{ postId: number | undefined }>()\n * const { data, isLoading, isError, error } = useQuery(postOptions(props.postId))\n * </script>\n * ```\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: () => UndefinedInitialQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >,\n): () => UndefinedInitialQueryOptionsWithDataTag<\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n>\n\nexport function queryOptions(options: unknown) {\n return options\n}\n"],"mappings":";AA6ZA,SAAgB,aAAa,SAAkB;CAC7C,OAAO;AACT"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types-JpJB72CS.d.cts","names":[],"sources":["../../src/types.ts"],"mappings":";;;KAYK;KACA,aACD,YACA,WACA,OACA,QACA,SACA,gBACA,oBACA,WACA;;KAGQ,YAAY,KAAK,WAAW;;;;;KAM5B,SAAS,KAAK,IAAI,KAAK,YAAY,KAAK;;;;;;KAOxC,iBAAiB,KAAK,SAAS,YAAY;;;;;;KAO3C,aAAa,KAAK,SAC5B,UAAU,WACN,IACA,sBAEK,kBAAkB,IAAI,aAAa,EAAE,gBAExC;;KAII,UAAU,KAAK,eAAe,0BAA0B;;KAGxD,MAAM,UAAU,cACxB,QAAQ,UAAU,4BAA2B,QAAQ,UAAU;;KAOvD,cAAc,KAAK,UAAU,aACrC,IACA,UAAU,UAAU,KAClB,cAAc,KACd,kBAEK,kBAAkB,IAAI,cAAc,EAAE,gBAEzC,UAAU;KAEN;;;;EAIV;;KAGU,gBACV,iBACA,SAAS,cACT,mBACA,6BACE,UACF,wBAAwB,OAAO,QAAQ,YAAY,kCAGnD;
|
|
1
|
+
{"version":3,"file":"types-JpJB72CS.d.cts","names":["DefaultOptions"],"sources":["../../src/types.ts"],"mappings":";;;KAYK;KACA,aACD,YACA,WACA,OACA,QACA,SACA,gBACA,oBACA,WACA;;KAGQ,YAAY,KAAK,WAAW;;;;;KAM5B,SAAS,KAAK,IAAI,KAAK,YAAY,KAAK;;;;;;KAOxC,iBAAiB,KAAK,SAAS,YAAY;;;;;;KAO3C,aAAa,KAAK,SAC5B,UAAU,WACN,IACA,sBAEK,kBAAkB,IAAI,aAAa,EAAE,gBAExC;;KAII,UAAU,KAAK,eAAe,0BAA0B;;KAGxD,MAAM,UAAU,cACxB,QAAQ,UAAU,4BAA2B,QAAQ,UAAU;;KAOvD,cAAc,KAAK,UAAU,aACrC,IACA,UAAU,UAAU,KAClB,cAAc,KACd,kBAEK,kBAAkB,IAAI,cAAc,EAAE,gBAEzC,UAAU;KAEN;;;;EAIV;;KAGU,gBACV,iBACA,SAAS,cACT,mBACA,6BACE,UACF,wBAAwB,OAAO,QAAQ,YAAY,kCAGnD;UAEeA,iBAAe,SAAS;EACvC,UAAU,UAAU,8BAA8B,uBAChD;EACF,YAAY,iCAAiC,4BAC3C;EACF,UAAU;EACV,YAAY;;UAGG;EACf,aAAa;EACb,gBAAgB;EAChB,iBAAiBA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types-JpJB72CS.d.ts","names":[],"sources":["../../src/types.ts"],"mappings":";;;KAYK;KACA,aACD,YACA,WACA,OACA,QACA,SACA,gBACA,oBACA,WACA;;KAGQ,YAAY,KAAK,WAAW;;;;;KAM5B,SAAS,KAAK,IAAI,KAAK,YAAY,KAAK;;;;;;KAOxC,iBAAiB,KAAK,SAAS,YAAY;;;;;;KAO3C,aAAa,KAAK,SAC5B,UAAU,WACN,IACA,sBAEK,kBAAkB,IAAI,aAAa,EAAE,gBAExC;;KAII,UAAU,KAAK,eAAe,0BAA0B;;KAGxD,MAAM,UAAU,cACxB,QAAQ,UAAU,4BAA2B,QAAQ,UAAU;;KAOvD,cAAc,KAAK,UAAU,aACrC,IACA,UAAU,UAAU,KAClB,cAAc,KACd,kBAEK,kBAAkB,IAAI,cAAc,EAAE,gBAEzC,UAAU;KAEN;;;;EAIV;;KAGU,gBACV,iBACA,SAAS,cACT,mBACA,6BACE,UACF,wBAAwB,OAAO,QAAQ,YAAY,kCAGnD;
|
|
1
|
+
{"version":3,"file":"types-JpJB72CS.d.ts","names":["DefaultOptions"],"sources":["../../src/types.ts"],"mappings":";;;KAYK;KACA,aACD,YACA,WACA,OACA,QACA,SACA,gBACA,oBACA,WACA;;KAGQ,YAAY,KAAK,WAAW;;;;;KAM5B,SAAS,KAAK,IAAI,KAAK,YAAY,KAAK;;;;;;KAOxC,iBAAiB,KAAK,SAAS,YAAY;;;;;;KAO3C,aAAa,KAAK,SAC5B,UAAU,WACN,IACA,sBAEK,kBAAkB,IAAI,aAAa,EAAE,gBAExC;;KAII,UAAU,KAAK,eAAe,0BAA0B;;KAGxD,MAAM,UAAU,cACxB,QAAQ,UAAU,4BAA2B,QAAQ,UAAU;;KAOvD,cAAc,KAAK,UAAU,aACrC,IACA,UAAU,UAAU,KAClB,cAAc,KACd,kBAEK,kBAAkB,IAAI,cAAc,EAAE,gBAEzC,UAAU;KAEN;;;;EAIV;;KAGU,gBACV,iBACA,SAAS,cACT,mBACA,6BACE,UACF,wBAAwB,OAAO,QAAQ,YAAY,kCAGnD;UAEeA,iBAAe,SAAS;EACvC,UAAU,UAAU,8BAA8B,uBAChD;EACF,YAAY,iCAAiC,4BAC3C;EACF,UAAU;EACV,YAAY;;UAGG;EACf,aAAa;EACb,gBAAgB;EAChB,iBAAiBA"}
|