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

queryOptions.md

132 lines3.0 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
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)