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