Open History to see the last commit
1---
2id: InfiniteQueryObserver
3title: InfiniteQueryObserver
4redirect_from:
5 - reference/InfiniteQueryObserver
6 - framework/react/reference/InfiniteQueryObserver
7---
8β
9Defined in: [packages/query-core/src/infiniteQueryObserver.ts:40](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L40)
10β
11An `InfiniteQueryObserver` extends `QueryObserver` to observe and switch
12between infinite queries. It augments the base `QueryObserverResult` with
13infinite-query-specific fields and methods, such as `hasNextPage` and
14`fetchNextPage`, and is the primitive that framework adapters (e.g.
15`useInfiniteQuery`) build their hooks on top of.
16β
17## Example
18β
19```ts
20const observer = new InfiniteQueryObserver(queryClient, {
21 queryKey: ['projects'],
22 queryFn: ({ pageParam }) => fetchProjects(pageParam),
23 initialPageParam: 0,
24 getNextPageParam: (lastPage) => lastPage.nextCursor,
25})
26β
27const unsubscribe = observer.subscribe((result) => console.log(result))
28```
29β
30## Extends
31β
32- [`QueryObserver`](QueryObserver.md)\<`TQueryFnData`, `TError`, `TData`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\>
33β
34## Type Parameters
35β
36### TQueryFnData
37β
38`TQueryFnData` = `unknown`
39β
40### TError
41β
42`TError` = [`DefaultError`](../type-aliases/DefaultError.md)
43β
44### TData
45β
46`TData` = [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`\>
47β
48### TQueryKey
49β
50`TQueryKey` *extends* [`QueryKey`](../type-aliases/QueryKey.md) = [`QueryKey`](../type-aliases/QueryKey.md)
51β
52### TPageParam
53β
54`TPageParam` = `unknown`
55β
56## Constructors
57β
58### Constructor
59β
60```ts
61new InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryKey, TPageParam>(client: QueryClient, options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryKey, TPageParam>;
62```
63β
64Defined in: [packages/query-core/src/infiniteQueryObserver.ts:82](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L82)
65β
66#### Parameters
67β
68##### client
69β
70[`QueryClient`](QueryClient.md)
71β
72##### options
73β
74[`InfiniteQueryObserverOptions`](../interfaces/InfiniteQueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
75β
76#### Returns
77β
78`InfiniteQueryObserver`\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
79β
80#### Overrides
81β
82[`QueryObserver`](QueryObserver.md).[`constructor`](QueryObserver.md#constructor)
83β
84## Properties
85β
86### getCurrentResult
87β
88```ts
89getCurrentResult: ReplaceReturnType<() => QueryObserverResult<TData, TError>, InfiniteQueryObserverResult<TData, TError>>;
90```
91β
92Defined in: [packages/query-core/src/infiniteQueryObserver.ts:59](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L59)
93β
94Returns the most recently computed `QueryObserverResult` for the
95observed query. This is a point-in-time read; to be notified of updates
96as they happen, subscribe to the observer instead (its inherited
97`subscribe` method).
98β
99#### Returns
100β
101The observer's latest result.
102β
103#### Example
104β
105```ts
106const result = observer.getCurrentResult()
107console.log(result.status, result.data)
108```
109β
110#### Overrides
111β
112```ts
113QueryObserver.getCurrentResult
114```
115β
116***
117β
118### options
119β
120```ts
121options: QueryObserverOptions<TQueryFnData, TError, TData, InfiniteData<TQueryFnData, TPageParam>, TQueryKey>;
122```
123β
124Defined in: [packages/query-core/src/queryObserver.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L88)
125β
126#### Inherited from
127β
128[`QueryObserver`](QueryObserver.md).[`options`](QueryObserver.md#options)
129β
130***
131β
132### subscribe
133β
134```ts
135subscribe: (listener: InfiniteQueryObserverListener) => () => void;
136```
137β
138Defined in: [packages/query-core/src/infiniteQueryObserver.ts:54](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L54)
139β
140Registers a listener to be called on every update this object notifies about. Returns a function
141that removes the listener again β call it to stop listening. The base class never drops a listener
142on its own, though some subclasses clear all of theirs in `destroy()`.
143β
144#### Parameters
145β
146##### listener
147β
148`InfiniteQueryObserverListener`
149β
150Called on each update, with whatever the subclass passes to its subscribers.
151β
152#### Returns
153β
154A function that removes the listener.
155β
156() => `void`
157β
158#### Example
159β
160```ts
161const unsubscribe = subscribable.subscribe(() => {
162 // react to the update
163})
164β
165unsubscribe()
166```
167β
168#### Overrides
169β
170```ts
171QueryObserver.subscribe
172```
173β
174## Methods
175β
176### destroy()
177β
178```ts
179destroy(): void;
180```
181β
182Defined in: [packages/query-core/src/queryObserver.ts:166](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L166)
183β
184Stops observing the current query: clears all listeners, cancels the
185stale and refetch-interval timers, and removes this observer from the
186query it was observing.
187β
188#### Returns
189β
190`void`
191β
192#### Inherited from
193β
194[`QueryObserver`](QueryObserver.md).[`destroy`](QueryObserver.md#destroy)
195β
196***
197β
198### fetchNextPage()
199β
200```ts
201fetchNextPage(options?: FetchNextPageOptions): Promise<InfiniteQueryObserverResult<TData, TError>>;
202```
203β
204Defined in: [packages/query-core/src/infiniteQueryObserver.ts:165](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L165)
205β
206Fetches the next page of the infinite query and returns a promise that
207resolves with the resulting `InfiniteQueryObserverResult`. The page
208param used for the fetch is determined by `getNextPageParam`, which
209receives the current pages/page params and whose result also determines
210`hasNextPage`.
211β
212#### Parameters
213β
214##### options?
215β
216[`FetchNextPageOptions`](../interfaces/FetchNextPageOptions.md)
217β
218Set `cancelRefetch` to `false` to ignore the call while a fetch is running,
219and `throwOnError` to `true` to reject when the fetch fails.
220β
221#### Returns
222β
223`Promise`\<[`InfiniteQueryObserverResult`](../type-aliases/InfiniteQueryObserverResult.md)\<`TData`, `TError`\>\>
224β
225A promise that resolves with the result after the next page is fetched. With
226`cancelRefetch: false`, a running fetch is reused instead, so the next page may not be fetched.
227β
228#### See
229β
230[InfiniteQueryObserver#fetchPreviousPage](#fetchpreviouspage)
231β
232#### Example
233β
234```ts
235const { hasNextPage } = observer.getCurrentResult()
236β
237if (hasNextPage) {
238 await observer.fetchNextPage()
239}
240```
241β
242***
243β
244### fetchOptimistic()
245β
246```ts
247fetchOptimistic(options: QueryObserverOptions<TQueryFnData, TError, TData, InfiniteData<TQueryFnData, TPageParam>, TQueryKey>): Promise<QueryObserverResult<TData, TError>>;
248```
249β
250Defined in: [packages/query-core/src/queryObserver.ts:412](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L412)
251β
252Fetches a query defined by the given options without affecting this
253observer's own tracked query or result, and returns a promise that
254resolves with the `QueryObserverResult` for that fetch. This is useful
255for prefetching data that another observer (e.g. a query about to be
256navigated to) will need, ahead of time.
257β
258#### Parameters
259β
260##### options
261β
262[`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\>
263β
264The observer options of the query to fetch.
265β
266#### Returns
267β
268`Promise`\<[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\>\>
269β
270A promise that resolves with the result for the fetched query.
271β
272#### Example
273β
274```ts
275const result = await observer.fetchOptimistic({
276 queryKey: ['posts', 2],
277 queryFn: () => fetchPost(2),
278})
279console.log(result.data)
280```
281β
282#### Inherited from
283β
284[`QueryObserver`](QueryObserver.md).[`fetchOptimistic`](QueryObserver.md#fetchoptimistic)
285β
286***
287β
288### fetchPreviousPage()
289β
290```ts
291fetchPreviousPage(options?: FetchPreviousPageOptions): Promise<InfiniteQueryObserverResult<TData, TError>>;
292```
293β
294Defined in: [packages/query-core/src/infiniteQueryObserver.ts:196](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L196)
295β
296Fetches the previous page of the infinite query and returns a promise
297that resolves with the resulting `InfiniteQueryObserverResult`. The page
298param used for the fetch is determined by `getPreviousPageParam`, which
299receives the current pages/page params and whose result also determines
300`hasPreviousPage`.
301β
302#### Parameters
303β
304##### options?
305β
306[`FetchPreviousPageOptions`](../interfaces/FetchPreviousPageOptions.md)
307β
308Set `cancelRefetch` to `false` to ignore the call while a fetch is running,
309and `throwOnError` to `true` to reject when the fetch fails.
310β
311#### Returns
312β
313`Promise`\<[`InfiniteQueryObserverResult`](../type-aliases/InfiniteQueryObserverResult.md)\<`TData`, `TError`\>\>
314β
315A promise that resolves with the result after the previous page is fetched. With
316`cancelRefetch: false`, a running fetch is reused instead, so the previous page may not be fetched.
317β
318#### See
319β
320[InfiniteQueryObserver#fetchNextPage](#fetchnextpage)
321β
322#### Example
323β
324```ts
325const { hasPreviousPage } = observer.getCurrentResult()
326β
327if (hasPreviousPage) {
328 await observer.fetchPreviousPage()
329}
330```
331β
332***
333β
334### getCurrentQuery()
335β
336```ts
337getCurrentQuery(): Query<TQueryFnData, TError, InfiniteData<TQueryFnData, TPageParam>, TQueryKey>;
338```
339β
340Defined in: [packages/query-core/src/queryObserver.ts:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L371)
341β
342Returns the `Query` instance this observer is currently observing.
343β
344#### Returns
345β
346[`Query`](Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\>
347β
348The observed query.
349β
350#### Inherited from
351β
352[`QueryObserver`](QueryObserver.md).[`getCurrentQuery`](QueryObserver.md#getcurrentquery)
353β
354***
355β
356### getOptimisticResult()
357β
358```ts
359getOptimisticResult(options: DefaultedInfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): InfiniteQueryObserverResult<TData, TError>;
360```
361β
362Defined in: [packages/query-core/src/infiniteQueryObserver.ts:129](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L129)
363β
364The infinite-query counterpart of [QueryObserver#getOptimisticResult](QueryObserver.md#getoptimisticresult), marking the
365options as an infinite query before delegating to it. Called by framework adapters (e.g.
366`useInfiniteQuery`) ahead of subscribing, to compute the current `InfiniteQueryObserverResult`
367synchronously.
368β
369#### Parameters
370β
371##### options
372β
373[`DefaultedInfiniteQueryObserverOptions`](../type-aliases/DefaultedInfiniteQueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
374β
375The defaulted infinite query observer options to compute the result for.
376β
377#### Returns
378β
379[`InfiniteQueryObserverResult`](../type-aliases/InfiniteQueryObserverResult.md)\<`TData`, `TError`\>
380β
381The result for the given options.
382β
383#### Overrides
384β
385[`QueryObserver`](QueryObserver.md).[`getOptimisticResult`](QueryObserver.md#getoptimisticresult)
386β
387***
388β
389### hasListeners()
390β
391```ts
392hasListeners(): boolean;
393```
394β
395Defined in: [packages/query-core/src/subscribable.ts:43](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L43)
396β
397Returns `true` while at least one listener is registered, `false` once they have all unsubscribed.
398β
399#### Returns
400β
401`boolean`
402β
403`true` if at least one listener is registered.
404β
405#### Inherited from
406β
407[`QueryObserver`](QueryObserver.md).[`hasListeners`](QueryObserver.md#haslisteners)
408β
409***
410β
411### refetch()
412β
413```ts
414refetch(options?: RefetchOptions): Promise<QueryObserverResult<TData, TError>>;
415```
416β
417Defined in: [packages/query-core/src/queryObserver.ts:387](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L387)
418β
419Refetches the observed query and returns a promise that resolves with
420the resulting `QueryObserverResult`.
421β
422#### Parameters
423β
424##### options?
425β
426[`RefetchOptions`](../interfaces/RefetchOptions.md) = `{}`
427β
428Set `cancelRefetch` to `false` to keep a running fetch instead of cancelling
429it, and `throwOnError` to `true` to reject when the refetch fails.
430β
431#### Returns
432β
433`Promise`\<[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\>\>
434β
435A promise that resolves with the result after the refetch.
436β
437#### Example
438β
439```ts
440const result = await observer.refetch({ cancelRefetch: false })
441console.log(result.data)
442```
443β
444#### Inherited from
445β
446[`QueryObserver`](QueryObserver.md).[`refetch`](QueryObserver.md#refetch)
447β
448***
449β
450### setOptions()
451β
452```ts
453setOptions(options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): void;
454```
455β
456Defined in: [packages/query-core/src/infiniteQueryObserver.ts:108](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L108)
457β
458Updates the observer's options. Behaves the same as
459`QueryObserver.setOptions`, additionally marking the options as
460belonging to an infinite query before delegating to the base
461implementation.
462β
463#### Parameters
464β
465##### options
466β
467[`InfiniteQueryObserverOptions`](../interfaces/InfiniteQueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
468β
469The new infinite query observer options.
470β
471#### Returns
472β
473`void`
474β
475#### Overrides
476β
477[`QueryObserver`](QueryObserver.md).[`setOptions`](QueryObserver.md#setoptions)
478β
479***
480β
481### shouldFetchOnReconnect()
482β
483```ts
484shouldFetchOnReconnect(): boolean;
485```
486β
487Defined in: [packages/query-core/src/queryObserver.ts:139](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L139)
488β
489Returns whether the observed query is currently stale and configured
490(via the `refetchOnReconnect` option) to refetch when the network
491reconnects.
492β
493#### Returns
494β
495`boolean`
496β
497`true` if the observer should refetch the query on reconnect.
498β
499#### Inherited from
500β
501[`QueryObserver`](QueryObserver.md).[`shouldFetchOnReconnect`](QueryObserver.md#shouldfetchonreconnect)
502β
503***
504β
505### shouldFetchOnWindowFocus()
506β
507```ts
508shouldFetchOnWindowFocus(): boolean;
509```
510β
511Defined in: [packages/query-core/src/queryObserver.ts:153](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L153)
512β
513Returns whether the observed query is currently stale and configured
514(via the `refetchOnWindowFocus` option) to refetch when the window
515regains focus.
516β
517#### Returns
518β
519`boolean`
520β
521`true` if the observer should refetch the query on window focus.
522β
523#### Inherited from
524β
525[`QueryObserver`](QueryObserver.md).[`shouldFetchOnWindowFocus`](QueryObserver.md#shouldfetchonwindowfocus)
526β
527***
528β
529### trackProp()
530β
531```ts
532trackProp(key:
533 | "error"
534 | "data"
535 | "isError"
536 | "isPending"
537 | "isLoading"
538 | "isLoadingError"
539 | "isRefetchError"
540 | "isSuccess"
541 | "isPlaceholderData"
542 | "status"
543 | "dataUpdatedAt"
544 | "errorUpdatedAt"
545 | "failureCount"
546 | "failureReason"
547 | "errorUpdateCount"
548 | "isFetched"
549 | "isFetchedAfterMount"
550 | "isFetching"
551 | "isInitialLoading"
552 | "isPaused"
553 | "isRefetching"
554 | "isStale"
555 | "isEnabled"
556 | "refetch"
557 | "fetchStatus"): void;
558```
559β
560Defined in: [packages/query-core/src/queryObserver.ts:363](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L363)
561β
562Records that the given `QueryObserverResult` property was read, so a subsequent update only
563notifies this observer if a tracked property actually changed. Normally called indirectly via
564[QueryObserver#trackResult](QueryObserver.md#trackresult)'s proxy; exposed directly for adapters that track property
565access themselves (e.g. through their own reactivity system) instead of via the proxy.
566β
567#### Parameters
568β
569##### key
570β
571 \| `"error"`
572 \| `"data"`
573 \| `"isError"`
574 \| `"isPending"`
575 \| `"isLoading"`
576 \| `"isLoadingError"`
577 \| `"isRefetchError"`
578 \| `"isSuccess"`
579 \| `"isPlaceholderData"`
580 \| `"status"`
581 \| `"dataUpdatedAt"`
582 \| `"errorUpdatedAt"`
583 \| `"failureCount"`
584 \| `"failureReason"`
585 \| `"errorUpdateCount"`
586 \| `"isFetched"`
587 \| `"isFetchedAfterMount"`
588 \| `"isFetching"`
589 \| `"isInitialLoading"`
590 \| `"isPaused"`
591 \| `"isRefetching"`
592 \| `"isStale"`
593 \| `"isEnabled"`
594 \| `"refetch"`
595 \| `"fetchStatus"`
596β
597The name of the property that was read.
598β
599#### Returns
600β
601`void`
602β
603#### Inherited from
604β
605[`QueryObserver`](QueryObserver.md).[`trackProp`](QueryObserver.md#trackprop)
606β
607***
608β
609### trackResult()
610β
611```ts
612trackResult(result: QueryObserverResult<TData, TError>, onPropTracked?: (key:
613 | "error"
614 | "data"
615 | "isError"
616 | "isPending"
617 | "isLoading"
618 | "isLoadingError"
619 | "isRefetchError"
620 | "isSuccess"
621 | "isPlaceholderData"
622 | "status"
623 | "dataUpdatedAt"
624 | "errorUpdatedAt"
625 | "failureCount"
626 | "failureReason"
627 | "errorUpdateCount"
628 | "isFetched"
629 | "isFetchedAfterMount"
630 | "isFetching"
631 | "isInitialLoading"
632 | "isPaused"
633 | "isRefetching"
634 | "isStale"
635 | "isEnabled"
636 | "refetch"
637| "fetchStatus") => void): QueryObserverResult<TData, TError>;
638```
639β
640Defined in: [packages/query-core/src/queryObserver.ts:343](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L343)
641β
642Wraps a `QueryObserverResult` in a `Proxy` that records which properties are read, via
643[QueryObserver#trackProp](QueryObserver.md#trackprop) (and an optional `onPropTracked` callback). Used by framework
644adapters when `notifyOnChangeProps` is not set, to implement its default "only re-render on
645properties you actually read" behavior.
646β
647#### Parameters
648β
649##### result
650β
651[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\>
652β
653The result to wrap.
654β
655##### onPropTracked?
656β
657(`key`:
658 \| `"error"`
659 \| `"data"`
660 \| `"isError"`
661 \| `"isPending"`
662 \| `"isLoading"`
663 \| `"isLoadingError"`
664 \| `"isRefetchError"`
665 \| `"isSuccess"`
666 \| `"isPlaceholderData"`
667 \| `"status"`
668 \| `"dataUpdatedAt"`
669 \| `"errorUpdatedAt"`
670 \| `"failureCount"`
671 \| `"failureReason"`
672 \| `"errorUpdateCount"`
673 \| `"isFetched"`
674 \| `"isFetchedAfterMount"`
675 \| `"isFetching"`
676 \| `"isInitialLoading"`
677 \| `"isPaused"`
678 \| `"isRefetching"`
679 \| `"isStale"`
680 \| `"isEnabled"`
681 \| `"refetch"`
682 \| `"fetchStatus"`) => `void`
683β
684Called with the name of each property that is read.
685β
686#### Returns
687β
688[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\>
689β
690A proxy of `result` that tracks property reads.
691β
692#### Inherited from
693β
694[`QueryObserver`](QueryObserver.md).[`trackResult`](QueryObserver.md#trackresult)
695β
696***
697β
698### updateResult()
699β
700```ts
701updateResult(): void;
702```
703β
704Defined in: [packages/query-core/src/queryObserver.ts:765](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L765)
705β
706Recomputes and stores the current result from the current query/options, notifying listeners
707if it changed. Framework adapters call this right after subscribing to make sure no query
708update was missed in the gap between creating the observer and subscribing to it.
709β
710#### Returns
711β
712`void`
713β
714#### Inherited from
715β
716[`QueryObserver`](QueryObserver.md).[`updateResult`](QueryObserver.md#updateresult)