UndefinedInitialDataInfiniteOptions
TypeScript
1type UndefinedInitialDataInfiniteOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object;定义于:packages/preact-query/src/infiniteQueryOptions.ts:25
当省略 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 会被持久化 到缓存中。