@tanstack/vue-query 5.53.3 → 5.54.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (125) hide show
  1. package/build/legacy/devtools/devtools.d.cts +1 -1
  2. package/build/legacy/devtools/devtools.d.ts +1 -1
  3. package/build/legacy/index.d.cts +1 -2
  4. package/build/legacy/index.d.ts +1 -2
  5. package/build/legacy/infiniteQueryOptions.d.cts +1 -2
  6. package/build/legacy/infiniteQueryOptions.d.ts +1 -2
  7. package/build/legacy/queryClient-Bq4NnYa7.d.ts +73 -0
  8. package/build/legacy/queryClient-v1s104Ur.d.cts +73 -0
  9. package/build/legacy/queryClient.cjs.map +1 -1
  10. package/build/legacy/queryClient.d.cts +4 -39
  11. package/build/legacy/queryClient.d.ts +4 -39
  12. package/build/legacy/queryClient.js.map +1 -1
  13. package/build/legacy/queryOptions.d.cts +1 -2
  14. package/build/legacy/queryOptions.d.ts +1 -2
  15. package/build/legacy/useBaseQuery.cjs +6 -2
  16. package/build/legacy/useBaseQuery.cjs.map +1 -1
  17. package/build/legacy/useBaseQuery.d.cts +1 -2
  18. package/build/legacy/useBaseQuery.d.ts +1 -2
  19. package/build/legacy/useBaseQuery.js +8 -3
  20. package/build/legacy/useBaseQuery.js.map +1 -1
  21. package/build/legacy/useInfiniteQuery.cjs.map +1 -1
  22. package/build/legacy/useInfiniteQuery.d.cts +1 -2
  23. package/build/legacy/useInfiniteQuery.d.ts +1 -2
  24. package/build/legacy/useInfiniteQuery.js.map +1 -1
  25. package/build/legacy/useIsFetching.d.cts +1 -1
  26. package/build/legacy/useIsFetching.d.ts +1 -1
  27. package/build/legacy/useMutation.cjs +3 -2
  28. package/build/legacy/useMutation.cjs.map +1 -1
  29. package/build/legacy/useMutation.d.cts +7 -4
  30. package/build/legacy/useMutation.d.ts +7 -4
  31. package/build/legacy/useMutation.js +5 -3
  32. package/build/legacy/useMutation.js.map +1 -1
  33. package/build/legacy/useMutationState.cjs +2 -2
  34. package/build/legacy/useMutationState.cjs.map +1 -1
  35. package/build/legacy/useMutationState.d.cts +3 -3
  36. package/build/legacy/useMutationState.d.ts +3 -3
  37. package/build/legacy/useMutationState.js +4 -4
  38. package/build/legacy/useMutationState.js.map +1 -1
  39. package/build/legacy/useQueries.cjs +1 -1
  40. package/build/legacy/useQueries.cjs.map +1 -1
  41. package/build/legacy/useQueries.d.cts +2 -2
  42. package/build/legacy/useQueries.d.ts +2 -2
  43. package/build/legacy/useQueries.js +2 -1
  44. package/build/legacy/useQueries.js.map +1 -1
  45. package/build/legacy/useQuery.cjs.map +1 -1
  46. package/build/legacy/useQuery.d.cts +1 -2
  47. package/build/legacy/useQuery.d.ts +1 -2
  48. package/build/legacy/useQuery.js.map +1 -1
  49. package/build/legacy/useQueryClient.d.cts +1 -1
  50. package/build/legacy/useQueryClient.d.ts +1 -1
  51. package/build/legacy/utils.cjs.map +1 -1
  52. package/build/legacy/utils.d.cts +1 -1
  53. package/build/legacy/utils.d.ts +1 -1
  54. package/build/legacy/utils.js.map +1 -1
  55. package/build/legacy/vueQueryPlugin.d.cts +1 -1
  56. package/build/legacy/vueQueryPlugin.d.ts +1 -1
  57. package/build/modern/devtools/devtools.d.cts +1 -1
  58. package/build/modern/devtools/devtools.d.ts +1 -1
  59. package/build/modern/index.d.cts +1 -2
  60. package/build/modern/index.d.ts +1 -2
  61. package/build/modern/infiniteQueryOptions.d.cts +1 -2
  62. package/build/modern/infiniteQueryOptions.d.ts +1 -2
  63. package/build/modern/queryClient-Bq4NnYa7.d.ts +73 -0
  64. package/build/modern/queryClient-v1s104Ur.d.cts +73 -0
  65. package/build/modern/queryClient.cjs.map +1 -1
  66. package/build/modern/queryClient.d.cts +4 -39
  67. package/build/modern/queryClient.d.ts +4 -39
  68. package/build/modern/queryClient.js.map +1 -1
  69. package/build/modern/queryOptions.d.cts +1 -2
  70. package/build/modern/queryOptions.d.ts +1 -2
  71. package/build/modern/useBaseQuery.cjs +6 -2
  72. package/build/modern/useBaseQuery.cjs.map +1 -1
  73. package/build/modern/useBaseQuery.d.cts +1 -2
  74. package/build/modern/useBaseQuery.d.ts +1 -2
  75. package/build/modern/useBaseQuery.js +8 -3
  76. package/build/modern/useBaseQuery.js.map +1 -1
  77. package/build/modern/useInfiniteQuery.cjs.map +1 -1
  78. package/build/modern/useInfiniteQuery.d.cts +1 -2
  79. package/build/modern/useInfiniteQuery.d.ts +1 -2
  80. package/build/modern/useInfiniteQuery.js.map +1 -1
  81. package/build/modern/useIsFetching.d.cts +1 -1
  82. package/build/modern/useIsFetching.d.ts +1 -1
  83. package/build/modern/useMutation.cjs +3 -2
  84. package/build/modern/useMutation.cjs.map +1 -1
  85. package/build/modern/useMutation.d.cts +7 -4
  86. package/build/modern/useMutation.d.ts +7 -4
  87. package/build/modern/useMutation.js +5 -3
  88. package/build/modern/useMutation.js.map +1 -1
  89. package/build/modern/useMutationState.cjs +2 -2
  90. package/build/modern/useMutationState.cjs.map +1 -1
  91. package/build/modern/useMutationState.d.cts +3 -3
  92. package/build/modern/useMutationState.d.ts +3 -3
  93. package/build/modern/useMutationState.js +4 -4
  94. package/build/modern/useMutationState.js.map +1 -1
  95. package/build/modern/useQueries.cjs +1 -1
  96. package/build/modern/useQueries.cjs.map +1 -1
  97. package/build/modern/useQueries.d.cts +2 -2
  98. package/build/modern/useQueries.d.ts +2 -2
  99. package/build/modern/useQueries.js +2 -1
  100. package/build/modern/useQueries.js.map +1 -1
  101. package/build/modern/useQuery.cjs.map +1 -1
  102. package/build/modern/useQuery.d.cts +1 -2
  103. package/build/modern/useQuery.d.ts +1 -2
  104. package/build/modern/useQuery.js.map +1 -1
  105. package/build/modern/useQueryClient.d.cts +1 -1
  106. package/build/modern/useQueryClient.d.ts +1 -1
  107. package/build/modern/utils.cjs.map +1 -1
  108. package/build/modern/utils.d.cts +1 -1
  109. package/build/modern/utils.d.ts +1 -1
  110. package/build/modern/utils.js.map +1 -1
  111. package/build/modern/vueQueryPlugin.d.cts +1 -1
  112. package/build/modern/vueQueryPlugin.d.ts +1 -1
  113. package/package.json +2 -2
  114. package/src/queryClient.ts +17 -4
  115. package/src/useBaseQuery.ts +12 -3
  116. package/src/useInfiniteQuery.ts +2 -0
  117. package/src/useMutation.ts +18 -5
  118. package/src/useMutationState.ts +8 -6
  119. package/src/useQueries.ts +7 -1
  120. package/src/useQuery.ts +31 -27
  121. package/src/utils.ts +1 -1
  122. package/build/legacy/useQuery-COgIjrX4.d.cts +0 -36
  123. package/build/legacy/useQuery-ClcdoQsm.d.ts +0 -36
  124. package/build/modern/useQuery-COgIjrX4.d.cts +0 -36
  125. package/build/modern/useQuery-ClcdoQsm.d.ts +0 -36
@@ -2,8 +2,9 @@ import {
2
2
  computed,
3
3
  getCurrentScope,
4
4
  onScopeDispose,
5
- reactive,
6
5
  readonly,
6
+ shallowReactive,
7
+ shallowReadonly,
7
8
  toRefs,
8
9
  watch,
9
10
  } from 'vue-demi'
@@ -26,12 +27,17 @@ type MutationResult<TData, TError, TVariables, TContext> = DistributiveOmit<
26
27
  'mutate' | 'reset'
27
28
  >
28
29
 
30
+ type UseMutationOptionsBase<TData, TError, TVariables, TContext> =
31
+ MutationObserverOptions<TData, TError, TVariables, TContext> & {
32
+ shallow?: boolean
33
+ }
34
+
29
35
  export type UseMutationOptions<
30
36
  TData = unknown,
31
37
  TError = DefaultError,
32
38
  TVariables = void,
33
39
  TContext = unknown,
34
- > = MaybeRefDeep<MutationObserverOptions<TData, TError, TVariables, TContext>>
40
+ > = MaybeRefDeep<UseMutationOptionsBase<TData, TError, TVariables, TContext>>
35
41
 
36
42
  type MutateSyncFunction<
37
43
  TData = unknown,
@@ -61,7 +67,7 @@ export function useMutation<
61
67
  TContext = unknown,
62
68
  >(
63
69
  mutationOptions: MaybeRefDeep<
64
- MutationObserverOptions<TData, TError, TVariables, TContext>
70
+ UseMutationOptionsBase<TData, TError, TVariables, TContext>
65
71
  >,
66
72
  queryClient?: QueryClient,
67
73
  ): UseMutationReturnType<TData, TError, TVariables, TContext> {
@@ -78,7 +84,7 @@ export function useMutation<
78
84
  return client.defaultMutationOptions(cloneDeepUnref(mutationOptions))
79
85
  })
80
86
  const observer = new MutationObserver(client, options.value)
81
- const state = reactive(observer.getCurrentResult())
87
+ const state = shallowReactive(observer.getCurrentResult())
82
88
 
83
89
  const unsubscribe = observer.subscribe((result) => {
84
90
  updateState(state, result)
@@ -101,7 +107,14 @@ export function useMutation<
101
107
  unsubscribe()
102
108
  })
103
109
 
104
- const resultRefs = toRefs(readonly(state)) as unknown as ToRefs<
110
+ const readonlyState =
111
+ process.env.NODE_ENV === 'production'
112
+ ? state
113
+ : options.value.shallow
114
+ ? shallowReadonly(state)
115
+ : readonly(state)
116
+
117
+ const resultRefs = toRefs(readonlyState) as ToRefs<
105
118
  Readonly<MutationResult<TData, TError, TVariables, TContext>>
106
119
  >
107
120
 
@@ -2,13 +2,13 @@ import {
2
2
  computed,
3
3
  getCurrentScope,
4
4
  onScopeDispose,
5
- readonly,
6
- ref,
5
+ shallowReadonly,
6
+ shallowRef,
7
7
  watch,
8
8
  } from 'vue-demi'
9
9
  import { useQueryClient } from './useQueryClient'
10
10
  import { cloneDeepUnref } from './utils'
11
- import type { DeepReadonly, Ref } from 'vue-demi'
11
+ import type { Ref } from 'vue-demi'
12
12
  import type {
13
13
  MutationFilters as MF,
14
14
  Mutation,
@@ -68,10 +68,12 @@ function getResult<TResult = MutationState>(
68
68
  export function useMutationState<TResult = MutationState>(
69
69
  options: MutationStateOptions<TResult> = {},
70
70
  queryClient?: QueryClient,
71
- ): DeepReadonly<Ref<Array<TResult>>> {
71
+ ): Readonly<Ref<Array<TResult>>> {
72
72
  const filters = computed(() => cloneDeepUnref(options.filters))
73
73
  const mutationCache = (queryClient || useQueryClient()).getMutationCache()
74
- const state = ref(getResult(mutationCache, options)) as Ref<Array<TResult>>
74
+ const state = shallowRef(getResult(mutationCache, options)) as Ref<
75
+ Array<TResult>
76
+ >
75
77
  const unsubscribe = mutationCache.subscribe(() => {
76
78
  const result = getResult(mutationCache, options)
77
79
  state.value = result
@@ -85,5 +87,5 @@ export function useMutationState<TResult = MutationState>(
85
87
  unsubscribe()
86
88
  })
87
89
 
88
- return readonly(state)
90
+ return shallowReadonly(state)
89
91
  }
package/src/useQueries.ts CHANGED
@@ -4,6 +4,7 @@ import {
4
4
  getCurrentScope,
5
5
  onScopeDispose,
6
6
  readonly,
7
+ shallowReadonly,
7
8
  shallowRef,
8
9
  unref,
9
10
  watch,
@@ -256,6 +257,7 @@ export function useQueries<
256
257
  }: {
257
258
  queries: MaybeRefDeep<UseQueriesOptionsArg<T>>
258
259
  combine?: (result: UseQueriesResults<T>) => TCombinedResult
260
+ shallow?: boolean
259
261
  },
260
262
  queryClient?: QueryClient,
261
263
  ): Readonly<Ref<TCombinedResult>> {
@@ -348,5 +350,9 @@ export function useQueries<
348
350
  unsubscribe()
349
351
  })
350
352
 
351
- return readonly(state) as Readonly<Ref<TCombinedResult>>
353
+ return process.env.NODE_ENV === 'production'
354
+ ? state
355
+ : options.shallow
356
+ ? shallowReadonly(state)
357
+ : (readonly(state) as Readonly<Ref<TCombinedResult>>)
352
358
  }
package/src/useQuery.ts CHANGED
@@ -23,33 +23,37 @@ export type UseQueryOptions<
23
23
  TData = TQueryFnData,
24
24
  TQueryData = TQueryFnData,
25
25
  TQueryKey extends QueryKey = QueryKey,
26
- > = MaybeRef<{
27
- [Property in keyof QueryObserverOptions<
28
- TQueryFnData,
29
- TError,
30
- TData,
31
- TQueryData,
32
- TQueryKey
33
- >]: Property extends 'enabled'
34
- ? MaybeRefOrGetter<
35
- QueryObserverOptions<
36
- TQueryFnData,
37
- TError,
38
- TData,
39
- TQueryData,
40
- DeepUnwrapRef<TQueryKey>
41
- >[Property]
42
- >
43
- : MaybeRefDeep<
44
- QueryObserverOptions<
45
- TQueryFnData,
46
- TError,
47
- TData,
48
- TQueryData,
49
- DeepUnwrapRef<TQueryKey>
50
- >[Property]
51
- >
52
- }>
26
+ > = MaybeRef<
27
+ {
28
+ [Property in keyof QueryObserverOptions<
29
+ TQueryFnData,
30
+ TError,
31
+ TData,
32
+ TQueryData,
33
+ TQueryKey
34
+ >]: Property extends 'enabled'
35
+ ? MaybeRefOrGetter<
36
+ QueryObserverOptions<
37
+ TQueryFnData,
38
+ TError,
39
+ TData,
40
+ TQueryData,
41
+ DeepUnwrapRef<TQueryKey>
42
+ >[Property]
43
+ >
44
+ : MaybeRefDeep<
45
+ QueryObserverOptions<
46
+ TQueryFnData,
47
+ TError,
48
+ TData,
49
+ TQueryData,
50
+ DeepUnwrapRef<TQueryKey>
51
+ >[Property]
52
+ >
53
+ } & {
54
+ shallow?: boolean
55
+ }
56
+ >
53
57
 
54
58
  export type UndefinedInitialQueryOptions<
55
59
  TQueryFnData = unknown,
package/src/utils.ts CHANGED
@@ -9,7 +9,7 @@ export function getClientKey(key?: string) {
9
9
  }
10
10
 
11
11
  export function updateState(
12
- state: Record<string, unknown>,
12
+ state: Record<string, any>,
13
13
  update: Record<string, any>,
14
14
  ): void {
15
15
  Object.keys(state).forEach((key) => {
@@ -1,36 +0,0 @@
1
- import { DefaultError, QueryKey, InfiniteQueryObserverOptions, InfiniteQueryObserverResult, InfiniteData, QueryObserverResult, QueryObserver, QueryObserverOptions, DefinedQueryObserverResult } from '@tanstack/query-core';
2
- import { Ref } from 'vue-demi';
3
- import { QueryClient } from './queryClient.cjs';
4
- import { MaybeRefOrGetter, DeepUnwrapRef, MaybeRefDeep, MaybeRef } from './types.cjs';
5
-
6
- type UseInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = {
7
- [Property in keyof InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>]: Property extends 'enabled' ? MaybeRefOrGetter<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>>[Property]> : MaybeRefDeep<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>, TPageParam>[Property]>;
8
- };
9
- type UseInfiniteQueryReturnType<TData, TError> = UseBaseQueryReturnType<TData, TError, InfiniteQueryObserverResult<TData, TError>>;
10
- declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>, queryClient?: QueryClient): UseInfiniteQueryReturnType<TData, TError>;
11
-
12
- type UseBaseQueryReturnType<TData, TError, TResult = QueryObserverResult<TData, TError>> = {
13
- [K in keyof TResult]: K extends 'fetchNextPage' | 'fetchPreviousPage' | 'refetch' ? TResult[K] : Ref<Readonly<TResult>[K]>;
14
- } & {
15
- suspense: () => Promise<TResult>;
16
- };
17
- type UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = UseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> | UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>;
18
- declare function useBaseQuery<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey, TPageParam>(Observer: typeof QueryObserver, options: UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, queryClient?: QueryClient): UseBaseQueryReturnType<TData, TError>;
19
-
20
- type NonUndefinedGuard<T> = T extends undefined ? never : T;
21
- type UseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = MaybeRef<{
22
- [Property in keyof QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>]: Property extends 'enabled' ? MaybeRefOrGetter<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>>[Property]> : MaybeRefDeep<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>>[Property]>;
23
- }>;
24
- type UndefinedInitialQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
25
- initialData?: undefined;
26
- };
27
- type DefinedInitialQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
28
- initialData: NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>);
29
- };
30
- type UseQueryReturnType<TData, TError> = UseBaseQueryReturnType<TData, TError>;
31
- type UseQueryDefinedReturnType<TData, TError> = UseBaseQueryReturnType<TData, TError, DefinedQueryObserverResult<TData, TError>>;
32
- declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): UseQueryReturnType<TData, TError>;
33
- declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): UseQueryDefinedReturnType<TData, TError>;
34
- declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, queryClient?: QueryClient): UseQueryReturnType<TData, TError>;
35
-
36
- export { type DefinedInitialQueryOptions as D, type UseQueryOptions as U, useInfiniteQuery as a, type UseQueryReturnType as b, type UseQueryDefinedReturnType as c, type UndefinedInitialQueryOptions as d, type UseInfiniteQueryOptions as e, type UseInfiniteQueryReturnType as f, type UseBaseQueryReturnType as g, useBaseQuery as h, useQuery as u };
@@ -1,36 +0,0 @@
1
- import { DefaultError, QueryKey, InfiniteQueryObserverOptions, InfiniteQueryObserverResult, InfiniteData, QueryObserverResult, QueryObserver, QueryObserverOptions, DefinedQueryObserverResult } from '@tanstack/query-core';
2
- import { Ref } from 'vue-demi';
3
- import { QueryClient } from './queryClient.js';
4
- import { MaybeRefOrGetter, DeepUnwrapRef, MaybeRefDeep, MaybeRef } from './types.js';
5
-
6
- type UseInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = {
7
- [Property in keyof InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>]: Property extends 'enabled' ? MaybeRefOrGetter<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>>[Property]> : MaybeRefDeep<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>, TPageParam>[Property]>;
8
- };
9
- type UseInfiniteQueryReturnType<TData, TError> = UseBaseQueryReturnType<TData, TError, InfiniteQueryObserverResult<TData, TError>>;
10
- declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>, queryClient?: QueryClient): UseInfiniteQueryReturnType<TData, TError>;
11
-
12
- type UseBaseQueryReturnType<TData, TError, TResult = QueryObserverResult<TData, TError>> = {
13
- [K in keyof TResult]: K extends 'fetchNextPage' | 'fetchPreviousPage' | 'refetch' ? TResult[K] : Ref<Readonly<TResult>[K]>;
14
- } & {
15
- suspense: () => Promise<TResult>;
16
- };
17
- type UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = UseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> | UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>;
18
- declare function useBaseQuery<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey, TPageParam>(Observer: typeof QueryObserver, options: UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, queryClient?: QueryClient): UseBaseQueryReturnType<TData, TError>;
19
-
20
- type NonUndefinedGuard<T> = T extends undefined ? never : T;
21
- type UseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = MaybeRef<{
22
- [Property in keyof QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>]: Property extends 'enabled' ? MaybeRefOrGetter<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>>[Property]> : MaybeRefDeep<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>>[Property]>;
23
- }>;
24
- type UndefinedInitialQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
25
- initialData?: undefined;
26
- };
27
- type DefinedInitialQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
28
- initialData: NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>);
29
- };
30
- type UseQueryReturnType<TData, TError> = UseBaseQueryReturnType<TData, TError>;
31
- type UseQueryDefinedReturnType<TData, TError> = UseBaseQueryReturnType<TData, TError, DefinedQueryObserverResult<TData, TError>>;
32
- declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): UseQueryReturnType<TData, TError>;
33
- declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): UseQueryDefinedReturnType<TData, TError>;
34
- declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, queryClient?: QueryClient): UseQueryReturnType<TData, TError>;
35
-
36
- export { type DefinedInitialQueryOptions as D, type UseQueryOptions as U, useInfiniteQuery as a, type UseQueryReturnType as b, type UseQueryDefinedReturnType as c, type UndefinedInitialQueryOptions as d, type UseInfiniteQueryOptions as e, type UseInfiniteQueryReturnType as f, type UseBaseQueryReturnType as g, useBaseQuery as h, useQuery as u };
@@ -1,36 +0,0 @@
1
- import { DefaultError, QueryKey, InfiniteQueryObserverOptions, InfiniteQueryObserverResult, InfiniteData, QueryObserverResult, QueryObserver, QueryObserverOptions, DefinedQueryObserverResult } from '@tanstack/query-core';
2
- import { Ref } from 'vue-demi';
3
- import { QueryClient } from './queryClient.cjs';
4
- import { MaybeRefOrGetter, DeepUnwrapRef, MaybeRefDeep, MaybeRef } from './types.cjs';
5
-
6
- type UseInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = {
7
- [Property in keyof InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>]: Property extends 'enabled' ? MaybeRefOrGetter<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>>[Property]> : MaybeRefDeep<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>, TPageParam>[Property]>;
8
- };
9
- type UseInfiniteQueryReturnType<TData, TError> = UseBaseQueryReturnType<TData, TError, InfiniteQueryObserverResult<TData, TError>>;
10
- declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>, queryClient?: QueryClient): UseInfiniteQueryReturnType<TData, TError>;
11
-
12
- type UseBaseQueryReturnType<TData, TError, TResult = QueryObserverResult<TData, TError>> = {
13
- [K in keyof TResult]: K extends 'fetchNextPage' | 'fetchPreviousPage' | 'refetch' ? TResult[K] : Ref<Readonly<TResult>[K]>;
14
- } & {
15
- suspense: () => Promise<TResult>;
16
- };
17
- type UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = UseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> | UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>;
18
- declare function useBaseQuery<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey, TPageParam>(Observer: typeof QueryObserver, options: UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, queryClient?: QueryClient): UseBaseQueryReturnType<TData, TError>;
19
-
20
- type NonUndefinedGuard<T> = T extends undefined ? never : T;
21
- type UseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = MaybeRef<{
22
- [Property in keyof QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>]: Property extends 'enabled' ? MaybeRefOrGetter<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>>[Property]> : MaybeRefDeep<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>>[Property]>;
23
- }>;
24
- type UndefinedInitialQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
25
- initialData?: undefined;
26
- };
27
- type DefinedInitialQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
28
- initialData: NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>);
29
- };
30
- type UseQueryReturnType<TData, TError> = UseBaseQueryReturnType<TData, TError>;
31
- type UseQueryDefinedReturnType<TData, TError> = UseBaseQueryReturnType<TData, TError, DefinedQueryObserverResult<TData, TError>>;
32
- declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): UseQueryReturnType<TData, TError>;
33
- declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): UseQueryDefinedReturnType<TData, TError>;
34
- declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, queryClient?: QueryClient): UseQueryReturnType<TData, TError>;
35
-
36
- export { type DefinedInitialQueryOptions as D, type UseQueryOptions as U, useInfiniteQuery as a, type UseQueryReturnType as b, type UseQueryDefinedReturnType as c, type UndefinedInitialQueryOptions as d, type UseInfiniteQueryOptions as e, type UseInfiniteQueryReturnType as f, type UseBaseQueryReturnType as g, useBaseQuery as h, useQuery as u };
@@ -1,36 +0,0 @@
1
- import { DefaultError, QueryKey, InfiniteQueryObserverOptions, InfiniteQueryObserverResult, InfiniteData, QueryObserverResult, QueryObserver, QueryObserverOptions, DefinedQueryObserverResult } from '@tanstack/query-core';
2
- import { Ref } from 'vue-demi';
3
- import { QueryClient } from './queryClient.js';
4
- import { MaybeRefOrGetter, DeepUnwrapRef, MaybeRefDeep, MaybeRef } from './types.js';
5
-
6
- type UseInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = {
7
- [Property in keyof InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>]: Property extends 'enabled' ? MaybeRefOrGetter<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>>[Property]> : MaybeRefDeep<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>, TPageParam>[Property]>;
8
- };
9
- type UseInfiniteQueryReturnType<TData, TError> = UseBaseQueryReturnType<TData, TError, InfiniteQueryObserverResult<TData, TError>>;
10
- declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>, queryClient?: QueryClient): UseInfiniteQueryReturnType<TData, TError>;
11
-
12
- type UseBaseQueryReturnType<TData, TError, TResult = QueryObserverResult<TData, TError>> = {
13
- [K in keyof TResult]: K extends 'fetchNextPage' | 'fetchPreviousPage' | 'refetch' ? TResult[K] : Ref<Readonly<TResult>[K]>;
14
- } & {
15
- suspense: () => Promise<TResult>;
16
- };
17
- type UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = UseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> | UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>;
18
- declare function useBaseQuery<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey, TPageParam>(Observer: typeof QueryObserver, options: UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, queryClient?: QueryClient): UseBaseQueryReturnType<TData, TError>;
19
-
20
- type NonUndefinedGuard<T> = T extends undefined ? never : T;
21
- type UseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = MaybeRef<{
22
- [Property in keyof QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>]: Property extends 'enabled' ? MaybeRefOrGetter<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>>[Property]> : MaybeRefDeep<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>>[Property]>;
23
- }>;
24
- type UndefinedInitialQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
25
- initialData?: undefined;
26
- };
27
- type DefinedInitialQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
28
- initialData: NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>);
29
- };
30
- type UseQueryReturnType<TData, TError> = UseBaseQueryReturnType<TData, TError>;
31
- type UseQueryDefinedReturnType<TData, TError> = UseBaseQueryReturnType<TData, TError, DefinedQueryObserverResult<TData, TError>>;
32
- declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): UseQueryReturnType<TData, TError>;
33
- declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): UseQueryDefinedReturnType<TData, TError>;
34
- declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, queryClient?: QueryClient): UseQueryReturnType<TData, TError>;
35
-
36
- export { type DefinedInitialQueryOptions as D, type UseQueryOptions as U, useInfiniteQuery as a, type UseQueryReturnType as b, type UseQueryDefinedReturnType as c, type UndefinedInitialQueryOptions as d, type UseInfiniteQueryOptions as e, type UseInfiniteQueryReturnType as f, type UseBaseQueryReturnType as g, useBaseQuery as h, useQuery as u };