Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

infiniteQueryObserver.ts

190 lines4.7 KB

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