译零 TransZero · TanStack Query 中文文档
主站

UnusedSkipTokenInfiniteOptions

更新于 2026-11-02 React 查看英文原文 ↗
TypeScript
1type UnusedSkipTokenInfiniteOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, "queryFn"> & object;

定义于:packages/react-query/src/infiniteQueryOptions.ts:63

当 queryFn 不为 skipToken 且 initialData 被省略、为 undefined,或为可能返回 undefined 的函数时,所选 infiniteQueryOptions 重载接受的选项 —— 与 UndefinedInitialDataInfiniteOptions 相同,但 queryFn 不得为 skipToken。

类型参数

TQueryFnData

TQueryFnData

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

TError

TError = DefaultError

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

TData

TData = InfiniteData<TQueryFnData>

data 经 select 处理后的最终类型 —— 默认为 InfiniteData<TQueryFnData>,即所有已获取页面及其页面参数的结构。

TQueryKey

TQueryKey extends QueryKey = QueryKey

你的 queryKey 的类型。

TPageParam

TPageParam = unknown

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

类型声明

queryFn?

TypeScript
1optional queryFn?: Exclude<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>["queryFn"], SkipToken | undefined>;

此处不允许将 skipToken 作为值 —— 此重载在 initialData 被省略、为 undefined,或为可能返回 undefined 的函数时被选用。若你暂不打算执行查询,请设置 enabled: false;仅省略 queryFn 仍会触发一次失败的拉取,报错 “Missing queryFn”,除非 enabled 为 false,或已定义默认查询函数。默认查询函数仅提供 queryFn,自身不会延迟拉取。

本页为 TanStack Query 文档(React 版)的非官方中文翻译,原文由上游团队维护,遵循 MIT 许可。 译文如有偏差,以英文原文为准。

译自上游 59d11de