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

useInfiniteQuery.md

138 lines2.8 KB

1---
2id: useInfiniteQuery
3title: useInfiniteQuery
4---
5​
6# Function: useInfiniteQuery()
7​
8## Call Signature
9​
10```ts
11function useInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options, queryClient?): DefinedUseInfiniteQueryResult<TData, TError>;
12```
13​
14Defined in: [preact-query/src/useInfiniteQuery.ts:20](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/useInfiniteQuery.ts#L20)
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#### queryClient?
45​
46`QueryClient`
47​
48### Returns
49​
50[`DefinedUseInfiniteQueryResult`](../type-aliases/DefinedUseInfiniteQueryResult.md)\<`TData`, `TError`\>
51​
52## Call Signature
53​
54```ts
55function useInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options, queryClient?): UseInfiniteQueryResult<TData, TError>;
56```
57​
58Defined in: [preact-query/src/useInfiniteQuery.ts:37](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/useInfiniteQuery.ts#L37)
59​
60### Type Parameters
61​
62#### TQueryFnData
63​
64`TQueryFnData`
65​
66#### TError
67​
68`TError` = `Error`
69​
70#### TData
71​
72`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\>
73​
74#### TQueryKey
75​
76`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
77​
78#### TPageParam
79​
80`TPageParam` = `unknown`
81​
82### Parameters
83​
84#### options
85​
86[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
87​
88#### queryClient?
89​
90`QueryClient`
91​
92### Returns
93​
94[`UseInfiniteQueryResult`](../type-aliases/UseInfiniteQueryResult.md)\<`TData`, `TError`\>
95​
96## Call Signature
97​
98```ts
99function useInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options, queryClient?): UseInfiniteQueryResult<TData, TError>;
100```
101​
102Defined in: [preact-query/src/useInfiniteQuery.ts:54](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/useInfiniteQuery.ts#L54)
103​
104### Type Parameters
105​
106#### TQueryFnData
107​
108`TQueryFnData`
109​
110#### TError
111​
112`TError` = `Error`
113​
114#### TData
115​
116`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\>
117​
118#### TQueryKey
119​
120`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
121​
122#### TPageParam
123​
124`TPageParam` = `unknown`
125​
126### Parameters
127​
128#### options
129​
130[`UseInfiniteQueryOptions`](../interfaces/UseInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
131​
132#### queryClient?
133​
134`QueryClient`
135​
136### Returns
137​
138[`UseInfiniteQueryResult`](../type-aliases/UseInfiniteQueryResult.md)\<`TData`, `TError`\>