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