Open History to see the last commit
1---
2id: infiniteQueryOptions
3title: infiniteQueryOptions
4redirect_from:
5 - framework/solid/reference/infiniteQueryOptions
6---
7β
8<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
9β
10## Overview
11β
12```ts
13function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object): ReturnType<DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
14function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object): ReturnType<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
15```
16β
17- [`ReturnType<DefinedInitialDataInfiniteOptions>` β `ReturnType<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.
18- [`ReturnType<UndefinedInitialDataInfiniteOptions>` β `ReturnType<UndefinedInitialDataInfiniteOptions> & 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.
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: InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object): ReturnType<DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
28```
29β
30Defined in: [packages/solid-query/src/infiniteQueryOptions.ts:101](https://github.com/TanStack/query/blob/main/packages/solid-query/src/infiniteQueryOptions.ts#L101)
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 set.
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[`InfiniteQueryOptions`](../interfaces/InfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
65β
66The [DefinedInitialDataInfiniteOptions](../type-aliases/DefinedInitialDataInfiniteOptions.md) to use β everything you can pass to `useInfiniteQuery`, with `initialData` set.
67β
68### Returns
69β
70`ReturnType`\<[`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### See
75β
76[useInfiniteQuery](useInfiniteQuery.md) to run an infinite query with these options.
77β
78### Example
79β
80```tsx
81import { For } from 'solid-js'
82import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/solid-query'
83β
84const projectsOptions = infiniteQueryOptions({
85 queryKey: ['projects'],
86 queryFn: ({ pageParam }) => fetchProjects(pageParam),
87 initialPageParam: 0,
88 getNextPageParam: (lastPage) => lastPage.nextId,
89 initialData: { pages: [], pageParams: [] },
90})
91β
92function Projects() {
93 // `projectsQuery.data` is never `undefined`, thanks to `initialData` β even if a refetch fails, so the
94 // list stays visible alongside the error.
95 const projectsQuery = useInfiniteQuery(() => projectsOptions)
96β
97 return (
98 <div>
99 {projectsQuery.isError ? <span>Error: {projectsQuery.error.message}</span> : null}
100 <ul>
101 <For each={projectsQuery.data.pages}>
102 {(page) => <For each={page.projects}>{(p) => <li>{p.name}</li>}</For>}
103 </For>
104 </ul>
105 </div>
106 )
107}
108```
109β
110<a id="call-signature-2"></a>
111β
112## Call Signature
113β
114```ts
115function infiniteQueryOptions<TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends readonly unknown[] = readonly unknown[], TPageParam = unknown>(options: InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object): ReturnType<UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
116```
117β
118Defined in: [packages/solid-query/src/infiniteQueryOptions.ts:168](https://github.com/TanStack/query/blob/main/packages/solid-query/src/infiniteQueryOptions.ts#L168)
119β
120You can generally pass everything to `infiniteQueryOptions` that you can also pass to `useInfiniteQuery`.
121These options can be shared across hooks and imperative APIs such as `queryClient.infiniteQuery`.
122`options.queryKey` is required and is the query key to generate options for.
123β
124### Type Parameters
125β
126#### TQueryFnData
127β
128`TQueryFnData`
129β
130#### TError
131β
132`TError` = `Error`
133β
134#### TData
135β
136`TData` = [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>
137β
138#### TQueryKey
139β
140`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
141β
142#### TPageParam
143β
144`TPageParam` = `unknown`
145β
146### Parameters
147β
148#### options
149β
150[`InfiniteQueryOptions`](../interfaces/InfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
151β
152The [UndefinedInitialDataInfiniteOptions](../type-aliases/UndefinedInitialDataInfiniteOptions.md) to use β everything you can pass to `useInfiniteQuery`.
153β
154### Returns
155β
156`ReturnType`\<[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`\>, `TError`\>
157β
158The same options object, typed so that `queryKey` carries the inferred data type.
159β
160### See
161β
162[useInfiniteQuery](useInfiniteQuery.md) to run an infinite query with these options.
163β
164### Example
165β
166A parameterized factory, so the same options object can be reused per `postId`:
167```tsx
168import { For, Match, Switch } from 'solid-js'
169import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/solid-query'
170β
171const commentsOptions = (postId: string) =>
172 infiniteQueryOptions({
173 queryKey: ['post', postId, 'comments'],
174 queryFn: ({ pageParam }) => fetchComments(postId, pageParam),
175 initialPageParam: 0,
176 getNextPageParam: (lastPage) => lastPage.nextId,
177 })
178β
179function Comments(props: { postId: string }) {
180 const commentsQuery = useInfiniteQuery(() => commentsOptions(props.postId))
181β
182 return (
183 <Switch>
184 <Match when={commentsQuery.isPending}>Loading...</Match>
185 <Match when={commentsQuery.isError}>Error: {commentsQuery.error.message}</Match>
186 <Match when={commentsQuery.isSuccess}>
187 <ul>
188 <For each={commentsQuery.data.pages}>
189 {(page) => <For each={page.comments}>{(c) => <li>{c.text}</li>}</For>}
190 </For>
191 </ul>
192 </Match>
193 </Switch>
194 )
195}
196```
197β
198<a id="parameters-summary"></a>
199β
200## Parameters
201β
202### options
203β
204[`InfiniteQueryOptions`](../interfaces/InfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
205β
206The [UndefinedInitialDataInfiniteOptions](../type-aliases/UndefinedInitialDataInfiniteOptions.md) to use β everything you can pass to `useInfiniteQuery`.
207β
208<a id="options-properties"></a>
209β
210#### `options` properties
211β
212Built from [`InfiniteQueryOptions`](../interfaces/InfiniteQueryOptions.md#properties). See the type above for what it changes.
213β
214<a id="returns-summary"></a>
215β
216## Returns
217β
218`ReturnType`\<[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`\>, `TError`\>
219β
220The same options object, typed so that `queryKey` carries the inferred data type.
221β
222<a id="result-properties"></a>
223β
224### Result properties
225β
226Built from [`InfiniteQueryOptions`](../interfaces/InfiniteQueryOptions.md#properties), [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md#properties). See the type above for what it changes.