You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 29c7399
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/framework/angular/reference/classes/InfiniteQueryObserver.md
+32-32Lines changed: 32 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ id: InfiniteQueryObserver
3
3
title: InfiniteQueryObserver
4
4
---
5
5
6
-
Defined in: [packages/query-core/src/infiniteQueryObserver.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L41)
6
+
Defined in: packages/query-core/dist-ts/src/infiniteQueryObserver.d.ts:26
7
7
8
8
An `InfiniteQueryObserver` extends `QueryObserver` to observe and switch
9
9
between infinite queries. It augments the base `QueryObserverResult` with
Defined in: [packages/query-core/src/infiniteQueryObserver.ts:83](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L83)
61
+
Defined in: packages/query-core/dist-ts/src/infiniteQueryObserver.d.ts:30
62
62
63
63
#### Parameters
64
64
@@ -86,7 +86,7 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:83](https://github
Defined in: [packages/query-core/src/infiniteQueryObserver.ts:72](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L72)
89
+
Defined in: packages/query-core/dist-ts/src/infiniteQueryObserver.d.ts:29
Defined in: [packages/query-core/src/infiniteQueryObserver.ts:60](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L60)
105
+
Defined in: packages/query-core/dist-ts/src/infiniteQueryObserver.d.ts:28
106
106
107
107
Returns the most recently computed `QueryObserverResult` for the
108
108
observed query. This is a point-in-time read; to be notified of updates
Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L55)
161
+
Defined in: packages/query-core/dist-ts/src/infiniteQueryObserver.d.ts:27
162
162
163
163
#### Parameters
164
164
@@ -190,7 +190,7 @@ QueryObserver.subscribe
190
190
protectedbindMethods():void;
191
191
```
192
192
193
-
Defined in: [packages/query-core/src/infiniteQueryObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L96)
193
+
Defined in: packages/query-core/dist-ts/src/infiniteQueryObserver.d.ts:31
194
194
195
195
#### Returns
196
196
@@ -208,7 +208,7 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:96](https://github
Defined in: [packages/query-core/src/infiniteQueryObserver.ts:201](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L201)
211
+
Defined in: packages/query-core/dist-ts/src/infiniteQueryObserver.d.ts:84
212
212
213
213
#### Parameters
214
214
@@ -236,7 +236,7 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:201](https://githu
236
236
destroy():void;
237
237
```
238
238
239
-
Defined in: [packages/query-core/src/queryObserver.ts:161](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L161)
239
+
Defined in: packages/query-core/dist-ts/src/queryObserver.d.ts:53
240
240
241
241
Stops observing the current query: clears all listeners, cancels the
242
242
stale and refetch-interval timers, and removes this observer from the
Defined in: [packages/query-core/src/infiniteQueryObserver.ts:161](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L161)
261
+
Defined in: packages/query-core/dist-ts/src/infiniteQueryObserver.d.ts:64
262
262
263
263
Fetches the next page of the infinite query and returns a promise that
264
264
resolves with the resulting `InfiniteQueryObserverResult`. The page
Defined in: [packages/query-core/src/infiniteQueryObserver.ts:190](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L190)
341
+
Defined in: packages/query-core/dist-ts/src/infiniteQueryObserver.d.ts:83
342
342
343
343
Fetches the previous page of the infinite query and returns a promise
344
344
that resolves with the resulting `InfiniteQueryObserverResult`. The page
Defined in: [packages/query-core/src/infiniteQueryObserver.ts:127](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L127)
401
+
Defined in: packages/query-core/dist-ts/src/infiniteQueryObserver.d.ts:45
402
402
403
403
The infinite-query counterpart of [QueryObserver#getOptimisticResult](QueryObserver.md#getoptimisticresult), marking the
404
404
options as an infinite query before delegating to it. Called by framework adapters (e.g.
@@ -427,7 +427,7 @@ synchronously.
427
427
hasListeners(): boolean;
428
428
```
429
429
430
-
Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19)
430
+
Defined in: packages/query-core/dist-ts/src/subscribable.d.ts:5
431
431
432
432
#### Returns
433
433
@@ -445,7 +445,7 @@ Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanS
445
445
protectedonSubscribe(): void;
446
446
```
447
447
448
-
Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110)
448
+
Defined in: packages/query-core/dist-ts/src/queryObserver.d.ts:34
449
449
450
450
#### Returns
451
451
@@ -463,7 +463,7 @@ Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/Ta
463
463
protectedonUnsubscribe(): void;
464
464
```
465
465
466
-
Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124)
466
+
Defined in: packages/query-core/dist-ts/src/queryObserver.d.ts:35
467
467
468
468
#### Returns
469
469
@@ -478,19 +478,19 @@ Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/Ta
Defined in: [packages/query-core/src/infiniteQueryObserver.ts:108](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L108)
518
+
Defined in: packages/query-core/dist-ts/src/infiniteQueryObserver.d.ts:38
519
519
520
520
Updates the observer's options. Behaves the same as
521
521
`QueryObserver.setOptions`, additionally marking the options as
@@ -544,7 +544,7 @@ implementation.
544
544
shouldFetchOnReconnect(): boolean;
545
545
```
546
546
547
-
Defined in: [packages/query-core/src/queryObserver.ts:135](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L135)
547
+
Defined in: packages/query-core/dist-ts/src/queryObserver.d.ts:41
548
548
549
549
Returns whether the observed query is currently stale and configured
550
550
(via the `refetchOnReconnect` option) to refetch when the network
@@ -566,7 +566,7 @@ reconnects.
566
566
shouldFetchOnWindowFocus(): boolean;
567
567
```
568
568
569
-
Defined in: [packages/query-core/src/queryObserver.ts:148](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L148)
569
+
Defined in: packages/query-core/dist-ts/src/queryObserver.d.ts:47
570
570
571
571
Returns whether the observed query is currently stale and configured
572
572
(via the `refetchOnWindowFocus` option) to refetch when the window
@@ -586,8 +586,8 @@ regains focus.
586
586
587
587
```ts
588
588
trackProp(key:
589
-
|"error"
590
589
|"data"
590
+
|"error"
591
591
|"isError"
592
592
|"isPending"
593
593
|"isLoading"
@@ -613,7 +613,7 @@ trackProp(key:
613
613
|"fetchStatus"): void;
614
614
```
615
615
616
-
Defined in: [packages/query-core/src/queryObserver.ts:350](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L350)
616
+
Defined in: packages/query-core/dist-ts/src/queryObserver.d.ts:102
617
617
618
618
Records that the given `QueryObserverResult` property was read, so a subsequent update only
619
619
notifies this observer if a tracked property actually changed. Normally called indirectly via
@@ -624,7 +624,7 @@ access themselves (e.g. through their own reactivity system) instead of via the
0 commit comments