Open History to see the last commit
1import { describe, expectTypeOf, it } from 'vitest'
2import { QueryClient } from '@tanstack/query-core'
3import { useInfiniteQuery } from '../useInfiniteQuery'
4import type { InfiniteData } from '@tanstack/query-core'
5β
6describe('pageParam', () => {
7 it('initialPageParam should define type of param passed to queryFunctionContext', () => {
8 useInfiniteQuery({
9 queryKey: ['key'],
10 queryFn: ({ pageParam }) => {
11 expectTypeOf(pageParam).toEqualTypeOf<number>()
12 },
13 initialPageParam: 1,
14 getNextPageParam: () => undefined,
15 })
16 })
17β
18 it('direction should be passed to queryFn of useInfiniteQuery', () => {
19 useInfiniteQuery({
20 queryKey: ['key'],
21 queryFn: ({ direction }) => {
22 expectTypeOf(direction).toEqualTypeOf<'forward' | 'backward'>()
23 },
24 initialPageParam: 1,
25 getNextPageParam: () => undefined,
26 })
27 })
28β
29 it('initialPageParam should define type of param passed to queryFunctionContext for fetchInfiniteQuery', () => {
30 const queryClient = new QueryClient()
31 queryClient.fetchInfiniteQuery({
32 queryKey: ['key'],
33 queryFn: ({ pageParam }) => {
34 expectTypeOf(pageParam).toEqualTypeOf<number>()
35 },
36 initialPageParam: 1,
37 })
38 })
39β
40 it('initialPageParam should define type of param passed to queryFunctionContext for prefetchInfiniteQuery', () => {
41 const queryClient = new QueryClient()
42 queryClient.prefetchInfiniteQuery({
43 queryKey: ['key'],
44 queryFn: ({ pageParam }) => {
45 expectTypeOf(pageParam).toEqualTypeOf<number>()
46 },
47 initialPageParam: 1,
48 })
49 })
50})
51describe('select', () => {
52 it('should still return paginated data if no select result', () => {
53 const infiniteQuery = useInfiniteQuery({
54 queryKey: ['key'],
55 queryFn: ({ pageParam }) => {
56 return pageParam * 5
57 },
58 initialPageParam: 1,
59 getNextPageParam: () => undefined,
60 })
61β
62 // TODO: Order of generics prevents pageParams to be typed correctly. Using `unknown` for now
63 expectTypeOf(infiniteQuery.data).toEqualTypeOf<
64 InfiniteData<number, unknown> | undefined
65 >()
66 })
67β
68 it('should be able to transform data to arbitrary result', () => {
69 const infiniteQuery = useInfiniteQuery({
70 queryKey: ['key'],
71 queryFn: ({ pageParam }) => {
72 return pageParam * 5
73 },
74 initialPageParam: 1,
75 getNextPageParam: () => undefined,
76 select: (data) => {
77 expectTypeOf(data).toEqualTypeOf<InfiniteData<number, number>>()
78 return 'selected' as const
79 },
80 })
81β
82 expectTypeOf(infiniteQuery.data).toEqualTypeOf<'selected' | undefined>()
83 })
84})
85describe('getNextPageParam / getPreviousPageParam', () => {
86 it('should get typed params', () => {
87 const infiniteQuery = useInfiniteQuery({
88 queryKey: ['key'],
89 queryFn: ({ pageParam }) => {
90 return String(pageParam)
91 },
92 initialPageParam: 1,
93 getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => {
94 expectTypeOf(lastPage).toEqualTypeOf<string>()
95 expectTypeOf(allPages).toEqualTypeOf<Array<string>>()
96 expectTypeOf(lastPageParam).toEqualTypeOf<number>()
97 expectTypeOf(allPageParams).toEqualTypeOf<Array<number>>()
98 return undefined
99 },
100 getPreviousPageParam: (
101 firstPage,
102 allPages,
103 firstPageParam,
104 allPageParams,
105 ) => {
106 expectTypeOf(firstPage).toEqualTypeOf<string>()
107 expectTypeOf(allPages).toEqualTypeOf<Array<string>>()
108 expectTypeOf(firstPageParam).toEqualTypeOf<number>()
109 expectTypeOf(allPageParams).toEqualTypeOf<Array<number>>()
110 return undefined
111 },
112 })
113β
114 // TODO: Order of generics prevents pageParams to be typed correctly. Using `unknown` for now
115 expectTypeOf(infiniteQuery.data).toEqualTypeOf<
116 InfiniteData<string, unknown> | undefined
117 >()
118 })
119})
120β
121describe('error booleans', () => {
122 it('should not be permanently `false`', () => {
123 const {
124 isFetchNextPageError,
125 isFetchPreviousPageError,
126 isLoadingError,
127 isRefetchError,
128 } = useInfiniteQuery({
129 queryKey: ['key'],
130 queryFn: ({ pageParam }) => {
131 return pageParam * 5
132 },
133 initialPageParam: 1,
134 getNextPageParam: () => undefined,
135 })
136β
137 expectTypeOf(isFetchNextPageError).toEqualTypeOf<boolean>()
138 expectTypeOf(isFetchPreviousPageError).toEqualTypeOf<boolean>()
139 expectTypeOf(isLoadingError).toEqualTypeOf<boolean>()
140 expectTypeOf(isRefetchError).toEqualTypeOf<boolean>()
141 })
142})