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

queryOptions.md

114 lines2.6 KB

1---
2id: queryOptions
3title: queryOptions
4---
5​
6# Function: queryOptions()
7​
8## Call Signature
9​
10```ts
11function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options): Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn"> & object & object;
12```
13​
14Defined in: [preact-query/src/queryOptions.ts:52](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/queryOptions.ts#L52)
15​
16### Type Parameters
17​
18#### TQueryFnData
19​
20`TQueryFnData` = `unknown`
21​
22#### TError
23​
24`TError` = `Error`
25​
26#### TData
27​
28`TData` = `TQueryFnData`
29​
30#### TQueryKey
31​
32`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
33​
34### Parameters
35​
36#### options
37​
38[`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
39​
40### Returns
41​
42`Omit`\<[`UseQueryOptions`](../interfaces/UseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>, `"queryFn"`\> & `object` & `object`
43​
44## Call Signature
45​
46```ts
47function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options): OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn"> & object & object;
48```
49​
50Defined in: [preact-query/src/queryOptions.ts:63](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/queryOptions.ts#L63)
51​
52### Type Parameters
53​
54#### TQueryFnData
55​
56`TQueryFnData` = `unknown`
57​
58#### TError
59​
60`TError` = `Error`
61​
62#### TData
63​
64`TData` = `TQueryFnData`
65​
66#### TQueryKey
67​
68`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
69​
70### Parameters
71​
72#### options
73​
74[`UnusedSkipTokenOptions`](../type-aliases/UnusedSkipTokenOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
75​
76### Returns
77​
78`OmitKeyof`\<[`UseQueryOptions`](../interfaces/UseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>, `"queryFn"`\> & `object` & `object`
79​
80## Call Signature
81​
82```ts
83function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options): UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & object & object;
84```
85​
86Defined in: [preact-query/src/queryOptions.ts:74](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/queryOptions.ts#L74)
87​
88### Type Parameters
89​
90#### TQueryFnData
91​
92`TQueryFnData` = `unknown`
93​
94#### TError
95​
96`TError` = `Error`
97​
98#### TData
99​
100`TData` = `TQueryFnData`
101​
102#### TQueryKey
103​
104`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
105​
106### Parameters
107​
108#### options
109​
110[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
111​
112### Returns
113​
114[`UseQueryOptions`](../interfaces/UseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` & `object`