Open History to see the last commit
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`.