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

queryOptions.md

197 lines6.3 KB

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.