* docs(*): add parameter and result property tables to reference function pages and an overview to overloaded ones * docs(*): link to the base type's properties when a parameter or result type has no property table * docs(framework/*/reference): regenerate reference docs * docs(framework/*/reference): regenerate reference docs * chore(scripts/generate-docs): restore the 'dirname' import that the merge dropped * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): label overloads in the overview with their declared parameter and return types * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): convert declared intersection types from the source so signatures keep their alias names * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): reword a comment to avoid the unknown word 'inlines' * docs(scripts/generate-docs): skip a parameter table on overloaded pages when its heading is missing
2.4 KiB
| id | title | redirect_from | |
|---|---|---|---|
| usePrefetchQuery | usePrefetchQuery |
|
function usePrefetchQuery<TQueryFnData, TError, TData, TQueryData, TQueryKey>(options: UsePrefetchQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, queryClient?: QueryClient): void;
Defined in: packages/react-query/src/usePrefetchQuery.tsx:39
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>
)
}