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

queryOptions.md

206 lines7.5 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> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
12function queryOptions<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
13```
14​
15- [`DefinedInitialDataOptions` β†’ `DefinedInitialDataOptions & QueryKeyWithDataTag`](#call-signature-1): You can generally pass everything to `queryOptions` that you can also pass to `createQuery`. These options can be shared across `createQuery` calls and imperative APIs such as `queryClient.query`. `options.queryKey` is required and is the query key to generate options for.
16- [`UndefinedInitialDataOptions` β†’ `UndefinedInitialDataOptions & QueryKeyWithDataTag`](#call-signature-2): You can generally pass everything to `queryOptions` that you can also pass to `createQuery`. These options can be shared across `createQuery` calls and imperative APIs such as `queryClient.query`. `options.queryKey` is required and is the query key to generate options for.
17​
18See also: [Parameters](#parameters-summary) Β· [Returns](#returns-summary)
19​
20<a id="call-signature-1"></a>
21​
22## Call Signature
23​
24```ts
25function queryOptions<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
26```
27​
28Defined in: [packages/svelte-query/src/queryOptions.ts:79](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L79)
29​
30You can generally pass everything to `queryOptions` that you can also pass to `createQuery`. These options
31can be shared across `createQuery` calls and imperative APIs such as `queryClient.query`. `options.queryKey`
32is required and is the query key to generate options for.
33​
34This overload is selected when `initialData` is known to be defined, so the resulting `data` is never
35`undefined` (unless a `select` changes `TData` to include `undefined`).
36​
37### Type Parameters
38​
39#### TQueryFnData
40​
41`TQueryFnData` = `unknown`
42​
43#### TError
44​
45`TError` = `Error`
46​
47#### TData
48​
49`TData` = `TQueryFnData`
50​
51#### TQueryKey
52​
53`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
54​
55### Parameters
56​
57#### options
58​
59[`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
60​
61The [DefinedInitialDataOptions](../type-aliases/DefinedInitialDataOptions.md) to use β€” everything you can pass to `createQuery`,
62with `initialData` known to be defined.
63​
64### Returns
65​
66[`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, `TQueryFnData`, `TError`\>
67​
68The same options object, typed so that `queryKey` carries the inferred data type.
69​
70### See
71​
72[createQuery](createQuery.md) to run a query with these options.
73​
74### Example
75​
76```svelte
77<script lang="ts">
78 import { queryOptions, createQuery } from '@tanstack/svelte-query'
79​
80 const postsOptions = queryOptions({
81 queryKey: ['posts'],
82 queryFn: fetchPosts,
83 initialData: [],
84 })
85​
86 // `data` is `Post[]`, never `undefined`, thanks to `initialData` β€” even if a refetch fails,
87 // so the list stays visible alongside the error.
88 const query = createQuery(() => postsOptions)
89</script>
90​
91{#if query.isError}
92 <span>Error: {query.error.message}</span>
93{/if}
94<ul>
95 {#each query.data as post (post.id)}
96 <li>{post.title}</li>
97 {/each}
98</ul>
99```
100​
101<a id="call-signature-2"></a>
102​
103## Call Signature
104​
105```ts
106function queryOptions<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
107```
108​
109Defined in: [packages/svelte-query/src/queryOptions.ts:122](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L122)
110​
111You can generally pass everything to `queryOptions` that you can also pass to `createQuery`. These options
112can be shared across `createQuery` calls and imperative APIs such as `queryClient.query`. `options.queryKey`
113is required and is the query key to generate options for.
114​
115### Type Parameters
116​
117#### TQueryFnData
118​
119`TQueryFnData` = `unknown`
120​
121#### TError
122​
123`TError` = `Error`
124​
125#### TData
126​
127`TData` = `TQueryFnData`
128​
129#### TQueryKey
130​
131`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
132​
133### Parameters
134​
135#### options
136​
137[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
138​
139The [UndefinedInitialDataOptions](../type-aliases/UndefinedInitialDataOptions.md) to use β€” everything you can pass to `createQuery`.
140​
141### Returns
142​
143[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, `TQueryFnData`, `TError`\>
144​
145The same options object, typed so that `queryKey` carries the inferred data type.
146​
147### See
148​
149[createQuery](createQuery.md) to run a query with these options.
150​
151### Example
152​
153A parameterized factory, so the same options object can be reused per `id`:
154```svelte
155<script lang="ts">
156 import { queryOptions, createQuery } from '@tanstack/svelte-query'
157​
158 let { id }: { id: string } = $props()
159​
160 const postOptions = (id: string) =>
161 queryOptions({
162 queryKey: ['post', id],
163 queryFn: () => fetchPost(id),
164 })
165​
166 const query = createQuery(() => postOptions(id))
167</script>
168​
169{#if query.isPending}
170 Loading...
171{:else if query.isError}
172 <span>Error: {query.error.message}</span>
173{:else}
174 <h1>{query.data.title}</h1>
175{/if}
176```
177​
178<a id="parameters-summary"></a>
179​
180## Parameters
181​
182### options
183​
184[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>
185​
186The [UndefinedInitialDataOptions](../type-aliases/UndefinedInitialDataOptions.md) to use β€” everything you can pass to `createQuery`.
187​
188<a id="options-properties"></a>
189​
190#### `options` properties
191​
192Built from [`QueryObserverOptions`](../interfaces/QueryObserverOptions.md#properties). See the type above for what it changes.
193​
194<a id="returns-summary"></a>
195​
196## Returns
197​
198[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, `TQueryFnData`, `TError`\>
199​
200The same options object, typed so that `queryKey` carries the inferred data type.
201​
202<a id="result-properties"></a>
203​
204### Result properties
205​
206Built from [`QueryObserverOptions`](../interfaces/QueryObserverOptions.md#properties), [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md#properties). See the type above for what it changes.