Skip to content
Merged
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
44 changes: 22 additions & 22 deletions packages/vue-query/src/__tests__/queryClient.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,25 @@ import type { DataTag, InfiniteData } from '@tanstack/query-core'

describe('getQueryData', () => {
it('should be typed if key is tagged', () => {
const queryKey = ['key'] as DataTag<Array<string>, number>
const key = ['key'] as DataTag<Array<string>, number>
const queryClient = new QueryClient()
const data = queryClient.getQueryData(queryKey)
const data = queryClient.getQueryData(key)

expectTypeOf(data).toEqualTypeOf<number | undefined>()
})

it('should infer unknown if key is not tagged', () => {
const queryKey = ['key'] as const
const key = ['key'] as const
const queryClient = new QueryClient()
const data = queryClient.getQueryData(queryKey)
const data = queryClient.getQueryData(key)

expectTypeOf(data).toEqualTypeOf<unknown>()
})

it('should infer passed generic if passed', () => {
const queryKey = ['key'] as const
const key = ['key'] as const
const queryClient = new QueryClient()
const data = queryClient.getQueryData<number>(queryKey)
const data = queryClient.getQueryData<number>(key)

expectTypeOf(data).toEqualTypeOf<number | undefined>()
})
Expand All @@ -38,74 +38,74 @@ describe('getQueryData', () => {

describe('setQueryData', () => {
it('updater should be typed if key is tagged', () => {
const queryKey = ['key'] as DataTag<Array<string>, number>
const key = ['key'] as DataTag<Array<string>, number>
const queryClient = new QueryClient()
const data = queryClient.setQueryData(queryKey, (prev) => {
const data = queryClient.setQueryData(key, (prev) => {
expectTypeOf(prev).toEqualTypeOf<number | undefined>()
return prev
})
expectTypeOf(data).toEqualTypeOf<number | undefined>()
})

it('value should be typed if key is tagged', () => {
const queryKey = ['key'] as DataTag<Array<string>, number>
const key = ['key'] as DataTag<Array<string>, number>
const queryClient = new QueryClient()

// @ts-expect-error value should be a number
queryClient.setQueryData(queryKey, '1')
queryClient.setQueryData(key, '1')

// @ts-expect-error value should be a number
queryClient.setQueryData(queryKey, () => '1')
queryClient.setQueryData(key, () => '1')

const data = queryClient.setQueryData(queryKey, 1)
const data = queryClient.setQueryData(key, 1)

expectTypeOf(data).toEqualTypeOf<number | undefined>()
})

it('should infer unknown for updater if key is not tagged', () => {
const queryKey = ['key'] as const
const key = ['key'] as const
const queryClient = new QueryClient()
const data = queryClient.setQueryData(queryKey, (prev) => {
const data = queryClient.setQueryData(key, (prev) => {
expectTypeOf(prev).toEqualTypeOf<unknown>()
return prev
})
expectTypeOf(data).toEqualTypeOf<unknown>()
})

it('should infer unknown for value if key is not tagged', () => {
const queryKey = ['key'] as const
const key = ['key'] as const
const queryClient = new QueryClient()
const data = queryClient.setQueryData(queryKey, 'foo')
const data = queryClient.setQueryData(key, 'foo')

expectTypeOf(data).toEqualTypeOf<unknown>()
})

it('should infer passed generic if passed', () => {
const queryKey = ['key'] as const
const key = ['key'] as const
const queryClient = new QueryClient()
const data = queryClient.setQueryData<string>(queryKey, (prev) => {
const data = queryClient.setQueryData<string>(key, (prev) => {
expectTypeOf(prev).toEqualTypeOf<string | undefined>()
return prev
})
expectTypeOf(data).toEqualTypeOf<string | undefined>()
})

it('should infer passed generic for value', () => {
const queryKey = ['key'] as const
const key = ['key'] as const
const queryClient = new QueryClient()
const data = queryClient.setQueryData<string>(queryKey, 'foo')
const data = queryClient.setQueryData<string>(key, 'foo')

expectTypeOf(data).toEqualTypeOf<string | undefined>()
})

it('should preserve updater parameter type inference when used in functions with explicit return types', () => {
const queryKey = ['key'] as DataTag<Array<string>, number>
const key = ['key'] as DataTag<Array<string>, number>
const queryClient = new QueryClient()

// Simulate usage inside a function with explicit return type
// The outer function returns 'unknown' but this shouldn't affect the updater's type inference
;(() =>
queryClient.setQueryData(queryKey, (data) => {
queryClient.setQueryData(key, (data) => {
expectTypeOf(data).toEqualTypeOf<number | undefined>()
return data
})) satisfies () => unknown
Expand Down
Loading