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

queryOptions.md

147 lines3.5 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<QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, never>, "queryFn"> & object & object;
12```
13​
14Defined in: [packages/lit-query/src/queryOptions.ts:94](https://github.com/TanStack/query/blob/main/packages/lit-query/src/queryOptions.ts#L94)
15​
16Brands query options so the `queryKey` carries the query function data and
17error types across TanStack Query APIs.
18​
19### Type Parameters
20​
21#### TQueryFnData
22​
23`TQueryFnData` = `unknown`
24​
25#### TError
26​
27`TError` = `Error`
28​
29#### TData
30​
31`TData` = `TQueryFnData`
32​
33#### TQueryKey
34​
35`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
36​
37### Parameters
38​
39#### options
40​
41[`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
42​
43Query options to preserve and brand.
44​
45### Returns
46​
47`Omit`\<`QueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `never`\>, `"queryFn"`\> & `object` & `object`
48​
49The same options object with a typed `queryKey`.
50​
51### Example
52​
53```ts
54import { queryOptions } from '@tanstack/lit-query'
55​
56const todosOptions = queryOptions({
57 queryKey: ['todos'],
58 queryFn: fetchTodos,
59 initialData: [],
60})
61```
62​
63## Call Signature
64​
65```ts
66function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options): OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, never>, "queryFn"> & object & object;
67```
68​
69Defined in: [packages/lit-query/src/queryOptions.ts:112](https://github.com/TanStack/query/blob/main/packages/lit-query/src/queryOptions.ts#L112)
70​
71Brands query options so the `queryKey` carries the query function data and
72error types across TanStack Query APIs.
73​
74### Type Parameters
75​
76#### TQueryFnData
77​
78`TQueryFnData` = `unknown`
79​
80#### TError
81​
82`TError` = `Error`
83​
84#### TData
85​
86`TData` = `TQueryFnData`
87​
88#### TQueryKey
89​
90`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
91​
92### Parameters
93​
94#### options
95​
96[`UnusedSkipTokenOptions`](../type-aliases/UnusedSkipTokenOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
97​
98Query options to preserve and brand.
99​
100### Returns
101​
102`OmitKeyof`\<`QueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `never`\>, `"queryFn"`\> & `object` & `object`
103​
104The same options object with a typed `queryKey`.
105​
106## Call Signature
107​
108```ts
109function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options): QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, never> & object & object;
110```
111​
112Defined in: [packages/lit-query/src/queryOptions.ts:130](https://github.com/TanStack/query/blob/main/packages/lit-query/src/queryOptions.ts#L130)
113​
114Brands query options so the `queryKey` carries the query function data and
115error types across TanStack Query APIs.
116​
117### Type Parameters
118​
119#### TQueryFnData
120​
121`TQueryFnData` = `unknown`
122​
123#### TError
124​
125`TError` = `Error`
126​
127#### TData
128​
129`TData` = `TQueryFnData`
130​
131#### TQueryKey
132​
133`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
134​
135### Parameters
136​
137#### options
138​
139[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
140​
141Query options to preserve and brand.
142​
143### Returns
144​
145`QueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `never`\> & `object` & `object`
146​
147The same options object with a typed `queryKey`.