Open History to see the last commit
1---
2id: injectInfiniteQuery
3title: injectInfiniteQuery
4---
5β
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7β
8## Overview
9β
10```ts
11function injectInfiniteQuery<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(injectInfiniteQueryFn: () => DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, options?: InjectInfiniteQueryOptions): DefinedCreateInfiniteQueryResult<TData, TError>;
12function injectInfiniteQuery<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(injectInfiniteQueryFn: () => UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, options?: InjectInfiniteQueryOptions): CreateInfiniteQueryResult<TData, TError>;
13function injectInfiniteQuery<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(injectInfiniteQueryFn: () => CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, options?: InjectInfiniteQueryOptions): CreateInfiniteQueryResult<TData, TError>;
14```
15β
16- [`() => DefinedInitialDataInfiniteOptions` β `DefinedCreateInfiniteQueryResult`](#call-signature-1): The options for `injectInfiniteQuery` are identical to `injectQuery`, with the addition of `initialPageParam`, `getNextPageParam`, `getPreviousPageParam`, and `maxPages`. Infinite queries can additively "load more" data onto an existing set of data, or "infinite scroll".
17- [`() => UndefinedInitialDataInfiniteOptions` β `CreateInfiniteQueryResult`](#call-signature-2): Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key. Infinite queries can additively "load more" data onto an existing set of data, or "infinite scroll".
18- [`() => CreateInfiniteQueryOptions` β `CreateInfiniteQueryResult`](#call-signature-3): This overload accepts the general [CreateInfiniteQueryOptions](../interfaces/CreateInfiniteQueryOptions.md) shape rather than the `initialData`-aware overloads above, so whether `data` is defined can't be inferred from the call site β useful when wrapping `injectInfiniteQuery` in your own helper function that forwards caller-provided options.
19β
20See also: [Parameters](#parameters-summary) Β· [Returns](#returns-summary)
21β
22<a id="call-signature-1"></a>
23β
24## Call Signature
25β
26```ts
27function injectInfiniteQuery<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(injectInfiniteQueryFn: () => DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, options?: InjectInfiniteQueryOptions): DefinedCreateInfiniteQueryResult<TData, TError>;
28```
29β
30Defined in: [packages/angular-query-experimental/src/inject-infinite-query.ts:87](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L87)
31β
32The options for `injectInfiniteQuery` are identical to `injectQuery`, with the addition of
33`initialPageParam`, `getNextPageParam`, `getPreviousPageParam`, and `maxPages`. Infinite queries can
34additively "load more" data onto an existing set of data, or "infinite scroll".
35β
36This overload is selected when `initialData` is known to be defined on the options returned by
37`injectInfiniteQueryFn`, so the resulting `data` signal is never `undefined` (unless a `select` changes
38`TData` to include `undefined`).
39β
40### Type Parameters
41β
42#### TQueryFnData
43β
44`TQueryFnData`
45β
46#### TError
47β
48`TError` = `Error`
49β
50#### TData
51β
52`TData` = [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>
53β
54#### TQueryKey
55β
56`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
57β
58#### TPageParam
59β
60`TPageParam` = `unknown`
61β
62### Parameters
63β
64#### injectInfiniteQueryFn
65β
66() => [`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
67β
68A function returning the [DefinedInitialDataInfiniteOptions](../type-aliases/DefinedInitialDataInfiniteOptions.md) to use β
69everything you can pass to `injectInfiniteQuery`, with `initialData` known to be defined. Similar to
70`computed` from Angular, this function runs in the reactive context, so signals read inside it drive the
71query.
72β
73#### options?
74β
75[`InjectInfiniteQueryOptions`](../interfaces/InjectInfiniteQueryOptions.md)
76β
77Additional configuration.
78β
79### Returns
80β
81[`DefinedCreateInfiniteQueryResult`](../type-aliases/DefinedCreateInfiniteQueryResult.md)\<`TData`, `TError`\>
82β
83The same signals as `injectQuery`, with the addition of `fetchNextPage`, `fetchPreviousPage`,
84`hasNextPage`, `hasPreviousPage`, `isFetchingNextPage`, and `isFetchingPreviousPage`. `data().pages` and
85`data().pageParams` are also added, as long as a `select` doesn't change `TData` away from its default
86`InfiniteData<TQueryFnData>` shape.
87β
88### Remarks
89β
90Keep in mind that imperative fetch calls, such as `fetchNextPage`, may interfere with the default
91refetch behavior, resulting in outdated data. Make sure to call these functions only in response to user
92actions, or add conditions like `hasNextPage() && !isFetching()`.
93β
94### See
95β
96[infiniteQueryOptions](infiniteQueryOptions.md) to share these options between `injectInfiniteQuery` and imperative APIs
97like `queryClient.fetchInfiniteQuery`.
98β
99### Example
100β
101```angular-ts
102@Component({
103 selector: 'projects',
104 template: `
105 <!-- `projectsQuery.data()` is never `undefined`, thanks to `initialData` β even if a
106 refetch fails, so the list stays visible alongside the error. -->
107 <ul>
108 @for (page of projectsQuery.data().pages; track $index) {
109 @for (project of page.projects; track project.id) {
110 <li>{{ project.name }}</li>
111 }
112 }
113 </ul>
114 `,
115})
116export class Projects {
117 readonly projectsQuery = injectInfiniteQuery(() => ({
118 queryKey: ['projects'],
119 queryFn: ({ pageParam }) => fetchProjects(pageParam),
120 initialPageParam: 0,
121 getNextPageParam: (lastPage) => lastPage.nextId,
122 initialData: { pages: [], pageParams: [] },
123 }))
124}
125```
126β
127<a id="call-signature-2"></a>
128β
129## Call Signature
130β
131```ts
132function injectInfiniteQuery<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(injectInfiniteQueryFn: () => UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, options?: InjectInfiniteQueryOptions): CreateInfiniteQueryResult<TData, TError>;
133```
134β
135Defined in: [packages/angular-query-experimental/src/inject-infinite-query.ts:239](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L239)
136β
137Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a
138unique key. Infinite queries can additively "load more" data onto an existing set of data, or
139"infinite scroll".
140β
141### Type Parameters
142β
143#### TQueryFnData
144β
145`TQueryFnData`
146β
147#### TError
148β
149`TError` = `Error`
150β
151#### TData
152β
153`TData` = [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>
154β
155#### TQueryKey
156β
157`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
158β
159#### TPageParam
160β
161`TPageParam` = `unknown`
162β
163### Parameters
164β
165#### injectInfiniteQueryFn
166β
167() => [`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
168β
169A function returning the [UndefinedInitialDataInfiniteOptions](../type-aliases/UndefinedInitialDataInfiniteOptions.md) to use
170β everything you can pass to `injectInfiniteQuery`. Similar to `computed` from Angular, this function runs
171in the reactive context, so signals read inside it drive the query.
172β
173#### options?
174β
175[`InjectInfiniteQueryOptions`](../interfaces/InjectInfiniteQueryOptions.md)
176β
177Additional configuration.
178β
179### Returns
180β
181[`CreateInfiniteQueryResult`](../type-aliases/CreateInfiniteQueryResult.md)\<`TData`, `TError`\>
182β
183The same signals as `injectQuery`, with the addition of `fetchNextPage`, `fetchPreviousPage`,
184`hasNextPage`, `hasPreviousPage`, `isFetchingNextPage`, and `isFetchingPreviousPage`. `data().pages` and
185`data().pageParams` are also added, as long as a `select` doesn't change `TData` away from its default
186`InfiniteData<TQueryFnData>` shape.
187β
188### Remarks
189β
190Keep in mind that imperative fetch calls, such as `fetchNextPage`, may interfere with the default
191refetch behavior, resulting in outdated data. Make sure to call these functions only in response to user
192actions, or add conditions like `hasNextPage() && !isFetching()`. This is the only overload that accepts
193`queryFn: skipToken`, shown below.
194β
195### See
196β
197[infiniteQueryOptions](infiniteQueryOptions.md) to share these options between `injectInfiniteQuery` and imperative APIs
198like `queryClient.fetchInfiniteQuery`.
199β
200### Examples
201β
202Fetching the next page from a button click:
203```angular-ts
204@Component({
205 selector: 'projects-list',
206 template: `
207 <ul>
208 @for (page of projectsQuery.data()?.pages; track $index) {
209 @for (project of page.projects; track project.id) {
210 <li>{{ project.name }}</li>
211 }
212 }
213 </ul>
214 <button
215 [disabled]="!projectsQuery.hasNextPage() || projectsQuery.isFetching()"
216 (click)="projectsQuery.fetchNextPage()"
217 >
218 Load More
219 </button>
220 `,
221})
222export class ProjectsList {
223 readonly projectsQuery = injectInfiniteQuery(() => ({
224 queryKey: ['projects'],
225 queryFn: ({ pageParam }) => fetchProjects(pageParam),
226 initialPageParam: 0,
227 getNextPageParam: (lastPage) => lastPage.nextId,
228 }))
229}
230```
231β
232Fetching the next page automatically as the user scrolls, using an `IntersectionObserver` on a sentinel
233element after the list:
234```angular-ts
235@Component({
236 selector: 'projects-list',
237 template: `
238 <ul>
239 @for (page of projectsQuery.data()?.pages; track $index) {
240 @for (project of page.projects; track project.id) {
241 <li>{{ project.name }}</li>
242 }
243 }
244 </ul>
245 <div #sentinel>{{ projectsQuery.isFetchingNextPage() ? 'Loading more...' : '' }}</div>
246 `,
247})
248export class ProjectsList {
249 readonly sentinel = viewChild<ElementRef<HTMLElement>>('sentinel')
250β
251 readonly projectsQuery = injectInfiniteQuery(() => ({
252 queryKey: ['projects'],
253 queryFn: ({ pageParam }) => fetchProjects(pageParam),
254 initialPageParam: 0,
255 getNextPageParam: (lastPage) => lastPage.nextId,
256 }))
257β
258 constructor() {
259 effect((onCleanup) => {
260 const sentinel = this.sentinel()?.nativeElement
261 if (
262 sentinel == null ||
263 !this.projectsQuery.hasNextPage() ||
264 this.projectsQuery.isFetching()
265 ) {
266 return
267 }
268β
269 const observer = new IntersectionObserver(([entry]) => {
270 if (entry?.isIntersecting) this.projectsQuery.fetchNextPage()
271 })
272 observer.observe(sentinel)
273β
274 onCleanup(() => observer.disconnect())
275 })
276 }
277}
278```
279β
280A query that's disabled, type safe, until `postId` is set β pass `skipToken` as `queryFn` instead of
281setting `enabled: false`:
282```angular-ts
283@Component({
284 selector: 'comments',
285 template: `
286 @if (postId() == null) {
287 Select a post
288 } @else if (commentsQuery.isPending()) {
289 Loading...
290 } @else if (commentsQuery.isError()) {
291 <span>Error: {{ commentsQuery.error()?.message }}</span>
292 } @else {
293 <ul>
294 @for (page of commentsQuery.data().pages; track $index) {
295 @for (comment of page.comments; track comment.id) {
296 <li>{{ comment.text }}</li>
297 }
298 }
299 </ul>
300 }
301 `,
302})
303export class Comments {
304 readonly postId = signal<string | undefined>(undefined)
305β
306 readonly commentsQuery = injectInfiniteQuery(() => ({
307 queryKey: ['post', this.postId(), 'comments'],
308 queryFn:
309 this.postId() != null
310 ? ({ pageParam }) => fetchComments(this.postId()!, pageParam)
311 : skipToken,
312 initialPageParam: 0,
313 getNextPageParam: (lastPage) => lastPage.nextId,
314 }))
315}
316```
317β
318<a id="call-signature-3"></a>
319β
320## Call Signature
321β
322```ts
323function injectInfiniteQuery<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(injectInfiniteQueryFn: () => CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, options?: InjectInfiniteQueryOptions): CreateInfiniteQueryResult<TData, TError>;
324```
325β
326Defined in: [packages/angular-query-experimental/src/inject-infinite-query.ts:266](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L266)
327β
328This overload accepts the general [CreateInfiniteQueryOptions](../interfaces/CreateInfiniteQueryOptions.md) shape rather than the
329`initialData`-aware overloads above, so whether `data` is defined can't be inferred from the call site β
330useful when wrapping `injectInfiniteQuery` in your own helper function that forwards caller-provided
331options.
332β
333### Type Parameters
334β
335#### TQueryFnData
336β
337`TQueryFnData`
338β
339#### TError
340β
341`TError` = `Error`
342β
343#### TData
344β
345`TData` = [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>
346β
347#### TQueryKey
348β
349`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
350β
351#### TPageParam
352β
353`TPageParam` = `unknown`
354β
355### Parameters
356β
357#### injectInfiniteQueryFn
358β
359() => [`CreateInfiniteQueryOptions`](../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
360β
361A function that returns infinite query options. Similar to `computed` from
362Angular, this function runs in the reactive context, so signals read inside it drive the query.
363β
364#### options?
365β
366[`InjectInfiniteQueryOptions`](../interfaces/InjectInfiniteQueryOptions.md)
367β
368Additional configuration.
369β
370### Returns
371β
372[`CreateInfiniteQueryResult`](../type-aliases/CreateInfiniteQueryResult.md)\<`TData`, `TError`\>
373β
374The infinite query result.
375β
376<a id="parameters-summary"></a>
377β
378## Parameters
379β
380### injectInfiniteQueryFn
381β
382() => [`CreateInfiniteQueryOptions`](../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
383β
384A function that returns infinite query options. Similar to `computed` from
385Angular, this function runs in the reactive context, so signals read inside it drive the query.
386β
387<a id="injectInfiniteQueryFn-properties"></a>
388β
389#### `injectInfiniteQueryFn` properties
390β
391| Property | Type | Default value | Description |
392| ------ | ------ | ------ | ------ |
393| <a id="injectInfiniteQueryFn-property-enabled"></a> `enabled?` | \| `false` \| `true` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\>) => `boolean`) | `true` | Set this to `false` or a function that returns `false` to disable automatic refetching when the query mounts or changes query keys. To refetch the query, use the `refetch` method returned from the `useQuery` instance. Accepts a boolean or function that returns a boolean. |
394| <a id="injectInfiniteQueryFn-property-gctime"></a> `gcTime?` | `number` | `undefined` | The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used. Setting it to `Infinity` will disable garbage collection. Defaults to `5 * 60 * 1000` (5 minutes), or `Infinity` during SSR. Note: the maximum allowed time is about 24 days, imposed by `setTimeout`'s 32-bit signed integer delay β see `timeoutManager.setTimeoutProvider` for a workaround. |
395| <a id="injectInfiniteQueryFn-property-getnextpageparam"></a> `getNextPageParam` | (`lastPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `lastPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the next cursor for infinite queries. The result will also be used to determine the value of `hasNextPage`. |
396| <a id="injectInfiniteQueryFn-property-getpreviouspageparam"></a> `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. |
397| <a id="injectInfiniteQueryFn-property-initialdata"></a> `initialData?` | \| [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| (() => \| [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined`) | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. |
398| <a id="injectInfiniteQueryFn-property-initialdataupdatedat"></a> `initialDataUpdatedAt?` | `number` \| (() => `number` \| `undefined`) | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. |
399| <a id="injectInfiniteQueryFn-property-initialpageparam"></a> `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. |
400| <a id="injectInfiniteQueryFn-property-maxpages"></a> `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. |
401| <a id="injectInfiniteQueryFn-property-meta"></a> `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. |
402| <a id="injectInfiniteQueryFn-property-networkmode"></a> `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. |
403| <a id="injectInfiniteQueryFn-property-notifyonchangeprops"></a> `notifyOnChangeProps?` | \| ( \| `"error"` \| `"data"` \| `"isError"` \| `"isPending"` \| `"isLoading"` \| `"isLoadingError"` \| `"isRefetchError"` \| `"isSuccess"` \| `"isPlaceholderData"` \| `"status"` \| `"dataUpdatedAt"` \| `"errorUpdatedAt"` \| `"failureCount"` \| `"failureReason"` \| `"errorUpdateCount"` \| `"isFetched"` \| `"isFetchedAfterMount"` \| `"isFetching"` \| `"isInitialLoading"` \| `"isPaused"` \| `"isRefetching"` \| `"isStale"` \| `"isEnabled"` \| `"refetch"` \| `"fetchStatus"` \| `"fetchNextPage"` \| `"fetchPreviousPage"` \| `"hasNextPage"` \| `"hasPreviousPage"` \| `"isFetchNextPageError"` \| `"isFetchingNextPage"` \| `"isFetchPreviousPageError"` \| `"isFetchingPreviousPage"`)[] \| `"all"` \| (() => \| `"all"` \| ( \| `"error"` \| `"data"` \| `"isError"` \| `"isPending"` \| `"isLoading"` \| `"isLoadingError"` \| `"isRefetchError"` \| `"isSuccess"` \| `"isPlaceholderData"` \| `"status"` \| `"dataUpdatedAt"` \| `"errorUpdatedAt"` \| `"failureCount"` \| `"failureReason"` \| `"errorUpdateCount"` \| `"isFetched"` \| `"isFetchedAfterMount"` \| `"isFetching"` \| `"isInitialLoading"` \| `"isPaused"` \| `"isRefetching"` \| `"isStale"` \| `"isEnabled"` \| `"refetch"` \| `"fetchStatus"` \| `"fetchNextPage"` \| `"fetchPreviousPage"` \| `"hasNextPage"` \| `"hasPreviousPage"` \| `"isFetchNextPageError"` \| `"isFetchingNextPage"` \| `"isFetchPreviousPageError"` \| `"isFetchingPreviousPage"`)[] \| `undefined`) | `undefined` | If set, the component will only re-render if any of the listed properties change. When set to `['data', 'error']`, the component will only re-render when the `data` or `error` properties change. When set to `'all'`, the component will re-render whenever a query is updated. When set to a function, the function will be executed to compute the list of properties. Defaults to `undefined`, in which case property access is tracked automatically, and the component only re-renders when one of the tracked properties changes. |
404| <a id="injectInfiniteQueryFn-property-persister"></a> `persister?` | (`queryFn`: (`context`: [`QueryFunctionContext`](../type-aliases/QueryFunctionContext.md)\<`NoInfer`\<`TQueryKey`\>, `TPageParam`\>) => `TQueryFnData` \| `Promise`\<`TQueryFnData`\>, `context`: `object`, `query`: [`Query`](../classes/Query.md)) => `TQueryFnData` \| `Promise`\<`TQueryFnData`\> | `undefined` | This option can be used to persist the result of a query to an external storage, bypassing the need to actually call the `queryFn`. Useful for persisting a query's data across e.g. server/client boundaries. |
405| <a id="injectInfiniteQueryFn-property-placeholderdata"></a> `placeholderData?` | \| [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| ((`previousData`: \| [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined`, `previousQuery`: \| [`Query`](../classes/Query.md)\<[`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\> \| `undefined`) => \| [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined`) | `undefined` | If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `loading` data and no initialData has been provided. |
406| <a id="injectInfiniteQueryFn-property-queryfn"></a> `queryFn?` | \| *typeof* [`skipToken`](../variables/skipToken.md) \| ((`context`: [`QueryFunctionContext`](../type-aliases/QueryFunctionContext.md)\<`TQueryKey`, `TPageParam`\>) => `TQueryFnData` \| `Promise`\<`TQueryFnData`\>) | `undefined` | The function that the query will use to request data. Required, unless a default query function has been set via `queryClient.setQueryDefaults` or `queryClient.setDefaultOptions`. Receives a [QueryFunctionContext](../type-aliases/QueryFunctionContext.md). Must return a promise that will either resolve data or throw an error. The data cannot be `undefined`. |
407| <a id="injectInfiniteQueryFn-property-queryhash"></a> `queryHash?` | `string` | `undefined` | The hashed form of `queryKey`, computed with `queryKeyHashFn` (or the default hashing function otherwise). Used as the actual cache key internally. |
408| <a id="injectInfiniteQueryFn-property-querykey"></a> `queryKey` | `TQueryKey` & `object` | `undefined` | The query key to use for this query. The query key will be hashed into a stable hash. See [Query Keys](https://tanstack.com/query/latest/docs/framework/react/guides/query-keys) for more information. The query will automatically update when this key changes (as long as `enabled` is not set to `false`). |
409| <a id="injectInfiniteQueryFn-property-querykeyhashfn"></a> `queryKeyHashFn?` | (`queryKey`: `TQueryKey`) => `string` | `undefined` | If specified, this function is used to hash the `queryKey` to a string. |
410| <a id="injectInfiniteQueryFn-property-refetchinterval"></a> `refetchInterval?` | \| `number` \| `false` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\>) => `number` \| `false` \| `undefined`) | `false` | If set to a number, the query will continuously refetch at this frequency in milliseconds. If set to a function, the function will be executed with the latest data and query to compute a frequency |
411| <a id="injectInfiniteQueryFn-property-refetchintervalinbackground"></a> `refetchIntervalInBackground?` | `boolean` | `false` | If set to `true`, the query will continue to refetch while their tab/window is in the background. |
412| <a id="injectInfiniteQueryFn-property-refetchonmount"></a> `refetchOnMount?` | \| `boolean` \| `"always"` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\>) => `boolean` \| `"always"`) | `true` | If set to `true`, the query will refetch on mount if the data is stale. If set to `false`, will disable additional instances of a query to trigger background refetch. If set to `'always'`, the query will always refetch on mount (except when `staleTime: 'static'` is used). If set to a function, the function will be executed with the latest data and query to compute the value |
413| <a id="injectInfiniteQueryFn-property-refetchonreconnect"></a> `refetchOnReconnect?` | \| `boolean` \| `"always"` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\>) => `boolean` \| `"always"`) | `undefined` | If set to `true`, the query will refetch on reconnect if the data is stale. If set to `false`, the query will not refetch on reconnect. If set to `'always'`, the query will always refetch on reconnect (except when `staleTime: 'static'` is used). If set to a function, the function will be executed with the latest data and query to compute the value. Defaults to `true` unless `networkMode` is `'always'`. |
414| <a id="injectInfiniteQueryFn-property-refetchonwindowfocus"></a> `refetchOnWindowFocus?` | \| `boolean` \| `"always"` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\>) => `boolean` \| `"always"`) | `true` | If set to `true`, the query will refetch on window focus if the data is stale. If set to `false`, the query will not refetch on window focus. If set to `'always'`, the query will always refetch on window focus (except when `staleTime: 'static'` is used). If set to a function, the function will be executed with the latest data and query to compute the value. |
415| <a id="injectInfiniteQueryFn-property-retry"></a> `retry?` | \| `number` \| `false` \| `true` \| ((`failureCount`: `number`, `error`: `TError`) => `boolean`) | `undefined` | If `false`, failed queries will not retry by default. If `true`, failed queries will retry infinitely. If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. If set to a function `(failureCount, error) => boolean` failed queries will retry until the function returns false. Defaults to `3` on the client and `0` on the server. |
416| <a id="injectInfiniteQueryFn-property-retrydelay"></a> `retryDelay?` | `number` \| ((`failureCount`: `number`, `error`: `TError`) => `number`) | `undefined` | This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds. A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff. A function like `attempt => attempt * 1000` applies linear backoff. Defaults to a function that applies exponential backoff, capped at 30 seconds. |
417| <a id="injectInfiniteQueryFn-property-retryonmount"></a> `retryOnMount?` | \| `false` \| `true` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\>) => `boolean`) | `true` | If set to `false`, the query will not be retried on mount if it contains an error. If set to a function, the function will be executed with the query to compute the value. |
418| <a id="injectInfiniteQueryFn-property-select"></a> `select?` | (`data`: [`InfiniteData`](../interfaces/InfiniteData.md)) => `TData` | `undefined` | This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache. The `select` function will only run if `data` changed, or if the reference to the `select` function itself changes. To optimize, memoize the function so its reference stays stable across calls. |
419| <a id="injectInfiniteQueryFn-property-staletime"></a> `staleTime?` | \| `number` \| `"static"` \| ((`query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\>) => `number` \| `"static"`) | `0` | The time in milliseconds after data is considered stale. If set to `Infinity`, the data will never be considered stale. If set to `'static'`, the data will never be considered stale. If set to a function, the function will be executed with the query to compute a `staleTime`. |
420| <a id="injectInfiniteQueryFn-property-structuralsharing"></a> `structuralSharing?` | `boolean` \| ((`oldData`: `unknown`, `newData`: `unknown`) => `unknown`) | `true` | Set this to `false` to disable structural sharing between query results. Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom structural sharing logic. |
421| <a id="injectInfiniteQueryFn-property-throwonerror"></a> `throwOnError?` | \| `false` \| `true` \| ((`error`: `TError`, `query`: [`Query`](../classes/Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\>) => `boolean`) | `false` | Whether errors should be thrown instead of setting the `error` property. If set to `true` or `suspense` is `true`, all errors will be thrown to the error boundary. If set to `false` and `suspense` is `false`, errors are returned as state. If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (`true`) or return the error as state (`false`). |
422β
423### options?
424β
425[`InjectInfiniteQueryOptions`](../interfaces/InjectInfiniteQueryOptions.md)
426β
427Additional configuration.
428β
429<a id="options-properties"></a>
430β
431#### `options` properties
432β
433| Property | Type | Description |
434| ------ | ------ | ------ |
435| <a id="options-property-injector"></a> `injector?` | `Injector` | The `Injector` in which to create the infinite query. If this is not provided, the current injection context will be used instead (via `inject`). |
436β
437<a id="returns-summary"></a>
438β
439## Returns
440β
441[`CreateInfiniteQueryResult`](../type-aliases/CreateInfiniteQueryResult.md)\<`TData`, `TError`\>
442β
443The infinite query result.
444β
445<a id="result-properties"></a>
446β
447### Result properties
448β
449Built from [`BaseQueryNarrowing`](../interfaces/BaseQueryNarrowing.md#properties), [`InfiniteQueryObserverBaseResult`](../interfaces/InfiniteQueryObserverBaseResult.md#properties). See the type above for what it changes.