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: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
13```
14β
15- [`DefinedInitialDataInfiniteOptions` β `DefinedInitialDataInfiniteOptions & QueryKeyWithDataTag`](#call-signature-1): You can generally pass everything to `infiniteQueryOptions` that you can also pass to `createInfiniteQuery`. These options can be shared across `createInfiniteQuery` calls and imperative APIs such as `queryClient.infiniteQuery`. `options.queryKey` is required and is the query key to generate options for.
16- [`UndefinedInitialDataInfiniteOptions` β `UndefinedInitialDataInfiniteOptions & QueryKeyWithDataTag`](#call-signature-2): You can generally pass everything to `infiniteQueryOptions` that you can also pass to `createInfiniteQuery`. These options can be shared across `createInfiniteQuery` calls and imperative APIs such as `queryClient.infiniteQuery`. `options.queryKey` is required and is the query key to generate options for.
17β
18See also: [Parameters](#parameters-summary) Β· [Returns](#returns-summary)
19β
20<a id="call-signature-1"></a>
21β
22## Call Signature
23β
24```ts
25function 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>;
26```
27β
28Defined in: [packages/svelte-query/src/infiniteQueryOptions.ts:99](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/infiniteQueryOptions.ts#L99)
29β
30You can generally pass everything to `infiniteQueryOptions` that you can also pass to `createInfiniteQuery`.
31These options can be shared across `createInfiniteQuery` calls and imperative APIs such as
32`queryClient.infiniteQuery`. `options.queryKey` is required and is the query key to generate options for.
33β
34This overload is selected when `initialData` is known to be defined.
35β
36### Type Parameters
37β
38#### TQueryFnData
39β
40`TQueryFnData`
41β
42#### TError
43β
44`TError` = `Error`
45β
46#### TData
47β
48`TData` = [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>
49β
50#### TQueryKey
51β
52`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
53β
54#### TPageParam
55β
56`TPageParam` = `unknown`
57β
58### Parameters
59β
60#### options
61β
62[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
63β
64The [DefinedInitialDataInfiniteOptions](../type-aliases/DefinedInitialDataInfiniteOptions.md) to use β everything you can pass to
65`createInfiniteQuery`, with `initialData` known to be defined.
66β
67### Returns
68β
69[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`\>, `TError`\>
70β
71The same options object, typed so that `queryKey` carries the inferred data type.
72β
73### See
74β
75[createInfiniteQuery](createInfiniteQuery.md) to run an infinite query with these options.
76β
77### Example
78β
79`initialData` skips the loading state on first render β even if a refetch fails, the list stays
80visible alongside the error:
81```svelte
82<script lang="ts">
83 import { infiniteQueryOptions, createInfiniteQuery } from '@tanstack/svelte-query'
84β
85 const projectsOptions = infiniteQueryOptions({
86 queryKey: ['projects'],
87 queryFn: ({ pageParam }) => fetchProjects(pageParam),
88 initialPageParam: 0,
89 getNextPageParam: (lastPage) => lastPage.nextId,
90 initialData: { pages: [], pageParams: [] },
91 })
92β
93 const query = createInfiniteQuery(() => projectsOptions)
94</script>
95β
96{#if query.isError}
97 <span>Error: {query.error.message}</span>
98{/if}
99<ul>
100 {#each query.data.pages as page}
101 {#each page.projects as project (project.id)}
102 <li>{project.name}</li>
103 {/each}
104 {/each}
105</ul>
106```
107β
108<a id="call-signature-2"></a>
109β
110## Call Signature
111β
112```ts
113function 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>;
114```
115β
116Defined in: [packages/svelte-query/src/infiniteQueryOptions.ts:164](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/infiniteQueryOptions.ts#L164)
117β
118You can generally pass everything to `infiniteQueryOptions` that you can also pass to `createInfiniteQuery`.
119These options can be shared across `createInfiniteQuery` calls and imperative APIs such as
120`queryClient.infiniteQuery`. `options.queryKey` is required and is the query key to generate options for.
121β
122### Type Parameters
123β
124#### TQueryFnData
125β
126`TQueryFnData`
127β
128#### TError
129β
130`TError` = `Error`
131β
132#### TData
133β
134`TData` = [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>
135β
136#### TQueryKey
137β
138`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
139β
140#### TPageParam
141β
142`TPageParam` = `unknown`
143β
144### Parameters
145β
146#### options
147β
148[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
149β
150The [UndefinedInitialDataInfiniteOptions](../type-aliases/UndefinedInitialDataInfiniteOptions.md) to use β everything you can pass to
151`createInfiniteQuery`.
152β
153### Returns
154β
155[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`\>, `TError`\>
156β
157The same options object, typed so that `queryKey` carries the inferred data type.
158β
159### See
160β
161[createInfiniteQuery](createInfiniteQuery.md) to run an infinite query with these options.
162β
163### Example
164β
165A parameterized factory, so the same options object can be reused per `postId`:
166```svelte
167<script lang="ts">
168 import { infiniteQueryOptions, createInfiniteQuery } from '@tanstack/svelte-query'
169β
170 let { postId }: { postId: string } = $props()
171β
172 const commentsOptions = (postId: string) =>
173 infiniteQueryOptions({
174 queryKey: ['post', postId, 'comments'],
175 queryFn: ({ pageParam }) => fetchComments(postId, pageParam),
176 initialPageParam: 0,
177 getNextPageParam: (lastPage) => lastPage.nextId,
178 })
179β
180 const query = createInfiniteQuery(() => commentsOptions(postId))
181</script>
182β
183{#if query.isPending}
184 Loading...
185{:else if query.isError}
186 <span>Error: {query.error.message}</span>
187{:else}
188 <ul>
189 {#each query.data.pages as page}
190 {#each page.comments as comment (comment.id)}
191 <li>{comment.text}</li>
192 {/each}
193 {/each}
194 </ul>
195{/if}
196```
197β
198<a id="parameters-summary"></a>
199β
200## Parameters
201β
202### options
203β
204[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
205β
206The [UndefinedInitialDataInfiniteOptions](../type-aliases/UndefinedInitialDataInfiniteOptions.md) to use β everything you can pass to
207`createInfiniteQuery`.
208β
209<a id="options-properties"></a>
210β
211#### `options` properties
212β
213Built from [`InfiniteQueryObserverOptions`](../interfaces/InfiniteQueryObserverOptions.md#properties). See the type above for what it changes.
214β
215<a id="returns-summary"></a>
216β
217## Returns
218β
219[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`\>, `TError`\>
220β
221The same options object, typed so that `queryKey` carries the inferred data type.
222β
223<a id="result-properties"></a>
224β
225### Result properties
226β
227Built from [`InfiniteQueryObserverOptions`](../interfaces/InfiniteQueryObserverOptions.md#properties), [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md#properties). See the type above for what it changes.