Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/dark-birds-turn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/vue-query': minor
---

feat(vue-query): support useQuery options getter
18 changes: 18 additions & 0 deletions packages/vue-query/src/__tests__/useQuery.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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'],
Expand Down
6 changes: 5 additions & 1 deletion packages/vue-query/src/useBaseQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
16 changes: 4 additions & 12 deletions packages/vue-query/src/useQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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,
):
Expand Down
Loading