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 表示没有下一个页面可用。

• Returns (返回)

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