3.6 KiB
id, title
| id | title |
|---|---|
| queryOptions | queryOptions |
Call Signature
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options): Omit<QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, never>, "queryFn"> & object & object;
Defined in: packages/lit-query/src/queryOptions.ts:94
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
Omit<QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, never>, "queryFn"> & object & 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, TError, TData, TQueryKey>(options): OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, never>, "queryFn"> & object & object;
Defined in: packages/lit-query/src/queryOptions.ts:112
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
OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, never>, "queryFn"> & object & object
The same options object with a typed queryKey.
Call Signature
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options): QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, never> & object & object;
Defined in: packages/lit-query/src/queryOptions.ts:130
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
QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, never> & object & object
The same options object with a typed queryKey.