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

UndefinedInitialDataInfiniteOptions

更新于 2026-11-02 Angular 查看英文原文 ↗
TypeScript
1type UndefinedInitialDataInfiniteOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object;

定义于:packages/angular-query-experimental/src/infinite-query-options.ts:24

当省略 initialData 时,所选 infiniteQueryOptions 重载接受的选项可能为 undefined,或为一个可能返回 undefined 的函数 —— 在查询处于 pending 状态期间,data 可能为 undefined。

类型参数

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 以拉取指定页面的参数类型。

类型声明

initialData?

TypeScript
1optional initialData?: 2  | NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>3| InitialDataFunction<NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>>;

若设置该值,则其将用作查询缓存的初始数据(前提是该查询尚未创建或缓存)。若设为函数,则该函数将在共享/根查询初始化期间被调用一次,且需同步返回初始数据。默认情况下,初始数据被视为过期,除非已设置 staleTime。initialData 会被持久化到缓存中。

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

译自上游 59d11de