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

infiniteQueryOptions.md

227 lines9.2 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: 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.