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

infiniteQueryOptions.md

126 lines3.1 KB

1---
2id: infiniteQueryOptions
3title: infiniteQueryOptions
4---
5​
6# Function: infiniteQueryOptions()
7​
8## Call Signature
9​
10```ts
11function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & object;
12```
13​
14Defined in: [preact-query/src/infiniteQueryOptions.ts:75](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/infiniteQueryOptions.ts#L75)
15​
16### Type Parameters
17​
18#### TQueryFnData
19​
20`TQueryFnData`
21​
22#### TError
23​
24`TError` = `Error`
25​
26#### TData
27​
28`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\>
29​
30#### TQueryKey
31​
32`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
33​
34#### TPageParam
35​
36`TPageParam` = `unknown`
37​
38### Parameters
39​
40#### options
41​
42[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
43​
44### Returns
45​
46[`UseInfiniteQueryOptions`](../interfaces/UseInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & `object`
47​
48## Call Signature
49​
50```ts
51function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, "queryFn"> & object & object;
52```
53​
54Defined in: [preact-query/src/infiniteQueryOptions.ts:99](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/infiniteQueryOptions.ts#L99)
55​
56### Type Parameters
57​
58#### TQueryFnData
59​
60`TQueryFnData`
61​
62#### TError
63​
64`TError` = `Error`
65​
66#### TData
67​
68`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\>
69​
70#### TQueryKey
71​
72`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
73​
74#### TPageParam
75​
76`TPageParam` = `unknown`
77​
78### Parameters
79​
80#### options
81​
82[`UnusedSkipTokenInfiniteOptions`](../type-aliases/UnusedSkipTokenInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
83​
84### Returns
85​
86`OmitKeyof`\<[`UseInfiniteQueryOptions`](../interfaces/UseInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>, `"queryFn"`\> & `object` & `object`
87​
88## Call Signature
89​
90```ts
91function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & object;
92```
93​
94Defined in: [preact-query/src/infiniteQueryOptions.ts:123](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/infiniteQueryOptions.ts#L123)
95​
96### Type Parameters
97​
98#### TQueryFnData
99​
100`TQueryFnData`
101​
102#### TError
103​
104`TError` = `Error`
105​
106#### TData
107​
108`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\>
109​
110#### TQueryKey
111​
112`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
113​
114#### TPageParam
115​
116`TPageParam` = `unknown`
117​
118### Parameters
119​
120#### options
121​
122[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
123​
124### Returns
125​
126[`UseInfiniteQueryOptions`](../interfaces/UseInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & `object`