feat(vue-query): support useQuery options getter (#9866)

Author: DamianOsipiuk

.changeset/dark-birds-turn.md

@@ -0,0 +1,5 @@
+---
+'@tanstack/vue-query': minor
+---
+
+feat(vue-query): support useQuery options getter

packages/vue-query/src/__tests__/useQuery.test.ts

@@ -44,6 +44,24 @@ describe('useQuery', () => {
     )
   })
 
+  test('should work with options getter', async () => {
+    const query = useQuery(() => ({
+      queryKey: ['key01'],
+      queryFn: () => sleep(0).then(() => 'result01'),
+    }))
+
+    await vi.advanceTimersByTimeAsync(0)
+
+    expect(query).toMatchObject({
+      status: { value: 'success' },
+      data: { value: 'result01' },
+      isPending: { value: false },
+      isFetching: { value: false },
+      isFetched: { value: true },
+      isSuccess: { value: true },
+    })
+  })
+
   test('should return pending status initially', () => {
     const query = useQuery({
       queryKey: ['key1'],

packages/vue-query/src/useBaseQuery.ts

@@ -82,7 +82,11 @@ export function useBaseQuery<
   const client = queryClient || useQueryClient()
 
   const defaultedOptions = computed(() => {
-    const clonedOptions = cloneDeepUnref(options as any)
+    let resolvedOptions = options
+    if (typeof resolvedOptions === 'function') {
+      resolvedOptions = resolvedOptions()
+    }
+    const clonedOptions = cloneDeepUnref(resolvedOptions as any)
 
     if (typeof clonedOptions.enabled === 'function') {
       clonedOptions.enabled = clonedOptions.enabled()

packages/vue-query/src/useQuery.ts

@@ -114,12 +114,8 @@ export function useQuery<
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 >(
-  options: UseQueryOptions<
-    TQueryFnData,
-    TError,
-    TData,
-    TQueryFnData,
-    TQueryKey
+  options: MaybeRefOrGetter<
+    UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>
   >,
   queryClient?: QueryClient,
 ): UseQueryReturnType<TData, TError>
@@ -130,12 +126,8 @@ export function useQuery<
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 >(
-  options: UseQueryOptions<
-    TQueryFnData,
-    TError,
-    TData,
-    TQueryFnData,
-    TQueryKey
+  options: MaybeRefOrGetter<
+    UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>
   >,
   queryClient?: QueryClient,
 ):