File size: 7,030 Bytes
1e92f2d |
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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
import { describe, expectTypeOf, it } from 'vitest'
import { reactive } from 'vue'
import { skipToken, useQueries } from '..'
import { queryOptions } from '../queryOptions'
import type { OmitKeyof, QueryObserverResult } from '..'
import type { UseQueryOptions } from '../useQuery'
describe('UseQueries config object overload', () => {
it('TData should always be defined when initialData is provided as an object', () => {
const query1 = {
queryKey: ['key1'],
queryFn: () => {
return {
wow: true,
}
},
initialData: {
wow: false,
},
}
const query2 = queryOptions({
queryKey: ['key2'],
queryFn: () => 'Query Data',
initialData: 'initial data',
})
const query3 = {
queryKey: ['key2'],
queryFn: () => 'Query Data',
}
const { value: queriesState } = useQueries({
queries: [query1, query2, query3],
})
expectTypeOf(queriesState[0].data).toEqualTypeOf<{ wow: boolean }>()
expectTypeOf(queriesState[1].data).toEqualTypeOf<string>()
expectTypeOf(queriesState[2].data).toEqualTypeOf<string | undefined>()
})
it('TData should be defined when passed through queryOptions', () => {
const options = queryOptions({
queryKey: ['key'],
queryFn: () => {
return {
wow: true,
}
},
initialData: {
wow: true,
},
})
const { value: queriesState } = useQueries({ queries: [options] })
expectTypeOf(queriesState[0].data).toEqualTypeOf<{ wow: boolean }>()
})
it('should be possible to define a different TData than TQueryFnData using select with queryOptions spread into useQueries', () => {
const query1 = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(1),
select: (data) => data > 1,
})
const query2 = {
queryKey: ['key'],
queryFn: () => Promise.resolve(1),
select: (data: any) => data > 1,
}
const queriesState = reactive(useQueries({ queries: [query1, query2] }))
expectTypeOf(queriesState.value[0].data).toEqualTypeOf<
boolean | undefined
>()
expectTypeOf(queriesState.value[1].data).toEqualTypeOf<
boolean | undefined
>()
})
it('TData should have undefined in the union when initialData is provided as a function which can return undefined', () => {
const { value: queriesState } = useQueries({
queries: [
{
queryKey: ['key'],
queryFn: () => {
return {
wow: true,
}
},
initialData: () => undefined as { wow: boolean } | undefined,
},
],
})
expectTypeOf(queriesState[0].data).toEqualTypeOf<
{ wow: boolean } | undefined
>()
})
it('TData should have correct type when conditional skipToken is passed', () => {
const { value: queriesState } = useQueries({
queries: [
queryOptions({
queryKey: ['key'],
queryFn: Math.random() > 0.5 ? skipToken : () => Promise.resolve(5),
}),
],
})
const firstResult = queriesState[0]
expectTypeOf(firstResult).toEqualTypeOf<
QueryObserverResult<number, Error>
>()
expectTypeOf(firstResult.data).toEqualTypeOf<number | undefined>()
})
describe('custom hook', () => {
it('should allow custom hooks using UseQueryOptions', () => {
const useCustomQueries = (
options?: OmitKeyof<
UseQueryOptions<string>,
'queryKey' | 'queryFn',
'safely'
>,
) =>
useQueries({
queries: [
{
...options,
queryKey: ['todos-key'],
queryFn: () => Promise.resolve('data'),
},
],
})
const { value: queriesState } = useCustomQueries()
expectTypeOf(queriesState[0].data).toEqualTypeOf<string | undefined>()
})
})
// Fix #7270
it('should have proper type inference with different options provided', () => {
const numbers = [1, 2, 3]
const queryKey = (n: number) => [n]
const queryFn = (n: number) => () => Promise.resolve(n)
const select = (data: number) => data.toString()
const queries = numbers.map((n) => ({
queryKey: [n],
queryFn: () => Promise.resolve(n),
select: (data: number) => data.toString(),
}))
const queriesWithoutSelect = numbers.map((n) => ({
queryKey: queryKey(n),
queryFn: queryFn(n),
}))
const queriesWithQueryOptions = numbers.map((n) =>
queryOptions({
queryKey: queryKey(n),
queryFn: queryFn(n),
select,
}),
)
const queriesWithQueryOptionsWithoutSelect = numbers.map((n) =>
queryOptions({
queryKey: queryKey(n),
queryFn: queryFn(n),
}),
)
const query1 = useQueries({ queries: queries })
expectTypeOf(query1.value).toEqualTypeOf<
Array<QueryObserverResult<string, Error>>
>()
const query2 = useQueries({ queries: queriesWithoutSelect })
expectTypeOf(query2.value).toEqualTypeOf<
Array<QueryObserverResult<number, Error>>
>()
const query3 = useQueries({ queries: queriesWithQueryOptions })
expectTypeOf(query3.value).toEqualTypeOf<
Array<QueryObserverResult<string, Error>>
>()
const query4 = useQueries({ queries: queriesWithQueryOptionsWithoutSelect })
expectTypeOf(query4.value).toEqualTypeOf<
Array<QueryObserverResult<number, Error>>
>()
const queryCombine = useQueries({
queries: queries,
combine: (data) => {
return data.reduce((acc, i) => {
acc.push(i.data ?? '')
return acc
}, [] as Array<string>)
},
})
expectTypeOf(queryCombine.value).toEqualTypeOf<Array<string>>()
const queryCombineWithoutSelect = useQueries({
queries: queriesWithoutSelect,
combine: (data) => {
return data.reduce((acc, i) => {
acc.push(i.data ?? 0)
return acc
}, [] as Array<number>)
},
})
expectTypeOf(queryCombineWithoutSelect.value).toEqualTypeOf<Array<number>>()
})
it('should return correct data for dynamic queries with mixed result types', () => {
const Queries1 = {
get: () =>
queryOptions({
queryKey: ['key1'],
queryFn: () => Promise.resolve(1),
}),
}
const Queries2 = {
get: () =>
queryOptions({
queryKey: ['key2'],
queryFn: () => Promise.resolve(true),
}),
}
const queries1List = [1, 2, 3].map(() => ({ ...Queries1.get() }))
const { value: queriesState } = useQueries({
queries: [...queries1List, { ...Queries2.get() }],
})
expectTypeOf(queriesState).toEqualTypeOf<
[
...Array<QueryObserverResult<number, Error>>,
QueryObserverResult<boolean, Error>,
]
>()
expectTypeOf(queriesState[0].data).toEqualTypeOf<
number | boolean | undefined
>()
})
})
|