UndefinedInitialDataOptions

1type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & object;

定义于：packages/react-query/src/queryOptions.ts:22

当省略 initialData 时，所选的 queryOptions 重载所接受的选项。此时 initialData 可能为 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?

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

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