Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

infiniteQueryOptions.md

344 lines14.0 KB

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)
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()))
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()))
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.