query/packages/solid-query/src/__tests__/useQuery.test-d.tsx at 80876bea96c26f5cbdbd1e3b1bbf7e2587f01648 · TanStack/query · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
import { describe, expectTypeOf, it } from 'vitest'
import { queryOptions, useQuery } from '../index'

describe('useQuery', () => {
  describe('Config object overload', () => {
    it('TData should always be defined when initialData is provided as an object', () => {
      const { data } = useQuery(() => ({
        queryKey: ['key'],
        queryFn: () => ({ wow: true }),
        initialData: { wow: true },
      }))

      expectTypeOf(data).toEqualTypeOf<{ wow: boolean }>()
    })

    it('TData should be defined when passed through queryOptions', () => {
      const options = queryOptions({
        queryKey: ['key'],
        queryFn: () => ({ wow: true }),
        initialData: { wow: true },
      })
      const { data } = useQuery(() => options)

      expectTypeOf(data).toEqualTypeOf<{ wow: boolean }>()
    })

    it('TData should always be defined when initialData is provided as a function which ALWAYS returns the data', () => {
      const { data } = useQuery(() => ({
        queryKey: ['key'],
        queryFn: () => ({ wow: true }),
        initialData: () => ({ wow: true }),
      }))

      expectTypeOf(data).toEqualTypeOf<{ wow: boolean }>()
    })

    it('TData should have undefined in the union when initialData is NOT provided', () => {
      const { data } = useQuery(() => ({
        queryKey: ['key'],
        queryFn: () => ({ wow: true }),
      }))

      expectTypeOf(data).toEqualTypeOf<{ wow: boolean } | undefined>()
    })

    it('TData should have undefined in the union when initialData is provided as a function which can return undefined', () => {
      const { data } = useQuery(() => ({
        queryKey: ['key'],
        queryFn: () => ({ wow: true }),
        initialData: () => undefined as { wow: boolean } | undefined,
      }))

      expectTypeOf(data).toEqualTypeOf<{ wow: boolean } | undefined>()
    })
  })

  describe('Query key overload', () => {
    it('TData should always be defined when initialData is provided', () => {
      const { data } = useQuery(() => ({
        queryKey: ['key'],
        queryFn: () => ({ wow: true }),
        initialData: { wow: true },
      }))

      expectTypeOf(data).toEqualTypeOf<{ wow: boolean }>()
    })

    it('TData should have undefined in the union when initialData is NOT provided', () => {
      const { data } = useQuery(() => ({
        queryKey: ['key'],
        queryFn: () => ({ wow: true }),
      }))

      expectTypeOf(data).toEqualTypeOf<{ wow: boolean } | undefined>()
    })
  })

  describe('Query key and func', () => {
    it('TData should always be defined when initialData is provided', () => {
      const { data } = useQuery(() => ({
        queryKey: ['key'],
        queryFn: () => ({ wow: true }),
        initialData: { wow: true },
      }))

      expectTypeOf(data).toEqualTypeOf<{ wow: boolean }>()
    })

    it('TData should have undefined in the union when initialData is NOT provided', () => {
      const { data } = useQuery(() => ({
        queryKey: ['key'],
        queryFn: () => ({ wow: true }),
      }))

      expectTypeOf(data).toEqualTypeOf<{ wow: boolean } | undefined>()
    })
  })
})