Open History to see the last commit
1---
2id: queryOptions
3title: queryOptions
4---
5β
6# Function: queryOptions()
7β
8Allows to share and re-use query options in a type-safe way.
9β
10The `queryKey` will be tagged with the type from `queryFn`.
11β
12**Example**
13β
14```ts
15 const { queryKey } = queryOptions({
16 queryKey: ['key'],
17 queryFn: () => Promise.resolve(5),
18 // ^? Promise<number>
19 })
20β
21 const queryClient = new QueryClient()
22 const data = queryClient.getQueryData(queryKey)
23 // ^? number | undefined
24```
25β
26## Param
27β
28The query options to tag with the type from `queryFn`.
29β
30## Call Signature
31β
32```ts
33function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options): Omit<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn"> & object & object;
34```
35β
36Defined in: [query-options.ts:76](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L76)
37β
38Allows to share and re-use query options in a type-safe way.
39β
40The `queryKey` will be tagged with the type from `queryFn`.
41β
42**Example**
43β
44```ts
45 const { queryKey } = queryOptions({
46 queryKey: ['key'],
47 queryFn: () => Promise.resolve(5),
48 // ^? Promise<number>
49 })
50β
51 const queryClient = new QueryClient()
52 const data = queryClient.getQueryData(queryKey)
53 // ^? number | undefined
54```
55β
56### Type Parameters
57β
58#### TQueryFnData
59β
60`TQueryFnData` = `unknown`
61β
62#### TError
63β
64`TError` = `Error`
65β
66#### TData
67β
68`TData` = `TQueryFnData`
69β
70#### TQueryKey
71β
72`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
73β
74### Parameters
75β
76#### options
77β
78[`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
79β
80The query options to tag with the type from `queryFn`.
81β
82### Returns
83β
84`Omit`\<[`CreateQueryOptions`](../interfaces/CreateQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>, `"queryFn"`\> & `object` & `object`
85β
86The tagged query options.
87β
88## Call Signature
89β
90```ts
91function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options): OmitKeyof<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn"> & object & object;
92```
93β
94Defined in: [query-options.ts:108](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L108)
95β
96Allows to share and re-use query options in a type-safe way.
97β
98The `queryKey` will be tagged with the type from `queryFn`.
99β
100**Example**
101β
102```ts
103 const { queryKey } = queryOptions({
104 queryKey: ['key'],
105 queryFn: () => Promise.resolve(5),
106 // ^? Promise<number>
107 })
108β
109 const queryClient = new QueryClient()
110 const data = queryClient.getQueryData(queryKey)
111 // ^? number | undefined
112```
113β
114### Type Parameters
115β
116#### TQueryFnData
117β
118`TQueryFnData` = `unknown`
119β
120#### TError
121β
122`TError` = `Error`
123β
124#### TData
125β
126`TData` = `TQueryFnData`
127β
128#### TQueryKey
129β
130`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
131β
132### Parameters
133β
134#### options
135β
136[`UnusedSkipTokenOptions`](../type-aliases/UnusedSkipTokenOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
137β
138The query options to tag with the type from `queryFn`.
139β
140### Returns
141β
142`OmitKeyof`\<[`CreateQueryOptions`](../interfaces/CreateQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>, `"queryFn"`\> & `object` & `object`
143β
144The tagged query options.
145β
146## Call Signature
147β
148```ts
149function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options): CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & object & object;
150```
151β
152Defined in: [query-options.ts:140](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L140)
153β
154Allows to share and re-use query options in a type-safe way.
155β
156The `queryKey` will be tagged with the type from `queryFn`.
157β
158**Example**
159β
160```ts
161 const { queryKey } = queryOptions({
162 queryKey: ['key'],
163 queryFn: () => Promise.resolve(5),
164 // ^? Promise<number>
165 })
166β
167 const queryClient = new QueryClient()
168 const data = queryClient.getQueryData(queryKey)
169 // ^? number | undefined
170```
171β
172### Type Parameters
173β
174#### TQueryFnData
175β
176`TQueryFnData` = `unknown`
177β
178#### TError
179β
180`TError` = `Error`
181β
182#### TData
183β
184`TData` = `TQueryFnData`
185β
186#### TQueryKey
187β
188`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
189β
190### Parameters
191β
192#### options
193β
194[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
195β
196The query options to tag with the type from `queryFn`.
197β
198### Returns
199β
200[`CreateQueryOptions`](../interfaces/CreateQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` & `object`
201β
202The tagged query options.