QueryOptions
TypeScript
1type QueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = { [Property in keyof QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>]: Property extends "enabled" ? MaybeRefOrGetter<boolean | undefined> | (() => QueryBooleanOption<TQueryFnData, TError, TQueryData, DeepUnwrapRef<TQueryKey>>) : Property extends "queryKey" ? MaybeRefOrGetter<TQueryKey> : QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, DeepUnwrapRef<TQueryKey>>[Property] } & ShallowOption;定义于:packages/vue-query/src/queryOptions.ts:29
这是 queryOptions 返回的原始、未包装的选项,也是 useQuery、useQueries 及 queryClient 方法在 refs 解析完成后所接收到的选项。如需传入选项,请使用 UseQueryOptions,它接受与 refs 和 computeds 相同的选项。
类型参数
TQueryFnData
TQueryFnData = unknown
你的 queryFn 所解析出的数据类型。
TError
TError = DefaultError
你的 queryFn 可能抛出的错误类型。
TData
TData = TQueryFnData
data 经 select 处理后最终得到的数据类型。
TQueryData
TQueryData = TQueryFnData
缓存中存储的数据类型(即 select 运行前的数据类型)。默认为 TQueryFnData,且可独立于 TQueryFnData 单独配置。
TQueryKey
TQueryKey extends QueryKey = QueryKey
你的 queryKey 的类型。