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

infiniteQueryOptions.md

158 lines4.0 KB

1---
2id: infiniteQueryOptions
3title: infiniteQueryOptions
4---
5​
6# Function: infiniteQueryOptions()
7​
8Allows to share and re-use infinite query options in a type-safe way.
9​
10The `queryKey` will be tagged with the type from `queryFn`.
11​
12## Param
13​
14The infinite query options to tag with the type from `queryFn`.
15​
16## Call Signature
17​
18```ts
19function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & object;
20```
21​
22Defined in: [infinite-query-options.ts:88](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L88)
23​
24Allows to share and re-use infinite query options in a type-safe way.
25​
26The `queryKey` will be tagged with the type from `queryFn`.
27​
28### Type Parameters
29​
30#### TQueryFnData
31​
32`TQueryFnData`
33​
34#### TError
35​
36`TError` = `Error`
37​
38#### TData
39​
40`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\>
41​
42#### TQueryKey
43​
44`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
45​
46#### TPageParam
47​
48`TPageParam` = `unknown`
49​
50### Parameters
51​
52#### options
53​
54[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
55​
56The infinite query options to tag with the type from `queryFn`.
57​
58### Returns
59​
60[`CreateInfiniteQueryOptions`](../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & `object`
61​
62The tagged infinite query options.
63​
64## Call Signature
65​
66```ts
67function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): OmitKeyof<CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, "queryFn"> & object & object;
68```
69​
70Defined in: [infinite-query-options.ts:119](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L119)
71​
72Allows to share and re-use infinite query options in a type-safe way.
73​
74The `queryKey` will be tagged with the type from `queryFn`.
75​
76### Type Parameters
77​
78#### TQueryFnData
79​
80`TQueryFnData`
81​
82#### TError
83​
84`TError` = `Error`
85​
86#### TData
87​
88`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\>
89​
90#### TQueryKey
91​
92`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
93​
94#### TPageParam
95​
96`TPageParam` = `unknown`
97​
98### Parameters
99​
100#### options
101​
102[`UnusedSkipTokenInfiniteOptions`](../type-aliases/UnusedSkipTokenInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
103​
104The infinite query options to tag with the type from `queryFn`.
105​
106### Returns
107​
108`OmitKeyof`\<[`CreateInfiniteQueryOptions`](../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>, `"queryFn"`\> & `object` & `object`
109​
110The tagged infinite query options.
111​
112## Call Signature
113​
114```ts
115function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & object;
116```
117​
118Defined in: [infinite-query-options.ts:150](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L150)
119​
120Allows to share and re-use infinite query options in a type-safe way.
121​
122The `queryKey` will be tagged with the type from `queryFn`.
123​
124### Type Parameters
125​
126#### TQueryFnData
127​
128`TQueryFnData`
129​
130#### TError
131​
132`TError` = `Error`
133​
134#### TData
135​
136`TData` = `InfiniteData`\<`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[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
151​
152The infinite query options to tag with the type from `queryFn`.
153​
154### Returns
155​
156[`CreateInfiniteQueryOptions`](../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & `object`
157​
158The tagged infinite query options.