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