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

injectInfiniteQuery.md

176 lines4.4 KB

1---
2id: injectInfiniteQuery
3title: injectInfiniteQuery
4---
5​
6# Function: injectInfiniteQuery()
7​
8Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
9Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
10​
11## Param
12​
13A function that returns infinite query options.
14​
15## Param
16​
17Additional configuration.
18​
19## Call Signature
20​
21```ts
22function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): DefinedCreateInfiniteQueryResult<TData, TError>;
23```
24​
25Defined in: [inject-infinite-query.ts:41](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L41)
26​
27Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
28Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
29​
30### Type Parameters
31​
32#### TQueryFnData
33​
34`TQueryFnData`
35​
36#### TError
37​
38`TError` = `Error`
39​
40#### TData
41​
42`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\>
43​
44#### TQueryKey
45​
46`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
47​
48#### TPageParam
49​
50`TPageParam` = `unknown`
51​
52### Parameters
53​
54#### injectInfiniteQueryFn
55​
56() => [`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
57​
58A function that returns infinite query options.
59​
60#### options?
61​
62[`InjectInfiniteQueryOptions`](../interfaces/InjectInfiniteQueryOptions.md)
63​
64Additional configuration.
65​
66### Returns
67​
68[`DefinedCreateInfiniteQueryResult`](../type-aliases/DefinedCreateInfiniteQueryResult.md)\<`TData`, `TError`\>
69​
70The infinite query result.
71​
72## Call Signature
73​
74```ts
75function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>;
76```
77​
78Defined in: [inject-infinite-query.ts:65](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L65)
79​
80Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
81Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
82​
83### Type Parameters
84​
85#### TQueryFnData
86​
87`TQueryFnData`
88​
89#### TError
90​
91`TError` = `Error`
92​
93#### TData
94​
95`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\>
96​
97#### TQueryKey
98​
99`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
100​
101#### TPageParam
102​
103`TPageParam` = `unknown`
104​
105### Parameters
106​
107#### injectInfiniteQueryFn
108​
109() => [`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
110​
111A function that returns infinite query options.
112​
113#### options?
114​
115[`InjectInfiniteQueryOptions`](../interfaces/InjectInfiniteQueryOptions.md)
116​
117Additional configuration.
118​
119### Returns
120​
121[`CreateInfiniteQueryResult`](../type-aliases/CreateInfiniteQueryResult.md)\<`TData`, `TError`\>
122​
123The infinite query result.
124​
125## Call Signature
126​
127```ts
128function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>;
129```
130​
131Defined in: [inject-infinite-query.ts:89](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L89)
132​
133Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
134Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
135​
136### Type Parameters
137​
138#### TQueryFnData
139​
140`TQueryFnData`
141​
142#### TError
143​
144`TError` = `Error`
145​
146#### TData
147​
148`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\>
149​
150#### TQueryKey
151​
152`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
153​
154#### TPageParam
155​
156`TPageParam` = `unknown`
157​
158### Parameters
159​
160#### injectInfiniteQueryFn
161​
162() => [`CreateInfiniteQueryOptions`](../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
163​
164A function that returns infinite query options.
165​
166#### options?
167​
168[`InjectInfiniteQueryOptions`](../interfaces/InjectInfiniteQueryOptions.md)
169​
170Additional configuration.
171​
172### Returns
173​
174[`CreateInfiniteQueryResult`](../type-aliases/CreateInfiniteQueryResult.md)\<`TData`, `TError`\>
175​
176The infinite query result.