框架
版本

usePrefetchQuery

tsx
usePrefetchQuery(options)
usePrefetchQuery(options)

选项

你可以将所有可以传递给 queryClient.prefetchQuery 的参数传递给 usePrefetchQuery。请记住,其中一些是必需的,如下所示

  • queryKey: QueryKey

    • 必需
    • 在渲染期间预取的查询键
  • queryFn: (context: QueryFunctionContext) => Promise<TData>

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

返回

usePrefetchQuery 不返回任何内容,它应该仅用于在渲染期间,在包裹使用 useSuspenseQuery 组件的 Suspense 边界之前触发预取。