usePrefetchInfiniteQuery

usePrefetchInfiniteQuery(options)

usePrefetchInfiniteQuery(options)

选项

你可以将所有内容传递给 usePrefetchInfiniteQuery，这些内容也可以传递给 queryClient.prefetchInfiniteQuery。请记住，其中一些是必需的，如下所示

• queryKey: QueryKey

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

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

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

• initialPageParam: TPageParam

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

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

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

• 返回值

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