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

infiniteQueryOptions.md

120 lines2.7 KB

1---
2id: infiniteQueryOptions
3title: infiniteQueryOptions
4---
5​
6# Function: infiniteQueryOptions()
7​
8Allows to share and re-use infinite query options in a type-safe way.
9​
10The `queryKey` will be tagged with the type from `queryFn`.
11​
12## Param
13​
14The infinite query options to tag with the type from `queryFn`.
15​
16## infiniteQueryOptions(options)
17​
18```ts
19function infiniteQueryOptions<
20 TQueryFnData,
21 TError,
22 TData,
23 TQueryKey,
24 TPageParam,
25>(
26 options,
27): UndefinedInitialDataInfiniteOptions<
28 TQueryFnData,
29 TError,
30 TData,
31 TQueryKey,
32 TPageParam
33> &
34 object
35```
36​
37Allows to share and re-use infinite query options in a type-safe way.
38​
39The `queryKey` will be tagged with the type from `queryFn`.
40​
41### Type Parameters
42​
43β€’ **TQueryFnData**
44​
45β€’ **TError** = `Error`
46​
47β€’ **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
48​
49β€’ **TQueryKey** _extends_ `QueryKey` = `QueryKey`
50​
51β€’ **TPageParam** = `unknown`
52​
53### Parameters
54​
55β€’ **options**: [`UndefinedInitialDataInfiniteOptions`](UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
56​
57The infinite query options to tag with the type from `queryFn`.
58​
59### Returns
60​
61[`UndefinedInitialDataInfiniteOptions`](UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
62​
63The tagged infinite query options.
64​
65### Defined in
66​
67[infinite-query-options.ts:59](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/infinite-query-options.ts#L59)
68​
69## infiniteQueryOptions(options)
70​
71```ts
72function infiniteQueryOptions<
73 TQueryFnData,
74 TError,
75 TData,
76 TQueryKey,
77 TPageParam,
78>(
79 options,
80): DefinedInitialDataInfiniteOptions<
81 TQueryFnData,
82 TError,
83 TData,
84 TQueryKey,
85 TPageParam
86> &
87 object
88```
89​
90Allows to share and re-use infinite query options in a type-safe way.
91​
92The `queryKey` will be tagged with the type from `queryFn`.
93​
94### Type Parameters
95​
96β€’ **TQueryFnData**
97​
98β€’ **TError** = `Error`
99​
100β€’ **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
101​
102β€’ **TQueryKey** _extends_ `QueryKey` = `QueryKey`
103​
104β€’ **TPageParam** = `unknown`
105​
106### Parameters
107​
108β€’ **options**: [`DefinedInitialDataInfiniteOptions`](DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
109​
110The infinite query options to tag with the type from `queryFn`.
111​
112### Returns
113​
114[`DefinedInitialDataInfiniteOptions`](DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
115​
116The tagged infinite query options.
117​
118### Defined in
119​
120[infinite-query-options.ts:91](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/infinite-query-options.ts#L91)