-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
queryOptions.types.test.ts
170 lines (151 loc) 路 5 KB
/
queryOptions.types.test.ts
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
import { describe, it } from 'vitest'
import { reactive, ref } from 'vue-demi'
import { QueryClient } from '../queryClient'
import { queryOptions } from '../queryOptions'
import { useQuery } from '../useQuery'
import { doNotExecute } from './test-utils'
import type { dataTagSymbol } from '@tanstack/query-core'
import type { Equal, Expect } from './test-utils'
describe('queryOptions', () => {
it('should not allow excess properties', () => {
doNotExecute(() => {
return queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
// @ts-expect-error this is a good error, because stallTime does not exist!
stallTime: 1000,
})
})
})
it('should infer types for callbacks', () => {
doNotExecute(() => {
return queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
staleTime: 1000,
select: (data) => {
const result: Expect<Equal<number, typeof data>> = true
return result
},
})
})
})
it('should work when passed to useQuery', () => {
doNotExecute(() => {
const options = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
})
const { data } = reactive(useQuery(options))
const result: Expect<Equal<typeof data, number | undefined>> = true
return result
})
})
it('should tag the queryKey with the result type of the QueryFn', () => {
doNotExecute(() => {
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
})
const result: Expect<
Equal<(typeof queryKey)[typeof dataTagSymbol], number>
> = true
return result
})
})
it('should tag the queryKey even if no promise is returned', () => {
doNotExecute(() => {
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => 5,
})
const result: Expect<
Equal<(typeof queryKey)[typeof dataTagSymbol], number>
> = true
return result
})
})
it('should tag the queryKey with unknown if there is no queryFn', () => {
doNotExecute(() => {
const { queryKey } = queryOptions({
queryKey: ['key'],
})
const result: Expect<
Equal<(typeof queryKey)[typeof dataTagSymbol], unknown>
> = true
return result
})
})
it('should tag the queryKey with the result type of the QueryFn if select is used', () => {
doNotExecute(() => {
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
select: (data) => data.toString(),
})
const result: Expect<
Equal<(typeof queryKey)[typeof dataTagSymbol], number>
> = true
return result
})
})
it('should return the proper type when passed to getQueryData', () => {
doNotExecute(() => {
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
})
const queryClient = new QueryClient()
const data = queryClient.getQueryData(queryKey)
const result: Expect<Equal<typeof data, number | undefined>> = true
return result
})
})
it('should properly type updaterFn when passed to setQueryData', () => {
doNotExecute(() => {
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
})
const queryClient = new QueryClient()
const data = queryClient.setQueryData(queryKey, (prev) => {
const result: Expect<Equal<typeof prev, number | undefined>> = true
return result ? prev : 1
})
const result: Expect<Equal<typeof data, number | undefined>> = true
return result
})
})
it('should properly type value when passed to setQueryData', () => {
doNotExecute(() => {
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
})
const queryClient = new QueryClient()
// @ts-expect-error value should be a number
queryClient.setQueryData(queryKey, '5')
// @ts-expect-error value should be a number
queryClient.setQueryData(queryKey, () => '5')
const data = queryClient.setQueryData(queryKey, 5)
const result: Expect<Equal<typeof data, number | undefined>> = true
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
})
})
})