* chore(scripts/generate-docs): read type alias bodies whose type parameters have defaults * chore(*): update '@tanstack/typedoc-config' to v0.3.5
6.3 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> & object;
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> & object;
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> & object;
DefinedInitialDataOptions→DefinedInitialDataOptions & { queryKey }: Brands query options so thequeryKeycarries the query function data and error types across TanStack Query APIs.UnusedSkipTokenOptions→UnusedSkipTokenOptions & { queryKey }: Brands query options so thequeryKeycarries the query function data and error types across TanStack Query APIs.UndefinedInitialDataOptions→UndefinedInitialDataOptions & { queryKey }: Brands query options so thequeryKeycarries the query function data and error types across TanStack Query APIs.
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> & object;
Defined in: packages/lit-query/src/queryOptions.ts:92
Brands query options so the queryKey carries the query function data and
error types across TanStack Query APIs.
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>
Query options to preserve and brand.
Returns
DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
The same options object with a typed queryKey.
Example
import { queryOptions } from '@tanstack/lit-query'
const todosOptions = queryOptions({
queryKey: ['todos'],
queryFn: fetchTodos,
initialData: [],
})
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> & object;
Defined in: packages/lit-query/src/queryOptions.ts:109
Brands query options so the queryKey carries the query function data and
error types across TanStack Query APIs.
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>
Query options to preserve and brand.
Returns
UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & object
The same options object with a typed queryKey.
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> & object;
Defined in: packages/lit-query/src/queryOptions.ts:126
Brands query options so the queryKey carries the query function data and
error types across TanStack Query APIs.
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>
Query options to preserve and brand.
Returns
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
The same options object with a typed queryKey.
Parameters
options
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
Query options to preserve and brand.
options properties
Built from QueryObserverOptions. See the type above for what it changes.
Returns
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
The same options object with a typed queryKey.
Result properties
Built from QueryObserverOptions. See the type above for what it changes.