UsePrefetchInfiniteQueryOptions

1type UsePrefetchInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = DistributiveOmit<InfiniteQueryExecuteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, "queryFn"> & object;

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

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

类型参数

TQueryFnData

TQueryFnData = unknown

单页数据的类型，即你的 queryFn 所解析出的数据类型。

TError

TError = DefaultError

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

TData

TData = InfiniteData<TQueryFnData>

data 经 select 处理后的最终类型。默认为 InfiniteData<TQueryFnData>，即所有已拉取页面及其分页参数的结构 — 预取操作从不读回 data，因此该参数仅在你于其他位置复用这些选项并应用 select 时才起作用。

TQueryKey

TQueryKey extends QueryKey = QueryKey

你的 queryKey 的类型。

TPageParam

TPageParam = unknown

传递给 queryFn 以拉取指定页面的参数类型。

类型声明

queryFn?

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

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