queryOptions
概述
1function 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;2function 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;3function 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 }：为查询选项添加类型标记，使queryKey能在 TanStack Query 各 API 间携带查询函数的数据类型与错误类型。UnusedSkipTokenOptions→UnusedSkipTokenOptions & { queryKey }：为查询选项添加类型标记，使queryKey能在 TanStack Query 各 API 间携带查询函数的数据类型与错误类型。UndefinedInitialDataOptions→UndefinedInitialDataOptions & { queryKey }：为查询选项添加类型标记，使queryKey能在 TanStack Query 各 API 间携带查询函数的数据类型与错误类型。
调用签名
1function 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;定义于：packages/lit-query/src/queryOptions.ts:92
为查询选项添加类型标记，使 queryKey 能在 TanStack Query 各 API 间携带查询函数的数据类型与错误类型。
类型参数
TQueryFnData
TQueryFnData = unknown
TError
TError = Error
TData
TData = TQueryFnData
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
参数
options
DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
需保留并添加类型标记的查询选项。
返回值
DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
带有类型化 queryKey 的相同选项对象。
示例
1import { queryOptions } from '@tanstack/lit-query'2 3const todosOptions = queryOptions({4 queryKey: ['todos'],5 queryFn: fetchTodos,6 initialData: [],7})调用签名
1function 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;定义于：packages/lit-query/src/queryOptions.ts:109
为查询选项添加类型标记，使 queryKey 能在 TanStack Query 各 API 间携带查询函数的数据类型与错误类型。
类型参数
TQueryFnData
TQueryFnData = unknown
TError
TError = Error
TData
TData = TQueryFnData
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
参数
options
UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>
需保留并添加类型标记的查询选项。
返回值
UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & object
带有类型化 queryKey 的相同选项对象。
调用签名
1function 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;定义于：packages/lit-query/src/queryOptions.ts:126
为查询选项添加类型标记，使 queryKey 能在 TanStack Query 各 API 间携带查询函数的数据类型与错误类型。
类型参数
TQueryFnData
TQueryFnData = unknown
TError
TError = Error
TData
TData = TQueryFnData
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
参数
options
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
需保留并添加类型标记的查询选项。
返回值
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
带有类型化 queryKey 的相同选项对象。
参数
options
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
需保留并添加类型标记的查询选项。
options 属性
基于 QueryObserverOptions 构建。参见上方类型定义以了解其具体变更。
返回值
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
带有类型化 queryKey 的相同选项对象。
返回值属性
基于 QueryObserverOptions 构建。参见上方类型定义以了解其具体变更。