File size: 4,401 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 |
---
id: infiniteQueryOptions
title: infiniteQueryOptions
---
# Function: infiniteQueryOptions()
Allows to share and re-use infinite query options in a type-safe way.
The `queryKey` will be tagged with the type from `queryFn`.
## Param
The infinite query options to tag with the type from `queryFn`.
## Call Signature
```ts
function infiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(
options,
): DefinedInitialDataInfiniteOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam
> &
object
```
Allows to share and re-use infinite query options in a type-safe way.
The `queryKey` will be tagged with the type from `queryFn`.
### Type Parameters
• **TQueryFnData**
• **TError** = `Error`
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
• **TPageParam** = `unknown`
### Parameters
#### options
[`DefinedInitialDataInfiniteOptions`](../../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
The infinite query options to tag with the type from `queryFn`.
### Returns
[`DefinedInitialDataInfiniteOptions`](../../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
The tagged infinite query options.
The tagged infinite query options.
### Param
The infinite query options to tag with the type from `queryFn`.
### Defined in
[infinite-query-options.ts:94](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L94)
## Call Signature
```ts
function infiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(
options,
): UnusedSkipTokenInfiniteOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam
> &
object
```
Allows to share and re-use infinite query options in a type-safe way.
The `queryKey` will be tagged with the type from `queryFn`.
### Type Parameters
• **TQueryFnData**
• **TError** = `Error`
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
• **TPageParam** = `unknown`
### Parameters
#### options
[`UnusedSkipTokenInfiniteOptions`](../../type-aliases/unusedskiptokeninfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
The infinite query options to tag with the type from `queryFn`.
### Returns
[`UnusedSkipTokenInfiniteOptions`](../../type-aliases/unusedskiptokeninfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
The tagged infinite query options.
The tagged infinite query options.
### Param
The infinite query options to tag with the type from `queryFn`.
### Defined in
[infinite-query-options.ts:126](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L126)
## Call Signature
```ts
function infiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam,
>(
options,
): UndefinedInitialDataInfiniteOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam
> &
object
```
Allows to share and re-use infinite query options in a type-safe way.
The `queryKey` will be tagged with the type from `queryFn`.
### Type Parameters
• **TQueryFnData**
• **TError** = `Error`
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
• **TPageParam** = `unknown`
### Parameters
#### options
[`UndefinedInitialDataInfiniteOptions`](../../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
The infinite query options to tag with the type from `queryFn`.
### Returns
[`UndefinedInitialDataInfiniteOptions`](../../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
The tagged infinite query options.
The tagged infinite query options.
### Param
The infinite query options to tag with the type from `queryFn`.
### Defined in
[infinite-query-options.ts:158](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L158)
|