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

UndefinedInitialDataOptions

更新于 2026-11-02 Preact 查看英文原文 ↗
TypeScript
1type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & object;

定义位置:packages/preact-query/src/queryOptions.ts:23

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

类型参数

TQueryFnData

TQueryFnData = unknown

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

TError

TError = DefaultError

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

TData

TData = TQueryFnData

data 经 select 处理后最终呈现的数据类型。

TQueryKey

TQueryKey extends QueryKey = QueryKey

你的 queryKey 的类型。

类型声明

initialData?

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

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

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

译自上游 59d11de