Skip to content

Commit d11280e

Browse files
aa900031aa900031
authored
feat(vue-query): useQuery support ref args (#5027)
* feat(vue-query): useQuery support ref args * fix: format * chore: remove `queryFn` as `MaybeRef` * Revert "chore: remove `queryFn` as `MaybeRef`" This reverts commit d2a2d6c.
1 parent 716c5d8 commit d11280e

File tree

2 files changed

+69
-49
lines changed

2 files changed

+69
-49
lines changed

‎packages/vue-query/src/useBaseQuery.ts‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,16 @@ export function useBaseQuery<
5252
>(
5353
Observer: typeof QueryObserver,
5454
arg1:
55-
| TQueryKey
56-
| UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryKey>,
55+
| MaybeRef<TQueryKey>
56+
| MaybeRef<UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryKey>>,
5757
arg2:
58-
| QueryFunction<TQueryFnData, DeepUnwrapRef<TQueryKey>>
59-
| UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryKey> = {},
60-
arg3: UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryKey> = {},
58+
| MaybeRef<QueryFunction<TQueryFnData, DeepUnwrapRef<TQueryKey>>>
59+
| MaybeRef<
60+
UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryKey>
61+
> = {},
62+
arg3: MaybeRef<
63+
UseQueryOptionsGeneric<TQueryFnData, TError, TData, TQueryKey>
64+
> = {},
6165
): UseQueryReturnType<TData, TError> {
6266
if (process.env.NODE_ENV === 'development') {
6367
if (!getCurrentScope()) {

‎packages/vue-query/src/useQuery.ts‎

Lines changed: 60 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import type { UseQueryReturnType as UQRT } from './useBaseQuery'
1111
import type {
1212
DeepUnwrapRef,
1313
DistributiveOmit,
14+
MaybeRef,
1415
VueQueryObserverOptions,
1516
WithQueryClientKey,
1617
} from './types'
@@ -47,10 +48,12 @@ export function useQuery<
4748
TData = TQueryFnData,
4849
TQueryKey extends QueryKey = QueryKey,
4950
>(
50-
options: Omit<
51-
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
52-
'initialData'
53-
> & { initialData?: () => undefined },
51+
options: MaybeRef<
52+
Omit<
53+
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
54+
'initialData'
55+
> & { initialData?: () => undefined }
56+
>,
5457
): UseQueryReturnType<TData, TError>
5558

5659
export function useQuery<
@@ -59,10 +62,12 @@ export function useQuery<
5962
TData = TQueryFnData,
6063
TQueryKey extends QueryKey = QueryKey,
6164
>(
62-
options: Omit<
63-
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
64-
'initialData'
65-
> & { initialData: TQueryFnData | (() => TQueryFnData) },
65+
options: MaybeRef<
66+
Omit<
67+
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
68+
'initialData'
69+
> & { initialData: TQueryFnData | (() => TQueryFnData) }
70+
>,
6671
): UseQueryDefinedReturnType<TData, TError>
6772

6873
export function useQuery<
@@ -71,7 +76,7 @@ export function useQuery<
7176
TData = TQueryFnData,
7277
TQueryKey extends QueryKey = QueryKey,
7378
>(
74-
options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
79+
options: MaybeRef<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>>,
7580
): UseQueryReturnType<TData, TError>
7681

7782
export function useQuery<
@@ -80,11 +85,13 @@ export function useQuery<
8085
TData = TQueryFnData,
8186
TQueryKey extends QueryKey = QueryKey,
8287
>(
83-
queryKey: TQueryKey,
84-
options?: Omit<
85-
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
86-
'queryKey' | 'initialData'
87-
> & { initialData?: () => undefined },
88+
queryKey: MaybeRef<TQueryKey>,
89+
options?: MaybeRef<
90+
Omit<
91+
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
92+
'queryKey' | 'initialData'
93+
> & { initialData?: () => undefined }
94+
>,
8895
): UseQueryReturnType<TData, TError>
8996

9097
export function useQuery<
@@ -93,11 +100,13 @@ export function useQuery<
93100
TData = TQueryFnData,
94101
TQueryKey extends QueryKey = QueryKey,
95102
>(
96-
queryKey: TQueryKey,
97-
options?: Omit<
98-
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
99-
'queryKey' | 'initialData'
100-
> & { initialData: TQueryFnData | (() => TQueryFnData) },
103+
queryKey: MaybeRef<TQueryKey>,
104+
options?: MaybeRef<
105+
Omit<
106+
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
107+
'queryKey' | 'initialData'
108+
> & { initialData: TQueryFnData | (() => TQueryFnData) }
109+
>,
101110
): UseQueryDefinedReturnType<TData, TError>
102111

103112
export function useQuery<
@@ -106,10 +115,9 @@ export function useQuery<
106115
TData = TQueryFnData,
107116
TQueryKey extends QueryKey = QueryKey,
108117
>(
109-
queryKey: TQueryKey,
110-
options?: Omit<
111-
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
112-
'queryKey'
118+
queryKey: MaybeRef<TQueryKey>,
119+
options?: MaybeRef<
120+
Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey'>
113121
>,
114122
): UseQueryReturnType<TData, TError>
115123

@@ -119,12 +127,14 @@ export function useQuery<
119127
TData = TQueryFnData,
120128
TQueryKey extends QueryKey = QueryKey,
121129
>(
122-
queryKey: TQueryKey,
123-
queryFn: QueryFunction<TQueryFnData, DeepUnwrapRef<TQueryKey>>,
124-
options?: Omit<
125-
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
126-
'queryKey' | 'queryFn' | 'initialData'
127-
> & { initialData?: () => undefined },
130+
queryKey: MaybeRef<TQueryKey>,
131+
queryFn: MaybeRef<QueryFunction<TQueryFnData, DeepUnwrapRef<TQueryKey>>>,
132+
options?: MaybeRef<
133+
Omit<
134+
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
135+
'queryKey' | 'queryFn' | 'initialData'
136+
> & { initialData?: () => undefined }
137+
>,
128138
): UseQueryReturnType<TData, TError>
129139

130140
export function useQuery<
@@ -133,12 +143,14 @@ export function useQuery<
133143
TData = TQueryFnData,
134144
TQueryKey extends QueryKey = QueryKey,
135145
>(
136-
queryKey: TQueryKey,
137-
queryFn: QueryFunction<TQueryFnData, DeepUnwrapRef<TQueryKey>>,
138-
options?: Omit<
139-
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
140-
'queryKey' | 'queryFn' | 'initialData'
141-
> & { initialData: TQueryFnData | (() => TQueryFnData) },
146+
queryKey: MaybeRef<TQueryKey>,
147+
queryFn: MaybeRef<QueryFunction<TQueryFnData, DeepUnwrapRef<TQueryKey>>>,
148+
options?: MaybeRef<
149+
Omit<
150+
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
151+
'queryKey' | 'queryFn' | 'initialData'
152+
> & { initialData: TQueryFnData | (() => TQueryFnData) }
153+
>,
142154
): UseQueryDefinedReturnType<TData, TError>
143155

144156
export function useQuery<
@@ -147,11 +159,13 @@ export function useQuery<
147159
TData = TQueryFnData,
148160
TQueryKey extends QueryKey = QueryKey,
149161
>(
150-
queryKey: TQueryKey,
151-
queryFn: QueryFunction<TQueryFnData, DeepUnwrapRef<TQueryKey>>,
152-
options?: Omit<
153-
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
154-
'queryKey' | 'queryFn'
162+
queryKey: MaybeRef<TQueryKey>,
163+
queryFn: MaybeRef<QueryFunction<TQueryFnData, DeepUnwrapRef<TQueryKey>>>,
164+
options?: MaybeRef<
165+
Omit<
166+
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
167+
'queryKey' | 'queryFn'
168+
>
155169
>,
156170
): UseQueryReturnType<TData, TError>
157171

@@ -161,11 +175,13 @@ export function useQuery<
161175
TData = TQueryFnData,
162176
TQueryKey extends QueryKey = QueryKey,
163177
>(
164-
arg1: TQueryKey | UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
178+
arg1:
179+
| MaybeRef<TQueryKey>
180+
| MaybeRef<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>>,
165181
arg2?:
166-
| QueryFunction<TQueryFnData, DeepUnwrapRef<TQueryKey>>
167-
| UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
168-
arg3?: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
182+
| MaybeRef<QueryFunction<TQueryFnData, DeepUnwrapRef<TQueryKey>>>
183+
| MaybeRef<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>>,
184+
arg3?: MaybeRef<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>>,
169185
):
170186
| UseQueryReturnType<TData, TError>
171187
| UseQueryDefinedReturnType<TData, TError> {

0 commit comments

Comments
 (0)