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

infiniteQueryObserver.ts

151 lines4.0 KB

1import type {
2 FetchNextPageOptions,
3 FetchPreviousPageOptions,
4 InfiniteData,
5 InfiniteQueryObserverOptions,
6 InfiniteQueryObserverResult,
7} from './types'
8import type { QueryClient } from './queryClient'
9import {
10 NotifyOptions,
11 ObserverFetchOptions,
12 QueryObserver,
13} from './queryObserver'
14import {
15 hasNextPage,
16 hasPreviousPage,
17 infiniteQueryBehavior,
18} from './infiniteQueryBehavior'
19import { Query } from './query'
20​
21type InfiniteQueryObserverListener<TData, TError> = (
22 result: InfiniteQueryObserverResult<TData, TError>
23) => void
24​
25export class InfiniteQueryObserver<
26 TQueryFnData = unknown,
27 TError = unknown,
28 TData = TQueryFnData,
29 TQueryData = TQueryFnData
30> extends QueryObserver<
31 TQueryFnData,
32 TError,
33 InfiniteData<TData>,
34 InfiniteData<TQueryData>
35> {
36 // Type override
37 subscribe!: (
38 listener?: InfiniteQueryObserverListener<TData, TError>
39 ) => () => void
40​
41 // Type override
42 getCurrentResult!: () => InfiniteQueryObserverResult<TData, TError>
43​
44 // Type override
45 protected fetch!: (
46 fetchOptions?: ObserverFetchOptions
47 ) => Promise<InfiniteQueryObserverResult<TData, TError>>
48​
49 // eslint-disable-next-line @typescript-eslint/no-useless-constructor
50 constructor(
51 client: QueryClient,
52 options: InfiniteQueryObserverOptions<
53 TQueryFnData,
54 TError,
55 TData,
56 TQueryData
57 >
58 ) {
59 super(client, options)
60 }
61​
62 protected bindMethods(): void {
63 super.bindMethods()
64 this.fetchNextPage = this.fetchNextPage.bind(this)
65 this.fetchPreviousPage = this.fetchPreviousPage.bind(this)
66 }
67​
68 setOptions(
69 options?: InfiniteQueryObserverOptions<
70 TQueryFnData,
71 TError,
72 TData,
73 TQueryData
74 >,
75 notifyOptions?: NotifyOptions
76 ): void {
77 super.setOptions(
78 {
79 ...options,
80 behavior: infiniteQueryBehavior(),
81 },
82 notifyOptions
83 )
84 }
85​
86 getOptimisticResult(
87 options: InfiniteQueryObserverOptions<
88 TQueryFnData,
89 TError,
90 TData,
91 TQueryData
92 >
93 ): InfiniteQueryObserverResult<TData, TError> {
94 options.behavior = infiniteQueryBehavior()
95 return super.getOptimisticResult(options) as InfiniteQueryObserverResult<
96 TData,
97 TError
98 >
99 }
100​
101 fetchNextPage(
102 options?: FetchNextPageOptions
103 ): Promise<InfiniteQueryObserverResult<TData, TError>> {
104 return this.fetch({
105 // TODO consider removing `?? true` in future breaking change, to be consistent with `refetch` API (see https://github.com/tannerlinsley/react-query/issues/2617)
106 cancelRefetch: options?.cancelRefetch ?? true,
107 throwOnError: options?.throwOnError,
108 meta: {
109 fetchMore: { direction: 'forward', pageParam: options?.pageParam },
110 },
111 })
112 }
113​
114 fetchPreviousPage(
115 options?: FetchPreviousPageOptions
116 ): Promise<InfiniteQueryObserverResult<TData, TError>> {
117 return this.fetch({
118 // TODO consider removing `?? true` in future breaking change, to be consistent with `refetch` API (see https://github.com/tannerlinsley/react-query/issues/2617)
119 cancelRefetch: options?.cancelRefetch ?? true,
120 throwOnError: options?.throwOnError,
121 meta: {
122 fetchMore: { direction: 'backward', pageParam: options?.pageParam },
123 },
124 })
125 }
126​
127 protected createResult(
128 query: Query<TQueryFnData, TError, InfiniteData<TQueryData>>,
129 options: InfiniteQueryObserverOptions<
130 TQueryFnData,
131 TError,
132 TData,
133 TQueryData
134 >
135 ): InfiniteQueryObserverResult<TData, TError> {
136 const { state } = query
137 const result = super.createResult(query, options)
138 return {
139 ...result,
140 fetchNextPage: this.fetchNextPage,
141 fetchPreviousPage: this.fetchPreviousPage,
142 hasNextPage: hasNextPage(options, state.data?.pages),
143 hasPreviousPage: hasPreviousPage(options, state.data?.pages),
144 isFetchingNextPage:
145 state.isFetching && state.fetchMeta?.fetchMore?.direction === 'forward',
146 isFetchingPreviousPage:
147 state.isFetching &&
148 state.fetchMeta?.fetchMore?.direction === 'backward',
149 }
150 }