Open History to see the last commit
1import { describe, expectTypeOf, it } from 'vitest'
2import { QueryClient, dataTagSymbol, skipToken } from '@tanstack/query-core'
3import { createKey } from '@tanstack/query-test-utils'
4import { useInfiniteQuery } from '../useInfiniteQuery'
5import { infiniteQueryOptions } from '../infiniteQueryOptions'
6import type { InfiniteData } from '@tanstack/query-core'
7import type {
8 DefinedInitialDataInfiniteOptions,
9 UndefinedInitialDataInfiniteOptions,
10} from '../infiniteQueryOptions'
11β
12// Regression test for exported infiniteQueryOptions inference under declaration emit.
13// TypeScript should be able to name the return type without expanding the
14// internal data tag symbols into the consumer's .d.ts output.
15export const exportedInfiniteQueryOptions = infiniteQueryOptions({
16 queryKey: ['invalid'],
17 getNextPageParam: () => 1,
18 initialPageParam: 1,
19})
20β
21describe('infiniteQueryOptions', () => {
22 it('should work when passed to infiniteQuery', async () => {
23 const options = infiniteQueryOptions({
24 getNextPageParam: () => 10,
25 queryKey: ['key'],
26 queryFn: () => ({ wow: true }),
27 initialPageParam: 0,
28 })
29β
30 const data = await new QueryClient().infiniteQuery(options)
31β
32 expectTypeOf(data).toEqualTypeOf<InfiniteData<{ wow: boolean }, number>>()
33 })
34β
35 it('should work when passed to infiniteQuery with select', async () => {
36 const options = infiniteQueryOptions({
37 getNextPageParam: () => 10,
38 queryKey: ['key'],
39 queryFn: () => ({ wow: true }),
40 initialPageParam: 0,
41 select: (data) => data.pages,
42 })
43β
44 const data = await new QueryClient().infiniteQuery(options)
45β
46 expectTypeOf(data).toEqualTypeOf<Array<{ wow: boolean }>>()
47 })
48β
49 it('should work when passed to infiniteQuery with enabled: false', async () => {
50 const options = infiniteQueryOptions({
51 getNextPageParam: () => 10,
52 queryKey: ['key'],
53 queryFn: () => ({ wow: true }),
54 initialPageParam: 0,
55 enabled: false,
56 })
57β
58 const data = await new QueryClient().infiniteQuery(options)
59β
60 expectTypeOf(data).toEqualTypeOf<InfiniteData<{ wow: boolean }, number>>()
61 })
62β
63 it('should work when passed to infiniteQuery with skipToken', async () => {
64 const options = infiniteQueryOptions({
65 getNextPageParam: () => 10,
66 queryKey: ['key'],
67 queryFn: skipToken,
68 initialPageParam: 0,
69 })
70β
71 const data = await new QueryClient().infiniteQuery(options)
72β
73 expectTypeOf(data).toEqualTypeOf<InfiniteData<unknown, number>>()
74 })
75β
76 it('should infer defined types', () => {
77 const options = infiniteQueryOptions({
78 getNextPageParam: () => 10,
79 queryKey: createKey(),
80 queryFn: () => ({ wow: true }),
81 initialData: {
82 pageParams: [undefined],
83 pages: [{ wow: true }],
84 },
85 initialPageParam: 0,
86 })
87β
88 expectTypeOf(useInfiniteQuery(() => options).data).toEqualTypeOf<
89 InfiniteData<{ wow: boolean }, unknown>
90 >()
91β
92 expectTypeOf(options).toExtend<
93 ReturnType<
94 DefinedInitialDataInfiniteOptions<
95 { wow: boolean },
96 Error,
97 InfiniteData<{ wow: boolean }, unknown>,
98 Array<string>,
99 number | undefined
100 >
101 >
102 >()
103β
104 expectTypeOf(options.queryKey[dataTagSymbol]).toEqualTypeOf<
105 InfiniteData<{ wow: boolean }>
106 >()
107 })
108β
109 it('should work without defined types', () => {
110 const options = infiniteQueryOptions({
111 getNextPageParam: () => undefined,
112 queryKey: createKey(),
113 queryFn: () => ({ wow: true }),
114 initialPageParam: 0,
115 })
116β
117 expectTypeOf(() => useInfiniteQuery(() => options).data).toEqualTypeOf<
118 () => InfiniteData<{ wow: boolean }, unknown> | undefined
119 >()
120β
121 expectTypeOf(options).toExtend<
122 ReturnType<
123 UndefinedInitialDataInfiniteOptions<
124 { wow: boolean },
125 Error,
126 InfiniteData<{ wow: boolean }, unknown>,
127 Array<string>,
128 number
129 >
130 >
131 >()
132β
133 expectTypeOf(options.queryKey[dataTagSymbol]).toEqualTypeOf<
134 InfiniteData<{
135 wow: boolean
136 }>
137 >()
138 })
139β
140 it('should keep data possibly undefined when initialData is a ternary that can be undefined', () => {
141 const options = infiniteQueryOptions({
142 queryKey: createKey(),
143 queryFn: () => Promise.resolve({ example: true }),
144 initialData:
145 Math.random() > 0.5
146 ? { pages: [{ example: true }], pageParams: [1] }
147 : undefined,
148 getNextPageParam: () => 1,
149 initialPageParam: 1,
150 })
151β
152 expectTypeOf(useInfiniteQuery(() => options).data).toEqualTypeOf<
153 InfiniteData<{ example: boolean }, unknown> | undefined
154 >()
155 })
156})