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

infiniteQueryOptions.md

189 lines8.1 KB

1---
2id: infiniteQueryOptions
3title: infiniteQueryOptions
4redirect_from:
5 - framework/vue/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: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UndefinedInitialDataInfiniteOptions<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: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
15```
16​
17- [`UndefinedInitialDataInfiniteOptions` β†’ `UndefinedInitialDataInfiniteOptions & 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- [`DefinedInitialDataInfiniteOptions` β†’ `DefinedInitialDataInfiniteOptions & 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: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData>, TError>;
28```
29​
30Defined in: [packages/vue-query/src/infiniteQueryOptions.ts:95](https://github.com/TanStack/query/blob/main/packages/vue-query/src/infiniteQueryOptions.ts#L95)
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​
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[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
63​
64The [UndefinedInitialDataInfiniteOptions](../type-aliases/UndefinedInitialDataInfiniteOptions.md) to use β€” everything you can pass to
65`useInfiniteQuery`.
66​
67### Returns
68​
69[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.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[useInfiniteQuery](useInfiniteQuery.md) to run an infinite query with these options.
76​
77### Example
78​
79```vue
80<script setup lang="ts">
81import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/vue-query'
82​
83const projectsOptions = infiniteQueryOptions({
84 queryKey: ['projects'],
85 queryFn: ({ pageParam }) => fetchProjects(pageParam),
86 initialPageParam: 0,
87 getNextPageParam: (lastPage) => lastPage.nextId,
88})
89​
90const { data, isError, error, fetchNextPage } = useInfiniteQuery(projectsOptions)
91</script>
92```
93​
94<a id="call-signature-2"></a>
95​
96## Call Signature
97​
98```ts
99function 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>;
100```
101​
102Defined in: [packages/vue-query/src/infiniteQueryOptions.ts:148](https://github.com/TanStack/query/blob/main/packages/vue-query/src/infiniteQueryOptions.ts#L148)
103​
104You can generally pass everything to `infiniteQueryOptions` that you can also pass to `useInfiniteQuery`.
105These options can be shared across hooks and imperative APIs such as `queryClient.infiniteQuery`.
106`options.queryKey` is required and is the query key to generate options for.
107​
108This overload is selected when `initialData` is set, so the resulting `data` is never `undefined` (unless
109a `select` changes `TData` to include `undefined`).
110​
111### Type Parameters
112​
113#### TQueryFnData
114​
115`TQueryFnData`
116​
117#### TError
118​
119`TError` = `Error`
120​
121#### TData
122​
123`TData` = [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>
124​
125#### TQueryKey
126​
127`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
128​
129#### TPageParam
130​
131`TPageParam` = `unknown`
132​
133### Parameters
134​
135#### options
136​
137[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
138​
139The [DefinedInitialDataInfiniteOptions](../type-aliases/DefinedInitialDataInfiniteOptions.md) to use β€” everything you can pass to
140`useInfiniteQuery`, with `initialData` set.
141​
142### Returns
143​
144[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`\>, `TError`\>
145​
146The same options object, typed so that `queryKey` carries the inferred data type.
147​
148### See
149​
150[useInfiniteQuery](useInfiniteQuery.md) to run an infinite query with these options.
151​
152### Example
153​
154```vue
155<script setup lang="ts">
156import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/vue-query'
157​
158const projectsOptions = infiniteQueryOptions({
159 queryKey: ['projects'],
160 queryFn: ({ pageParam }) => fetchProjects(pageParam),
161 initialPageParam: 0,
162 getNextPageParam: (lastPage) => lastPage.nextId,
163 initialData: { pages: [], pageParams: [] },
164})
165​
166// `data` is never `undefined`, thanks to `initialData` β€” even if a refetch fails, so the
167// list stays visible alongside the error.
168const { data, isError, error } = useInfiniteQuery(projectsOptions)
169</script>
170```
171​
172<a id="parameters-summary"></a>
173​
174## Parameters
175​
176### options
177​
178[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
179​
180The [DefinedInitialDataInfiniteOptions](../type-aliases/DefinedInitialDataInfiniteOptions.md) to use β€” everything you can pass to
181`useInfiniteQuery`, with `initialData` set.
182​
183<a id="returns-summary"></a>
184​
185## Returns
186​
187[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`\>, `TError`\>
188​
189The same options object, typed so that `queryKey` carries the inferred data type.