usePrefetchInfiniteQuery

usePrefetchInfiniteQuery(options)

usePrefetchInfiniteQuery(options)

选项

您可以将传递给 queryClient.prefetchInfiniteQuery 的所有内容都传递给 usePrefetchInfiniteQuery。请记住，以下某些选项是必需的：

• queryKey: QueryKey

  • 必需
  • 在渲染期间要预取的查询键

• queryFn: (context: QueryFunctionContext) => Promise<TData>

  • 必需，但仅当未定义默认查询函数时 有关更多信息，请参阅默认查询函数。

• initialPageParam: TPageParam

  • 必需
  • 获取第一页时使用的默认页面参数。

• getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => TPageParam | undefined | null

  • 必需
  • 当此查询收到新数据时，此函数将接收无限数据列表的最后一页和所有页面的完整数组，以及页面参数信息。
  • 它应该返回一个单个变量，该变量将作为最后一个可选参数传递给您的查询函数。
  • 返回 undefined 或 null 表示没有下一页可用。

• 返回值

usePrefetchInfiniteQuery 不返回任何内容，它应该仅用于在渲染期间、在包装使用 useSuspenseInfiniteQuery 的组件的 suspense 边界之前触发预取。