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

queryOptions.md

209 lines7.7 KB

1---
2id: queryOptions
3title: queryOptions
4redirect_from:
5 - framework/solid/reference/queryOptions
6---
7​
8<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
9​
10## Overview
11​
12```ts
13function queryOptions<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: QueryOptions<TQueryFnData, TError, TData, TQueryKey> & object): ReturnType<DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
14function queryOptions<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: QueryOptions<TQueryFnData, TError, TData, TQueryKey> & object): ReturnType<UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
15```
16​
17- [`ReturnType<DefinedInitialDataOptions>` β†’ `ReturnType<DefinedInitialDataOptions> & QueryKeyWithDataTag`](#call-signature-1): You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and is the query key to generate options for.
18- [`ReturnType<UndefinedInitialDataOptions>` β†’ `ReturnType<UndefinedInitialDataOptions> & QueryKeyWithDataTag`](#call-signature-2): You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and is the query key to generate options for.
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: QueryOptions<TQueryFnData, TError, TData, TQueryKey> & object): ReturnType<DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
28```
29​
30Defined in: [packages/solid-query/src/queryOptions.ts:86](https://github.com/TanStack/query/blob/main/packages/solid-query/src/queryOptions.ts#L86)
31​
32You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can
33be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and
34is the query key to generate options for.
35​
36This overload is selected when `initialData` is set, so the resulting `data` is never `undefined` (unless
37a `select` changes `TData` to include `undefined`).
38​
39### Type Parameters
40​
41#### TQueryFnData
42​
43`TQueryFnData` = `unknown`
44​
45#### TError
46​
47`TError` = `Error`
48​
49#### TData
50​
51`TData` = `TQueryFnData`
52​
53#### TQueryKey
54​
55`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
56​
57### Parameters
58​
59#### options
60​
61[`QueryOptions`](../interfaces/QueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object`
62​
63The [DefinedInitialDataOptions](../type-aliases/DefinedInitialDataOptions.md) to use β€” everything you can pass to `useQuery`, with `initialData` set.
64​
65### Returns
66​
67`ReturnType`\<[`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, `TQueryFnData`, `TError`\>
68​
69The same options object, typed so that `queryKey` carries the inferred data type.
70​
71### See
72​
73[useQuery](useQuery.md) to run a query with these options.
74​
75### Example
76​
77```tsx
78import { For } from 'solid-js'
79import { queryOptions, useQuery } from '@tanstack/solid-query'
80​
81const postsOptions = queryOptions({
82 queryKey: ['posts'],
83 queryFn: fetchPosts,
84 initialData: [],
85})
86​
87function Posts() {
88 // `postsQuery.data` is `Post[]`, never `undefined`, thanks to `initialData` β€” even if a refetch fails,
89 // so the list stays visible alongside the error.
90 const postsQuery = useQuery(() => postsOptions)
91​
92 return (
93 <div>
94 {postsQuery.isError ? <span>Error: {postsQuery.error.message}</span> : null}
95 <ul>
96 <For each={postsQuery.data}>{(post) => <li>{post.title}</li>}</For>
97 </ul>
98 </div>
99 )
101```
102​
103<a id="call-signature-2"></a>
104​
105## Call Signature
106​
107```ts
108function queryOptions<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: QueryOptions<TQueryFnData, TError, TData, TQueryKey> & object): ReturnType<UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
109```
110​
111Defined in: [packages/solid-query/src/queryOptions.ts:134](https://github.com/TanStack/query/blob/main/packages/solid-query/src/queryOptions.ts#L134)
112​
113You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can
114be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and
115is the query key to generate options for.
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[`QueryOptions`](../interfaces/QueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object`
140​
141The [UndefinedInitialDataOptions](../type-aliases/UndefinedInitialDataOptions.md) to use β€” everything you can pass to `useQuery`.
142​
143### Returns
144​
145`ReturnType`\<[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, `TQueryFnData`, `TError`\>
146​
147The same options object, typed so that `queryKey` carries the inferred data type.
148​
149### See
150​
151[useQuery](useQuery.md) to run a query with these options.
152​
153### Example
154​
155A parameterized factory, so the same options object can be reused per `id`:
156```tsx
157import { Match, Switch } from 'solid-js'
158import { queryOptions, useQuery } from '@tanstack/solid-query'
159​
160const postOptions = (id: string) =>
161 queryOptions({
162 queryKey: ['post', id],
163 queryFn: () => fetchPost(id),
164 })
165​
166function Post(props: { id: string }) {
167 const postQuery = useQuery(() => postOptions(props.id))
168​
169 return (
170 <Switch>
171 <Match when={postQuery.isPending}>Loading...</Match>
172 <Match when={postQuery.isError}>Error: {postQuery.error.message}</Match>
173 <Match when={postQuery.isSuccess}>
174 <h1>{postQuery.data.title}</h1>
175 </Match>
176 </Switch>
177 )
179```
180​
181<a id="parameters-summary"></a>
182​
183## Parameters
184​
185### options
186​
187[`QueryOptions`](../interfaces/QueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object`
188​
189The [UndefinedInitialDataOptions](../type-aliases/UndefinedInitialDataOptions.md) to use β€” everything you can pass to `useQuery`.
190​
191<a id="options-properties"></a>
192​
193#### `options` properties
194​
195Built from [`QueryOptions`](../interfaces/QueryOptions.md#properties). See the type above for what it changes.
196​
197<a id="returns-summary"></a>
198​
199## Returns
200​
201`ReturnType`\<[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, `TQueryFnData`, `TError`\>
202​
203The same options object, typed so that `queryKey` carries the inferred data type.
204​
205<a id="result-properties"></a>
206​
207### Result properties
208​
209Built from [`QueryOptions`](../interfaces/QueryOptions.md#properties), [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md#properties). See the type above for what it changes.