DefinedInitialDataInfiniteOptions

1type DefinedInitialDataInfiniteOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object;

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

当 initialData 已知为已定义时，所选用的 infiniteQueryOptions 重载所接受的选项 —— data 永远不会是 undefined（除非某个 select 将 TData 更改为包含 undefined）。

类型参数

TQueryFnData

TQueryFnData

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

TError

TError = DefaultError

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

TData

TData = InfiniteData<TQueryFnData>

select 运行后 data 最终呈现的类型 —— 默认为 InfiniteData<TQueryFnData>，即所有已获取页面及其页面参数的结构。

TQueryKey

TQueryKey extends QueryKey = QueryKey

你的 queryKey 的类型。

TPageParam

TPageParam = unknown

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

类型声明

initialData

1initialData: 2  | NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>3  | (() => NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>);

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