* docs({react,preact,angular,solid,svelte,vue}-query): describe the 'initialData' overloads as 'known to be defined' and 'omitted or may be undefined'
* docs({react,preact,angular,solid,svelte,vue}-query): regenerate reference docs
* docs({react,preact,angular,solid,svelte,vue}-query): mention an 'initialData' function that may return 'undefined' in the 'Undefined' overload descriptions
* docs({react,preact,angular,solid,svelte,vue}-query): regenerate reference docs
7.7 KiB
| id | title | redirect_from | |
|---|---|---|---|
| queryOptions | queryOptions |
|
Overview
function 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>;
function 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>;
ReturnType<DefinedInitialDataOptions>→ReturnType<DefinedInitialDataOptions> & QueryKeyWithDataTag: You can generally pass everything toqueryOptionsthat you can also pass touseQuery. These options can be shared across hooks and imperative APIs such asqueryClient.query.options.queryKeyis required and is the query key to generate options for.ReturnType<UndefinedInitialDataOptions>→ReturnType<UndefinedInitialDataOptions> & QueryKeyWithDataTag: You can generally pass everything toqueryOptionsthat you can also pass touseQuery. These options can be shared across hooks and imperative APIs such asqueryClient.query.options.queryKeyis required and is the query key to generate options for.
See also: Parameters · Returns
Call Signature
function 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>;
Defined in: packages/solid-query/src/queryOptions.ts:94
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.
This overload is selected when initialData is known to be defined, so the resulting data is never
undefined (unless a select changes TData to include undefined).
Type Parameters
TQueryFnData
TQueryFnData = unknown
TError
TError = Error
TData
TData = TQueryFnData
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
Parameters
options
QueryOptions<TQueryFnData, TError, TData, TQueryKey> & object
The DefinedInitialDataOptions to use — everything you can pass to useQuery, with initialData known to be defined.
Returns
ReturnType<DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>
The same options object, typed so that queryKey carries the inferred data type.
See
useQuery to run a query with these options.
Example
import { For } from 'solid-js'
import { queryOptions, useQuery } from '@tanstack/solid-query'
const postsOptions = queryOptions({
queryKey: ['posts'],
queryFn: fetchPosts,
initialData: [],
})
function Posts() {
// `postsQuery.data` is `Post[]`, never `undefined`, thanks to `initialData` — even if a refetch fails,
// so the list stays visible alongside the error.
const postsQuery = useQuery(() => postsOptions)
return (
<div>
{postsQuery.isError ? <span>Error: {postsQuery.error.message}</span> : null}
<ul>
<For each={postsQuery.data}>{(post) => <li>{post.title}</li>}</For>
</ul>
</div>
)
}
Call Signature
function 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>;
Defined in: packages/solid-query/src/queryOptions.ts:142
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.
Type Parameters
TQueryFnData
TQueryFnData = unknown
TError
TError = Error
TData
TData = TQueryFnData
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
Parameters
options
QueryOptions<TQueryFnData, TError, TData, TQueryKey> & object
The UndefinedInitialDataOptions to use — everything you can pass to useQuery.
Returns
ReturnType<UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>
The same options object, typed so that queryKey carries the inferred data type.
See
useQuery to run a query with these options.
Example
A parameterized factory, so the same options object can be reused per id:
import { Match, Switch } from 'solid-js'
import { queryOptions, useQuery } from '@tanstack/solid-query'
const postOptions = (id: string) =>
queryOptions({
queryKey: ['post', id],
queryFn: () => fetchPost(id),
})
function Post(props: { id: string }) {
const postQuery = useQuery(() => postOptions(props.id))
return (
<Switch>
<Match when={postQuery.isPending}>Loading...</Match>
<Match when={postQuery.isError}>Error: {postQuery.error.message}</Match>
<Match when={postQuery.isSuccess}>
<h1>{postQuery.data.title}</h1>
</Match>
</Switch>
)
}
Parameters
options
QueryOptions<TQueryFnData, TError, TData, TQueryKey> & object
The UndefinedInitialDataOptions to use — everything you can pass to useQuery.
options properties
Built from QueryOptions. See the type above for what it changes.
Returns
ReturnType<UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>
The same options object, typed so that queryKey carries the inferred data type.
Result properties
Built from QueryOptions, QueryKeyWithDataTag. See the type above for what it changes.