UsePrefetchQueryOptions

1type UsePrefetchQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = DistributiveOmit<QueryExecuteOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, "queryFn"> & object;

定义位置：packages/react-query/src/types.ts:77

usePrefetchQuery 接受的选项 — 即你可传给 queryClient.query 的所有选项，但 queryFn 为必填项，除非已定义默认查询函数。

类型参数

TQueryFnData

TQueryFnData = unknown

你的 queryFn 所解析出的数据类型。

TError

TError = DefaultError

你的 queryFn 可能抛出的错误类型。

TData

TData = TQueryFnData

data 经 select 处理后最终得到的类型；若未使用 select，则默认为 TQueryFnData。

TQueryData

TQueryData = TQueryFnData

查询缓存中实际存储的数据类型 — 即 select 和 placeholderData 的输入类型；默认值与通常取值均为 TQueryFnData。

TQueryKey

TQueryKey extends QueryKey = QueryKey

你的 queryKey 的类型。

类型声明

queryFn?

1optional queryFn?: Exclude<QueryExecuteOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>["queryFn"], SkipToken>;

此处不允许使用 skipToken — 预取操作始终需要一个实际执行的查询函数，除非已定义默认查询函数。