File size: 5,222 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 |
import { describe, expectTypeOf, it, test } from 'vitest'
import { sleep } from '@tanstack/query-test-utils'
import { injectQuery, queryOptions } from '..'
import type { Signal } from '@angular/core'
describe('initialData', () => {
describe('Config object overload', () => {
it('TData should always be defined when initialData is provided as an object', () => {
const { data } = injectQuery(() => ({
queryKey: ['key'],
queryFn: () => ({ wow: true }),
initialData: { wow: true },
}))
expectTypeOf(data).toEqualTypeOf<Signal<{ wow: boolean }>>()
})
it('TData should be defined when passed through queryOptions', () => {
const options = () =>
queryOptions({
queryKey: ['key'],
queryFn: () => {
return {
wow: true,
}
},
initialData: {
wow: true,
},
})
const { data } = injectQuery(options)
expectTypeOf(data).toEqualTypeOf<Signal<{ wow: boolean }>>()
})
it('should be possible to define a different TData than TQueryFnData using select with queryOptions spread into useQuery', () => {
const options = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(1),
})
const query = injectQuery(() => ({
...options,
select: (data) => data > 1,
}))
expectTypeOf(query.data).toEqualTypeOf<Signal<boolean | undefined>>()
})
it('TData should always be defined when initialData is provided as a function which ALWAYS returns the data', () => {
const { data } = injectQuery(() => ({
queryKey: ['key'],
queryFn: () => {
return {
wow: true,
}
},
initialData: () => ({
wow: true,
}),
}))
expectTypeOf(data).toEqualTypeOf<Signal<{ wow: boolean }>>()
})
it('TData should have undefined in the union when initialData is NOT provided', () => {
const { data } = injectQuery(() => ({
queryKey: ['key'],
queryFn: () => {
return {
wow: true,
}
},
}))
expectTypeOf(data).toEqualTypeOf<Signal<{ wow: boolean } | undefined>>()
})
it('TData should have undefined in the union when initialData is provided as a function which can return undefined', () => {
const { data } = injectQuery(() => ({
queryKey: ['key'],
queryFn: () => {
return {
wow: true,
}
},
initialData: () => undefined as { wow: boolean } | undefined,
}))
expectTypeOf(data).toEqualTypeOf<Signal<{ wow: boolean } | undefined>>()
})
it('TData should be narrowed after an isSuccess check when initialData is provided as a function which can return undefined', () => {
const query = injectQuery(() => ({
queryKey: ['key'],
queryFn: () => {
return {
wow: true,
}
},
initialData: () => undefined as { wow: boolean } | undefined,
}))
if (query.isSuccess()) {
expectTypeOf(query.data).toEqualTypeOf<Signal<{ wow: boolean }>>()
}
})
})
describe('structuralSharing', () => {
it('should be able to use structuralSharing with unknown types', () => {
// https://github.com/TanStack/query/issues/6525#issuecomment-1938411343
injectQuery(() => ({
queryKey: ['key'],
queryFn: () => 5,
structuralSharing: (oldData, newData) => {
expectTypeOf(oldData).toBeUnknown()
expectTypeOf(newData).toBeUnknown()
return newData
},
}))
})
})
})
describe('Discriminated union return type', () => {
test('data should be possibly undefined by default', () => {
const query = injectQuery(() => ({
queryKey: ['key'],
queryFn: () => sleep(0).then(() => 'Some data'),
}))
expectTypeOf(query.data).toEqualTypeOf<Signal<string | undefined>>()
})
test('data should be defined when query is success', () => {
const query = injectQuery(() => ({
queryKey: ['key'],
queryFn: () => sleep(0).then(() => 'Some data'),
}))
if (query.isSuccess()) {
expectTypeOf(query.data).toEqualTypeOf<Signal<string>>()
}
})
test('error should be null when query is success', () => {
const query = injectQuery(() => ({
queryKey: ['key'],
queryFn: () => sleep(0).then(() => 'Some data'),
}))
if (query.isSuccess()) {
expectTypeOf(query.error).toEqualTypeOf<Signal<null>>()
}
})
test('data should be undefined when query is pending', () => {
const query = injectQuery(() => ({
queryKey: ['key'],
queryFn: () => sleep(0).then(() => 'Some data'),
}))
if (query.isPending()) {
expectTypeOf(query.data).toEqualTypeOf<Signal<undefined>>()
}
})
test('error should be defined when query is error', () => {
const query = injectQuery(() => ({
queryKey: ['key'],
queryFn: () => sleep(0).then(() => 'Some data'),
}))
if (query.isError()) {
expectTypeOf(query.error).toEqualTypeOf<Signal<Error>>()
}
})
})
|