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

queryOptions.md

202 lines4.5 KB

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.