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

queryoptions.md

144 lines3.3 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`](../type-aliases/undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
69​
70The query options to tag with the type from `queryFn`.
71​
72### Returns
73​
74[`UndefinedInitialDataOptions`](../type-aliases/undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object`
75​
76The tagged query options.
77​
78The tagged query options.
79​
80### Param
81​
82The query options to tag with the type from `queryFn`.
83​
84### Defined in
85​
86[query-options.ts:52](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/query-options.ts#L52)
87​
88## queryOptions(options)
89​
90```ts
91function queryOptions<TQueryFnData, TError, TData, TQueryKey>(
92 options,
93): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
94```
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
103const { queryKey } = queryOptions({
104 queryKey: ['key'],
105 queryFn: () => Promise.resolve(5),
106 // ^? Promise<number>
107})
108​
109const queryClient = new QueryClient()
110const data = queryClient.getQueryData(queryKey)
111// ^? number | undefined
112```
113​
114### Type Parameters
115​
116β€’ **TQueryFnData** = `unknown`
117​
118β€’ **TError** = `Error`
119​
120β€’ **TData** = `TQueryFnData`
121​
122β€’ **TQueryKey** _extends_ `QueryKey` = `QueryKey`
123​
124### Parameters
125​
126β€’ **options**: [`DefinedInitialDataOptions`](../type-aliases/definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
127​
128The query options to tag with the type from `queryFn`.
129​
130### Returns
131​
132[`DefinedInitialDataOptions`](../type-aliases/definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object`
133​
134The tagged query options.
135​
136The tagged query options.
137​
138### Param
139​
140The query options to tag with the type from `queryFn`.
141​
142### Defined in
143​
144[query-options.ts:85](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/query-options.ts#L85)