function usePrefetchQuery<TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends readonly unknown[] = readonly unknown[]>(options: UsePrefetchQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, queryClient?: QueryClient): void;
Defined in: packages/react-query/src/usePrefetchQuery.tsx:38
usePrefetchQuery does not return anything, it should be used just to fire a prefetch during render, before
a suspense boundary that wraps a component that uses useSuspenseQuery. You can pass everything to
usePrefetchQuery that you can pass to queryClient.query, though queryKey is always required, and
queryFn is required unless a default query function has been defined.
The prefetch is skipped if the query already has any cached state β including a pending/error state left
over from a previous attempt β so calling this on every render is cheap and won't refetch data that's
already there or already in flight.
Type Parameters#
TQueryFnData#
TQueryFnData = unknown
TError#
TError = Error
TData#
TData = TQueryFnData
TQueryData#
TQueryData = TQueryFnData
TQueryKey#
TQueryKey extends readonly unknown[] = readonly unknown[]
Parameters#
options#
UsePrefetchQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
The UsePrefetchQueryOptions to use β everything you can pass to queryClient.query.
options properties#
Built from QueryExecuteOptions. See the type above for what it changes.
queryClient?#
Use this to use a custom QueryClient. Otherwise, the one from the nearest context will
be used.
Returns#
void
Example#
import { Suspense } from 'react'
import { usePrefetchQuery } from '@tanstack/react-query'
function App() {
// Fire the prefetch during render, before the suspense boundary below.
usePrefetchQuery({
queryKey: ['posts'],
queryFn: fetchPosts,
})
return (
<Suspense fallback={<h1>Loading posts...</h1>}>
<Posts />
</Suspense>
)
}