* 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.5 KiB
| id | title |
|---|---|
| queryOptions | queryOptions |
Overview
function 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>;
function 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>;
DefinedInitialDataOptions→DefinedInitialDataOptions & QueryKeyWithDataTag: You can generally pass everything toqueryOptionsthat you can also pass tocreateQuery. These options can be shared acrosscreateQuerycalls and imperative APIs such asqueryClient.query.options.queryKeyis required and is the query key to generate options for.UndefinedInitialDataOptions→UndefinedInitialDataOptions & QueryKeyWithDataTag: You can generally pass everything toqueryOptionsthat you can also pass tocreateQuery. These options can be shared acrosscreateQuerycalls 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: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
Defined in: packages/svelte-query/src/queryOptions.ts:79
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.
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
DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
The DefinedInitialDataOptions to use — everything you can pass to createQuery,
with initialData known to be defined.
Returns
DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>
The same options object, typed so that queryKey carries the inferred data type.
See
createQuery to run a query with these options.
Example
<script lang="ts">
import { queryOptions, createQuery } from '@tanstack/svelte-query'
const postsOptions = queryOptions({
queryKey: ['posts'],
queryFn: fetchPosts,
initialData: [],
})
// `data` is `Post[]`, never `undefined`, thanks to `initialData` — even if a refetch fails,
// so the list stays visible alongside the error.
const query = createQuery(() => postsOptions)
</script>
{#if query.isError}
<span>Error: {query.error.message}</span>
{/if}
<ul>
{#each query.data as post (post.id)}
<li>{post.title}</li>
{/each}
</ul>
Call Signature
function 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>;
Defined in: packages/svelte-query/src/queryOptions.ts:122
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.
Type Parameters
TQueryFnData
TQueryFnData = unknown
TError
TError = Error
TData
TData = TQueryFnData
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
Parameters
options
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
The UndefinedInitialDataOptions to use — everything you can pass to createQuery.
Returns
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>
The same options object, typed so that queryKey carries the inferred data type.
See
createQuery to run a query with these options.
Example
A parameterized factory, so the same options object can be reused per id:
<script lang="ts">
import { queryOptions, createQuery } from '@tanstack/svelte-query'
let { id }: { id: string } = $props()
const postOptions = (id: string) =>
queryOptions({
queryKey: ['post', id],
queryFn: () => fetchPost(id),
})
const query = createQuery(() => postOptions(id))
</script>
{#if query.isPending}
Loading...
{:else if query.isError}
<span>Error: {query.error.message}</span>
{:else}
<h1>{query.data.title}</h1>
{/if}
Parameters
options
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
The UndefinedInitialDataOptions to use — everything you can pass to createQuery.
options properties
Built from QueryObserverOptions. See the type above for what it changes.
Returns
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 QueryObserverOptions, QueryKeyWithDataTag. See the type above for what it changes.