Open History to see the last commit
1import { QueryObserver } from './queryObserver'
2import {
3 hasNextPage,
4 hasPreviousPage,
5 infiniteQueryBehavior,
6} from './infiniteQueryBehavior'
7import type { Subscribable } from './subscribable'
8import type {
9 DefaultError,
10 DefaultedInfiniteQueryObserverOptions,
11 FetchNextPageOptions,
12 FetchPreviousPageOptions,
13 InfiniteData,
14 InfiniteQueryObserverBaseResult,
15 InfiniteQueryObserverOptions,
16 InfiniteQueryObserverResult,
17 QueryKey,
18} from './types'
19import type { QueryClient } from './queryClient'
20import type { Query } from './query'
21β
22type InfiniteQueryObserverListener<TData, TError> = (
23 result: InfiniteQueryObserverResult<TData, TError>,
24) => void
25β
26export class InfiniteQueryObserver<
27 TQueryFnData = unknown,
28 TError = DefaultError,
29 TData = InfiniteData<TQueryFnData>,
30 TQueryData = TQueryFnData,
31 TQueryKey extends QueryKey = QueryKey,
32 TPageParam = unknown,
33> extends QueryObserver<
34 TQueryFnData,
35 TError,
36 TData,
37 InfiniteData<TQueryData, TPageParam>,
38 TQueryKey
39> {
40 // Type override
41 subscribe!: Subscribable<
42 InfiniteQueryObserverListener<TData, TError>
43 >['subscribe']
44β
45 // Type override
46 getCurrentResult!: ReplaceReturnType<
47 QueryObserver<
48 TQueryFnData,
49 TError,
50 TData,
51 InfiniteData<TQueryData, TPageParam>,
52 TQueryKey
53 >['getCurrentResult'],
54 InfiniteQueryObserverResult<TData, TError>
55 >
56β
57 // Type override
58 protected fetch!: ReplaceReturnType<
59 QueryObserver<
60 TQueryFnData,
61 TError,
62 TData,
63 InfiniteData<TQueryData, TPageParam>,
64 TQueryKey
65 >['fetch'],
66 Promise<InfiniteQueryObserverResult<TData, TError>>
67 >
68β
69 constructor(
70 client: QueryClient,
71 options: InfiniteQueryObserverOptions<
72 TQueryFnData,
73 TError,
74 TData,
75 TQueryData,
76 TQueryKey,
77 TPageParam
78 >,
79 ) {
80 super(client, options)
81 }
82β
83 protected bindMethods(): void {
84 super.bindMethods()
85 this.fetchNextPage = this.fetchNextPage.bind(this)
86 this.fetchPreviousPage = this.fetchPreviousPage.bind(this)
87 }
88β
89 setOptions(
90 options: InfiniteQueryObserverOptions<
91 TQueryFnData,
92 TError,
93 TData,
94 TQueryData,
95 TQueryKey,
96 TPageParam
97 >,
98 ): void {
99 super.setOptions({
100 ...options,
101 behavior: infiniteQueryBehavior(),
102 })
103 }
104β
105 getOptimisticResult(
106 options: DefaultedInfiniteQueryObserverOptions<
107 TQueryFnData,
108 TError,
109 TData,
110 TQueryData,
111 TQueryKey,
112 TPageParam
113 >,
114 ): InfiniteQueryObserverResult<TData, TError> {
115 options.behavior = infiniteQueryBehavior()
116 return super.getOptimisticResult(options) as InfiniteQueryObserverResult<
117 TData,
118 TError
119 >
120 }
121β
122 fetchNextPage(
123 options?: FetchNextPageOptions,
124 ): Promise<InfiniteQueryObserverResult<TData, TError>> {
125 return this.fetch({
126 ...options,
127 meta: {
128 fetchMore: { direction: 'forward' },
129 },
130 })
131 }
132β
133 fetchPreviousPage(
134 options?: FetchPreviousPageOptions,
135 ): Promise<InfiniteQueryObserverResult<TData, TError>> {
136 return this.fetch({
137 ...options,
138 meta: {
139 fetchMore: { direction: 'backward' },
140 },
141 })
142 }
143β
144 protected createResult(
145 query: Query<
146 TQueryFnData,
147 TError,
148 InfiniteData<TQueryData, TPageParam>,
149 TQueryKey
150 >,
151 options: InfiniteQueryObserverOptions<
152 TQueryFnData,
153 TError,
154 TData,
155 TQueryData,
156 TQueryKey,
157 TPageParam
158 >,
159 ): InfiniteQueryObserverResult<TData, TError> {
160 const { state } = query
161 const parentResult = super.createResult(query, options)
162β
163 const { isFetching, isRefetching, isError, isRefetchError } = parentResult
164 const fetchDirection = state.fetchMeta?.fetchMore?.direction
165β
166 const isFetchNextPageError = isError && fetchDirection === 'forward'
167 const isFetchingNextPage = isFetching && fetchDirection === 'forward'
168β
169 const isFetchPreviousPageError = isError && fetchDirection === 'backward'
170 const isFetchingPreviousPage = isFetching && fetchDirection === 'backward'
171β
172 const result: InfiniteQueryObserverBaseResult<TData, TError> = {
173 ...parentResult,
174 fetchNextPage: this.fetchNextPage,
175 fetchPreviousPage: this.fetchPreviousPage,
176 hasNextPage: hasNextPage(options, state.data),
177 hasPreviousPage: hasPreviousPage(options, state.data),
178 isFetchNextPageError,
179 isFetchingNextPage,
180 isFetchPreviousPageError,
181 isFetchingPreviousPage,
182 isRefetchError:
183 isRefetchError && !isFetchNextPageError && !isFetchPreviousPageError,
184 isRefetching:
185 isRefetching && !isFetchingNextPage && !isFetchingPreviousPage,
186 }
187β
188 return result as InfiniteQueryObserverResult<TData, TError>
189 }
190}
191β
192type ReplaceReturnType<
193 TFunction extends (...args: Array<any>) => unknown,
194 TReturn,
195> = (...args: Parameters<TFunction>) => TReturn