Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(vue-query): ref unwrapping of QueryKey in queryOptions #7390

Merged
merged 2 commits into from
May 7, 2024
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
21 changes: 20 additions & 1 deletion packages/vue-query/src/__tests__/queryOptions.types.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe, it } from 'vitest'
import { reactive } from 'vue-demi'
import { reactive, ref } from 'vue-demi'
import { QueryClient } from '../queryClient'
import { queryOptions } from '../queryOptions'
import { useQuery } from '../useQuery'
Expand Down Expand Up @@ -148,4 +148,23 @@ describe('queryOptions', () => {
return result
})
})
it('should allow to be passed to QueryClient methods while containing ref in queryKey', () => {
doNotExecute(() => {
const options = queryOptions({
queryKey: ['key', ref(1), { nested: ref(2) }],
queryFn: () => Promise.resolve(5),
})

const queryClient = new QueryClient()

// Should not error
const data = queryClient.invalidateQueries(options)
// Should not error
const data2 = queryClient.fetchQuery(options)

const result: Expect<Equal<typeof data, Promise<void>>> = true
const result2: Expect<Equal<typeof data2, Promise<number>>> = true
return result || result2
})
})
})
53 changes: 20 additions & 33 deletions packages/vue-query/src/useInfiniteQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,39 +29,26 @@ export type UseInfiniteQueryOptions<
TQueryData,
TQueryKey,
TPageParam
>]: Property extends
| 'queryFn'
| 'getPreviousPageParam'
| 'getNextPageParam'
| 'select'
? InfiniteQueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
DeepUnwrapRef<TQueryKey>,
TPageParam
>[Property]
: Property extends 'enabled'
? MaybeRefOrGetter<
InfiniteQueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
TQueryKey
>[Property]
>
: MaybeRefDeep<
InfiniteQueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
TQueryKey,
TPageParam
>[Property]
>
>]: Property extends 'enabled'
? MaybeRefOrGetter<
InfiniteQueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
DeepUnwrapRef<TQueryKey>
>[Property]
>
: MaybeRefDeep<
InfiniteQueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
DeepUnwrapRef<TQueryKey>,
TPageParam
>[Property]
>
}

export type UseInfiniteQueryReturnType<TData, TError> = UseBaseQueryReturnType<
Expand Down
46 changes: 19 additions & 27 deletions packages/vue-query/src/useQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,33 +30,25 @@ export type UseQueryOptions<
TData,
TQueryData,
TQueryKey
>]: Property extends 'queryFn' | 'select'
? QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
DeepUnwrapRef<TQueryKey>
>[Property]
: Property extends 'enabled'
? MaybeRefOrGetter<
QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
TQueryKey
>[Property]
>
: MaybeRefDeep<
QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
TQueryKey
>[Property]
>
>]: Property extends 'enabled'
? MaybeRefOrGetter<
QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
DeepUnwrapRef<TQueryKey>
>[Property]
>
: MaybeRefDeep<
QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
DeepUnwrapRef<TQueryKey>
>[Property]
>
}>

export type UndefinedInitialQueryOptions<
Expand Down
Loading