Open History to see the last commit
1---
2id: queryOptions
3title: queryOptions
4---
5β
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7β
8## Overview
9β
10```ts
11function queryOptions<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object;
12function queryOptions<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>): UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & object;
13function queryOptions<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object;
14```
15β
16- [`DefinedInitialDataOptions` β `DefinedInitialDataOptions & { queryKey }`](#call-signature-1): Brands query options so the `queryKey` carries the query function data and error types across TanStack Query APIs.
17- [`UnusedSkipTokenOptions` β `UnusedSkipTokenOptions & { queryKey }`](#call-signature-2): Brands query options so the `queryKey` carries the query function data and error types across TanStack Query APIs.
18- [`UndefinedInitialDataOptions` β `UndefinedInitialDataOptions & { queryKey }`](#call-signature-3): Brands query options so the `queryKey` carries the query function data and error types across TanStack Query APIs.
19β
20See also: [Parameters](#parameters-summary) Β· [Returns](#returns-summary)
21β
22<a id="call-signature-1"></a>
23β
24## Call Signature
25β
26```ts
27function queryOptions<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object;
28```
29β
30Defined in: [packages/lit-query/src/queryOptions.ts:92](https://github.com/TanStack/query/blob/main/packages/lit-query/src/queryOptions.ts#L92)
31β
32Brands query options so the `queryKey` carries the query function data and
33error types across TanStack Query APIs.
34β
35### Type Parameters
36β
37#### TQueryFnData
38β
39`TQueryFnData` = `unknown`
40β
41#### TError
42β
43`TError` = `Error`
44β
45#### TData
46β
47`TData` = `TQueryFnData`
48β
49#### TQueryKey
50β
51`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
52β
53### Parameters
54β
55#### options
56β
57[`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
58β
59Query options to preserve and brand.
60β
61### Returns
62β
63[`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object`
64β
65The same options object with a typed `queryKey`.
66β
67### Example
68β
69```ts
70import { queryOptions } from '@tanstack/lit-query'
71β
72const todosOptions = queryOptions({
73 queryKey: ['todos'],
74 queryFn: fetchTodos,
75 initialData: [],
76})
77```
78β
79<a id="call-signature-2"></a>
80β
81## Call Signature
82β
83```ts
84function queryOptions<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>): UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & object;
85```
86β
87Defined in: [packages/lit-query/src/queryOptions.ts:109](https://github.com/TanStack/query/blob/main/packages/lit-query/src/queryOptions.ts#L109)
88β
89Brands query options so the `queryKey` carries the query function data and
90error types across TanStack Query APIs.
91β
92### Type Parameters
93β
94#### TQueryFnData
95β
96`TQueryFnData` = `unknown`
97β
98#### TError
99β
100`TError` = `Error`
101β
102#### TData
103β
104`TData` = `TQueryFnData`
105β
106#### TQueryKey
107β
108`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
109β
110### Parameters
111β
112#### options
113β
114[`UnusedSkipTokenOptions`](../type-aliases/UnusedSkipTokenOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
115β
116Query options to preserve and brand.
117β
118### Returns
119β
120[`UnusedSkipTokenOptions`](../type-aliases/UnusedSkipTokenOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object`
121β
122The same options object with a typed `queryKey`.
123β
124<a id="call-signature-3"></a>
125β
126## Call Signature
127β
128```ts
129function queryOptions<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object;
130```
131β
132Defined in: [packages/lit-query/src/queryOptions.ts:126](https://github.com/TanStack/query/blob/main/packages/lit-query/src/queryOptions.ts#L126)
133β
134Brands query options so the `queryKey` carries the query function data and
135error types across TanStack Query APIs.
136β
137### Type Parameters
138β
139#### TQueryFnData
140β
141`TQueryFnData` = `unknown`
142β
143#### TError
144β
145`TError` = `Error`
146β
147#### TData
148β
149`TData` = `TQueryFnData`
150β
151#### TQueryKey
152β
153`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
154β
155### Parameters
156β
157#### options
158β
159[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
160β
161Query options to preserve and brand.
162β
163### Returns
164β
165[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object`
166β
167The same options object with a typed `queryKey`.
168β
169<a id="parameters-summary"></a>
170β
171## Parameters
172β
173### options
174β
175[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
176β
177Query options to preserve and brand.
178β
179<a id="options-properties"></a>
180β
181#### `options` properties
182β
183Built from [`QueryObserverOptions`](../interfaces/QueryObserverOptions.md#properties). See the type above for what it changes.
184β
185<a id="returns-summary"></a>
186β
187## Returns
188β
189[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object`
190β
191The same options object with a typed `queryKey`.
192β
193<a id="result-properties"></a>
194β
195### Result properties
196β
197Built from [`QueryObserverOptions`](../interfaces/QueryObserverOptions.md#properties). See the type above for what it changes.