Skip to content
Open
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/vue-query-generic-querykey-inference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/vue-query': patch
---

fix(vue-query): preserve `TQueryKey` inference when wrapping `useQuery` in a composable with a generic param
27 changes: 25 additions & 2 deletions packages/vue-query/src/__tests__/useQuery.test-d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { describe, expectTypeOf, it } from 'vitest'
import { assertType, describe, expectTypeOf, it } from 'vitest'
import { computed, reactive, ref } from 'vue-demi'
import { queryKey, sleep } from '@tanstack/query-test-utils'
import { queryOptions, useQuery } from '..'
import type { OmitKeyof, UseQueryOptions } from '..'
import type { OmitKeyof, UseQueryOptions, UseQueryReturnType } from '..'

describe('useQuery', () => {
describe('Config object overload', () => {
Expand Down Expand Up @@ -152,6 +152,29 @@ describe('useQuery', () => {
})
})

describe('generic queryKey inference (#8199)', () => {
it('should not error when wrapping useQuery in a composable that propagates a generic type to the queryKey', () => {
const basket = { fruit: 'apple', vegetable: 'broccoli' } as const

function getBasket<T extends 'fruit' | 'vegetable'>(type: T) {
return basket[type]
}

function useBasket<T extends 'fruit' | 'vegetable'>(type: T) {
return useQuery({
queryKey: ['basket', type] as const,
queryFn({ queryKey: [, t] }) {
return getBasket(t)
},
})
}

assertType<UseQueryReturnType<'apple' | 'broccoli', Error>>(
useBasket('fruit'),
)
})
})

describe('custom composable', () => {
it('should allow custom composable using UseQueryOptions', () => {
const key = queryKey()
Expand Down
28 changes: 19 additions & 9 deletions packages/vue-query/src/useQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,25 @@ export type UseQueryOptions<
TQueryData,
DeepUnwrapRef<TQueryKey>
>)
: MaybeRefDeep<
QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
DeepUnwrapRef<TQueryKey>
>[Property]
>
: Property extends 'queryKey'
? MaybeRef<
QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
TQueryKey
>[Property]
>
: MaybeRefDeep<
QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
DeepUnwrapRef<TQueryKey>
>[Property]
>
} & ShallowOption
>

Expand Down
Loading