Open History to see the last commit
1---
2id: infiniteQueryOptions
3title: infiniteQueryOptions
4---
5β
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7β
8## Overview
9β
10```ts
11function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
12function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
13function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
14```
15β
16- [`DefinedInitialDataInfiniteOptions` β `DefinedInitialDataInfiniteOptions & QueryKeyWithDataTag`](#call-signature-1): You can generally pass everything to `infiniteQueryOptions` that you can also pass to `injectInfiniteQuery`. These options can be shared across functions and imperative APIs such as `queryClient.fetchInfiniteQuery`. `options.queryKey` is required and is the query key to generate options for.
17- [`UnusedSkipTokenInfiniteOptions` β `UnusedSkipTokenInfiniteOptions & QueryKeyWithDataTag`](#call-signature-2): You can generally pass everything to `infiniteQueryOptions` that you can also pass to `injectInfiniteQuery`. These options can be shared across functions and imperative APIs such as `queryClient.fetchInfiniteQuery`. `options.queryKey` is required and is the query key to generate options for.
18- [`UndefinedInitialDataInfiniteOptions` β `UndefinedInitialDataInfiniteOptions & QueryKeyWithDataTag`](#call-signature-3): You can generally pass everything to `infiniteQueryOptions` that you can also pass to `injectInfiniteQuery`. These options can be shared across functions and imperative APIs such as `queryClient.fetchInfiniteQuery`. `options.queryKey` is required and is the query key to generate options for.
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 infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
28```
29β
30Defined in: [packages/angular-query-experimental/src/infinite-query-options.ts:177](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L177)
31β
32You can generally pass everything to `infiniteQueryOptions` that you can also pass to
33`injectInfiniteQuery`. These options can be shared across functions and imperative APIs such as
34`queryClient.fetchInfiniteQuery`. `options.queryKey` is required and is the query key to generate options
35for.
36β
37This overload is selected when `initialData` is known to be defined.
38β
39### Type Parameters
40β
41#### TQueryFnData
42β
43`TQueryFnData`
44β
45#### TError
46β
47`TError` = `Error`
48β
49#### TData
50β
51`TData` = [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>
52β
53#### TQueryKey
54β
55`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
56β
57#### TPageParam
58β
59`TPageParam` = `unknown`
60β
61### Parameters
62β
63#### options
64β
65[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
66β
67The [DefinedInitialDataInfiniteOptions](../type-aliases/DefinedInitialDataInfiniteOptions.md) to use β everything you can pass to
68`injectInfiniteQuery`, with `initialData` known to be defined.
69β
70### Returns
71β
72[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`\>, `TError`\>
73β
74The same options object, typed so that `queryKey` carries the inferred data type.
75β
76### Remarks
77β
78See [injectInfiniteQuery](injectInfiniteQuery.md) for examples that fetch further pages, from a button click or
79automatically as the user scrolls.
80β
81### See
82β
83[injectInfiniteQuery](injectInfiniteQuery.md) to run an infinite query with these options.
84β
85### Example
86β
87```angular-ts
88import { infiniteQueryOptions, injectInfiniteQuery } from '@tanstack/angular-query-experimental'
89β
90export const projectsOptions = infiniteQueryOptions({
91 queryKey: ['projects'],
92 queryFn: ({ pageParam }) => fetchProjects(pageParam),
93 initialPageParam: 0,
94 getNextPageParam: (lastPage) => lastPage.nextId,
95 initialData: { pages: [], pageParams: [] },
96})
97β
98@Component({
99 selector: 'projects',
100 template: `
101 <!-- `projectsQuery.data()` is never `undefined`, thanks to `initialData` β even if a
102 refetch fails, so the list stays visible alongside the error. -->
103 <ul>
104 @for (page of projectsQuery.data().pages; track $index) {
105 @for (project of page.projects; track project.id) {
106 <li>{{ project.name }}</li>
107 }
108 }
109 </ul>
110 `,
111})
112export class Projects {
113 readonly projectsQuery = injectInfiniteQuery(() => projectsOptions)
114}
115```
116β
117<a id="call-signature-2"></a>
118β
119## Call Signature
120β
121```ts
122function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
123```
124β
125Defined in: [packages/angular-query-experimental/src/infinite-query-options.ts:248](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L248)
126β
127You can generally pass everything to `infiniteQueryOptions` that you can also pass to
128`injectInfiniteQuery`. These options can be shared across functions and imperative APIs such as
129`queryClient.fetchInfiniteQuery`. `options.queryKey` is required and is the query key to generate options
130for.
131β
132### Type Parameters
133β
134#### TQueryFnData
135β
136`TQueryFnData`
137β
138#### TError
139β
140`TError` = `Error`
141β
142#### TData
143β
144`TData` = [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>
145β
146#### TQueryKey
147β
148`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
149β
150#### TPageParam
151β
152`TPageParam` = `unknown`
153β
154### Parameters
155β
156#### options
157β
158[`UnusedSkipTokenInfiniteOptions`](../type-aliases/UnusedSkipTokenInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
159β
160The [UnusedSkipTokenInfiniteOptions](../type-aliases/UnusedSkipTokenInfiniteOptions.md) to use β everything you can pass to
161`injectInfiniteQuery`.
162β
163### Returns
164β
165[`UnusedSkipTokenInfiniteOptions`](../type-aliases/UnusedSkipTokenInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`\>, `TError`\>
166β
167The same options object, typed so that `queryKey` carries the inferred data type.
168β
169### Remarks
170β
171See [injectInfiniteQuery](injectInfiniteQuery.md) for examples that fetch further pages, from a button click or
172automatically as the user scrolls.
173β
174### See
175β
176[injectInfiniteQuery](injectInfiniteQuery.md) to run an infinite query with these options.
177β
178### Example
179β
180A parameterized factory, so the same options object can be reused per `postId`:
181```angular-ts
182import { infiniteQueryOptions, injectInfiniteQuery } from '@tanstack/angular-query-experimental'
183β
184export const commentsOptions = (postId: string) =>
185 infiniteQueryOptions({
186 queryKey: ['post', postId, 'comments'],
187 queryFn: ({ pageParam }) => fetchComments(postId, pageParam),
188 initialPageParam: 0,
189 getNextPageParam: (lastPage) => lastPage.nextId,
190 })
191β
192@Component({
193 selector: 'comments',
194 template: `
195 @if (commentsQuery.isPending()) {
196 Loading...
197 } @else if (commentsQuery.isError()) {
198 <span>Error: {{ commentsQuery.error()?.message }}</span>
199 } @else {
200 <ul>
201 @for (page of commentsQuery.data().pages; track $index) {
202 @for (comment of page.comments; track comment.id) {
203 <li>{{ comment.text }}</li>
204 }
205 }
206 </ul>
207 }
208 `,
209})
210export class Comments {
211 readonly postId = signal('1')
212 readonly commentsQuery = injectInfiniteQuery(() => commentsOptions(this.postId()))
213}
214```
215β
216<a id="call-signature-3"></a>
217β
218## Call Signature
219β
220```ts
221function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
222```
223β
224Defined in: [packages/angular-query-experimental/src/infinite-query-options.ts:319](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L319)
225β
226You can generally pass everything to `infiniteQueryOptions` that you can also pass to
227`injectInfiniteQuery`. These options can be shared across functions and imperative APIs such as
228`queryClient.fetchInfiniteQuery`. `options.queryKey` is required and is the query key to generate options
229for.
230β
231### Type Parameters
232β
233#### TQueryFnData
234β
235`TQueryFnData`
236β
237#### TError
238β
239`TError` = `Error`
240β
241#### TData
242β
243`TData` = [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>
244β
245#### TQueryKey
246β
247`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
248β
249#### TPageParam
250β
251`TPageParam` = `unknown`
252β
253### Parameters
254β
255#### options
256β
257[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
258β
259The [UndefinedInitialDataInfiniteOptions](../type-aliases/UndefinedInitialDataInfiniteOptions.md) to use β everything you can pass to
260`injectInfiniteQuery`.
261β
262### Returns
263β
264[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`\>, `TError`\>
265β
266The same options object, typed so that `queryKey` carries the inferred data type.
267β
268### Remarks
269β
270See [injectInfiniteQuery](injectInfiniteQuery.md) for examples that fetch further pages (from a button click or
271automatically as the user scrolls) and that use `skipToken` to disable the query until `postId` is set.
272β
273### See
274β
275[injectInfiniteQuery](injectInfiniteQuery.md) to run an infinite query with these options.
276β
277### Example
278β
279A parameterized factory, so the same options object can be reused per `postId`:
280```angular-ts
281import { infiniteQueryOptions, injectInfiniteQuery } from '@tanstack/angular-query-experimental'
282β
283export const commentsOptions = (postId: string) =>
284 infiniteQueryOptions({
285 queryKey: ['post', postId, 'comments'],
286 queryFn: ({ pageParam }) => fetchComments(postId, pageParam),
287 initialPageParam: 0,
288 getNextPageParam: (lastPage) => lastPage.nextId,
289 })
290β
291@Component({
292 selector: 'comments',
293 template: `
294 @if (commentsQuery.isPending()) {
295 Loading...
296 } @else if (commentsQuery.isError()) {
297 <span>Error: {{ commentsQuery.error()?.message }}</span>
298 } @else {
299 <ul>
300 @for (page of commentsQuery.data().pages; track $index) {
301 @for (comment of page.comments; track comment.id) {
302 <li>{{ comment.text }}</li>
303 }
304 }
305 </ul>
306 }
307 `,
308})
309export class Comments {
310 readonly postId = signal('1')
311 readonly commentsQuery = injectInfiniteQuery(() => commentsOptions(this.postId()))
312}
313```
314β
315<a id="parameters-summary"></a>
316β
317## Parameters
318β
319### options
320β
321[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
322β
323The [UndefinedInitialDataInfiniteOptions](../type-aliases/UndefinedInitialDataInfiniteOptions.md) to use β everything you can pass to
324`injectInfiniteQuery`.
325β
326<a id="options-properties"></a>
327β
328#### `options` properties
329β
330Built from [`CreateInfiniteQueryOptions`](../interfaces/CreateInfiniteQueryOptions.md#properties). See the type above for what it changes.
331β
332<a id="returns-summary"></a>
333β
334## Returns
335β
336[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`\>, `TError`\>
337β
338The same options object, typed so that `queryKey` carries the inferred data type.
339β
340<a id="result-properties"></a>
341β
342### Result properties
343β
344Built from [`CreateInfiniteQueryOptions`](../interfaces/CreateInfiniteQueryOptions.md#properties), [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md#properties). See the type above for what it changes.