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
15const { queryKey } = queryOptions({
16 queryKey: ['key'],
17 queryFn: () => Promise.resolve(5),
18 // ^? Promise<number>
19})
20β
21const queryClient = new QueryClient()
22const data = queryClient.getQueryData(queryKey)
23// ^? number | undefined
24```
25β
26## Param
27β
28The query options to tag with the type from `queryFn`.
29β
30## queryOptions(options)
31β
32```ts
33function queryOptions<TQueryFnData, TError, TData, TQueryKey>(
34 options,
35): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
36```
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
45const { queryKey } = queryOptions({
46 queryKey: ['key'],
47 queryFn: () => Promise.resolve(5),
48 // ^? Promise<number>
49})
50β
51const queryClient = new QueryClient()
52const data = queryClient.getQueryData(queryKey)
53// ^? number | undefined
54```
55β
56### Type Parameters
57β
58β’ **TQueryFnData** = `unknown`
59β
60β’ **TError** = `Error`
61β
62β’ **TData** = `TQueryFnData`
63β
64β’ **TQueryKey** _extends_ `QueryKey` = `QueryKey`
65β
66### Parameters
67β
68β’ **options**: [`UndefinedInitialDataOptions`](UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
69β
70The query options to tag with the type from `queryFn`.
71β
72### Returns
73β
74[`UndefinedInitialDataOptions`](UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object`
75β
76The tagged query options.
77β
78### Defined in
79β
80[query-options.ts:52](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/query-options.ts#L52)
81β
82## queryOptions(options)
83β
84```ts
85function queryOptions<TQueryFnData, TError, TData, TQueryKey>(
86 options,
87): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
88```
89β
90Allows to share and re-use query options in a type-safe way.
91β
92The `queryKey` will be tagged with the type from `queryFn`.
93β
94**Example**
95β
96```ts
97const { queryKey } = queryOptions({
98 queryKey: ['key'],
99 queryFn: () => Promise.resolve(5),
100 // ^? Promise<number>
101})
102β
103const queryClient = new QueryClient()
104const data = queryClient.getQueryData(queryKey)
105// ^? number | undefined
106```
107β
108### Type Parameters
109β
110β’ **TQueryFnData** = `unknown`
111β
112β’ **TError** = `Error`
113β
114β’ **TData** = `TQueryFnData`
115β
116β’ **TQueryKey** _extends_ `QueryKey` = `QueryKey`
117β
118### Parameters
119β
120β’ **options**: [`DefinedInitialDataOptions`](DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
121β
122The query options to tag with the type from `queryFn`.
123β
124### Returns
125β
126[`DefinedInitialDataOptions`](DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object`
127β
128The tagged query options.
129β
130### Defined in
131β
132[query-options.ts:85](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/query-options.ts#L85)