* 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
12 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: UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>): UnusedSkipTokenOptions<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 toinjectQuery. These options can be shared across functions and imperative APIs such asqueryClient.fetchQuery.options.queryKeyis required and is the query key to generate options for.UnusedSkipTokenOptions→UnusedSkipTokenOptions & QueryKeyWithDataTag: You can generally pass everything toqueryOptionsthat you can also pass toinjectQuery. These options can be shared across functions and imperative APIs such asqueryClient.fetchQuery.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 toinjectQuery. These options can be shared across functions and imperative APIs such asqueryClient.fetchQuery.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/angular-query-experimental/src/query-options.ts:149
You can generally pass everything to queryOptions that you can also pass to injectQuery. These options
can be shared across functions and imperative APIs such as queryClient.fetchQuery. 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 injectQuery,
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
- injectQuery to run a query with these options.
- The Query Options API for more on this pattern.
Example
import { queryOptions, injectQuery } from '@tanstack/angular-query-experimental'
export const postsOptions = queryOptions({
queryKey: ['posts'],
queryFn: fetchPosts,
initialData: [],
})
@Component({
selector: 'posts',
template: `
<!-- `postsQuery.data()` is never `undefined`, thanks to `initialData` — even if a refetch
fails, so the list stays visible alongside the error. -->
@if (postsQuery.isError()) {
<span>Error: {{ postsQuery.error()?.message }}</span>
}
<ul>
@for (post of postsQuery.data(); track post.id) {
<li>{{ post.title }}</li>
}
</ul>
`,
})
export class Posts {
readonly postsQuery = injectQuery(() => postsOptions)
}
Call Signature
function queryOptions<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>): UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
Defined in: packages/angular-query-experimental/src/query-options.ts:196
You can generally pass everything to queryOptions that you can also pass to injectQuery. These options
can be shared across functions and imperative APIs such as queryClient.fetchQuery. 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
UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>
The UnusedSkipTokenOptions to use — everything you can pass to injectQuery.
Returns
UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>
The same options object, typed so that queryKey carries the inferred data type.
See
- injectQuery to run a query with these options.
- The Query Options API for more on this pattern.
Example
A parameterized factory, so the same options object can be reused per id:
import { queryOptions, injectQuery } from '@tanstack/angular-query-experimental'
export const postOptions = (id: string) =>
queryOptions({
queryKey: ['post', id],
queryFn: () => fetchPost(id),
})
@Component({
selector: 'post',
template: `
@if (postQuery.isPending()) {
Loading...
} @else if (postQuery.isError()) {
<span>Error: {{ postQuery.error()?.message }}</span>
} @else {
<h1>{{ postQuery.data().title }}</h1>
}
`,
})
export class Post {
readonly id = signal('1')
readonly postQuery = injectQuery(() => postOptions(this.id()))
}
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/angular-query-experimental/src/query-options.ts:274
You can generally pass everything to queryOptions that you can also pass to injectQuery. These options
can be shared across functions and imperative APIs such as queryClient.fetchQuery. 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 injectQuery.
Returns
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>
The same options object, typed so that queryKey carries the inferred data type.
Remarks
This is the only overload that accepts queryFn: skipToken, shown below.
See
- injectQuery to run a query with these options.
- The Query Options API for more on this pattern.
Examples
A parameterized factory, so the same options object can be reused per id:
import { queryOptions, injectQuery } from '@tanstack/angular-query-experimental'
export const postOptions = (id: string) =>
queryOptions({
queryKey: ['post', id],
queryFn: () => fetchPost(id),
})
@Component({
selector: 'post',
template: `
@if (postQuery.isPending()) {
Loading...
} @else if (postQuery.isError()) {
<span>Error: {{ postQuery.error()?.message }}</span>
} @else {
<h1>{{ postQuery.data().title }}</h1>
}
`,
})
export class Post {
readonly id = signal('1')
readonly postQuery = injectQuery(() => postOptions(this.id()))
}
A factory that disables the query, type safe, until postId is set:
import { queryOptions, skipToken, injectQuery } from '@tanstack/angular-query-experimental'
export const postOptions = (postId: number | undefined) =>
queryOptions({
queryKey: ['post', postId],
queryFn: postId != null ? () => fetchPost(postId) : skipToken,
})
@Component({
selector: 'post',
template: `
@if (postId() == null) {
Select a post
} @else if (postQuery.isPending()) {
Loading...
} @else if (postQuery.isError()) {
<span>Error: {{ postQuery.error()?.message }}</span>
} @else {
<h1>{{ postQuery.data().title }}</h1>
}
`,
})
export class Post {
readonly postId = signal<number | undefined>(undefined)
readonly postQuery = injectQuery(() => postOptions(this.postId()))
}
Parameters
options
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
The UndefinedInitialDataOptions to use — everything you can pass to injectQuery.
options properties
Built from CreateQueryOptions. 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 CreateQueryOptions, QueryKeyWithDataTag. See the type above for what it changes.