Source: https://tanstack.com/query/v5/docs/framework/react/reference/usePrefetchInfiniteQuery

TanStack

Query v5v5

Search...

+ K

Auto

Log In

TanStack StartRC

Docs Examples GitHub Contributors

TanStack Router

Docs Examples GitHub Contributors

TanStack Query

Docs Examples GitHub Contributors

TanStack Table

Docs Examples Github Contributors

TanStack Formnew

Docs Examples Github Contributors

TanStack DBbeta

Docs Github Contributors

TanStack Virtual

Docs Examples Github Contributors

TanStack Paceralpha

Docs Examples Github Contributors

TanStack Storealpha

Docs Examples Github Contributors

TanStack Devtoolsalpha

Docs Github Contributors

More Libraries

Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide

Documentation

Framework

React

Version

v5

Search...

+ K

Menu

• Home

• Frameworks

• Contributors

• Community Resources

• GitHub

• Discord

Getting Started

• Overview
  
  react

• Installation
  
  react

• Quick Start
  
  react

• Devtools
  
  react

• Comparison
  
  react

• TypeScript
  
  react

• GraphQL
  
  react

• React Native
  
  react

Guides & Concepts

• Important Defaults
  
  react

• Queries
  
  react

• Query Keys
  
  react

• Query Functions
  
  react

• Query Options
  
  react

• Network Mode
  
  react

• Parallel Queries
  
  react

• Dependent Queries
  
  react

• Background Fetching Indicators
  
  react

• Window Focus Refetching
  
  react

• Disabling/Pausing Queries
  
  react

• Query Retries
  
  react

• Paginated Queries
  
  react

• Infinite Queries
  
  react

• Initial Query Data
  
  react

• Placeholder Query Data
  
  react

• Mutations
  
  react

• Query Invalidation
  
  react

• Invalidation from Mutations
  
  react

• Updates from Mutation Responses
  
  react

• Optimistic Updates
  
  react

• Query Cancellation
  
  react

• Scroll Restoration
  
  react

• Filters
  
  react

• Performance & Request Waterfalls
  
  react

• Prefetching & Router Integration
  
  react

• Server Rendering & Hydration
  
  react

• Advanced Server Rendering
  
  react

• Caching
  
  react

• Render Optimizations
  
  react

• Default Query Fn
  
  react

• Suspense
  
  react

• Testing
  
  react

• Does this replace [Redux, MobX, etc]?
  
  react

• Migrating to v3
  
  react

• Migrating to v4
  
  react

• Migrating to v5
  
  react

API Reference

• QueryClient
  
  core

• QueryCache
  
  core

• MutationCache
  
  core

• QueryObserver
  
  core

• InfiniteQueryObserver
  
  core

• QueriesObserver
  
  core

• streamedQuery
  
  core

• focusManager
  
  core

• onlineManager
  
  core

• notifyManager
  
  core

• timeoutManager
  
  core

• useQuery
  
  react

• useQueries
  
  react

• useInfiniteQuery
  
  react

• useMutation
  
  react

• useIsFetching
  
  react

• useIsMutating
  
  react

• useMutationState
  
  react

• useSuspenseQuery
  
  react

• useSuspenseInfiniteQuery
  
  react

• useSuspenseQueries
  
  react

• QueryClientProvider
  
  react

• useQueryClient
  
  react

• queryOptions
  
  react

• infiniteQueryOptions
  
  react

• mutationOptions
  
  react

• usePrefetchQuery
  
  react

• usePrefetchInfiniteQuery
  
  react

• QueryErrorResetBoundary
  
  react

• useQueryErrorResetBoundary
  
  react

• hydration
  
  react

ESLint

• ESLint Plugin Query
  
  core

• Exhaustive Deps
  
  core

• Stable Query Client
  
  core

• No Rest Destructuring
  
  core

• No Unstable Deps
  
  core

• Infinite Query Property Order
  
  core

Examples

• Simple
  
  react

• Basic
  
  react

• Basic w/ GraphQL-Request
  
  react

• Auto Refetching / Polling / Realtime
  
  react

• Optimistic Updates (UI)
  
  react

• Optimistic Updates (Cache)
  
  react

• Pagination
  
  react

• Load-More & Infinite Scroll
  
  react

• Infinite query with Max pages
  
  react

• Suspense
  
  react

• Default Query Function
  
  react

• Playground
  
  react

• Prefetching
  
  react

• Star Wars
  
  react

• Rick And Morty
  
  react

• Next.js Pages
  
  react

• Next.js app with prefetching
  
  react

• Next.js app with streaming
  
  react

• React Native
  
  react

• React Router
  
  react

• Offline Queries and Mutations
  
  react

• Algolia
  
  react

• Shadow DOM
  
  react

• Devtools Embedded Panel
  
  react

• Chat example (streaming)
  
  react

Plugins

• persistQueryClient
  
  react

• createSyncStoragePersister
  
  react

• createAsyncStoragePersister
  
  react

• broadcastQueryClient (Experimental)
  
  react

• createPersister (Experimental)
  
  react

Framework

React

Version

v5

Menu

• Home

• Frameworks

• Contributors

• Community Resources

• GitHub

• Discord

Getting Started

• Overview
  
  react

• Installation
  
  react

• Quick Start
  
  react

• Devtools
  
  react

• Comparison
  
  react

• TypeScript
  
  react

• GraphQL
  
  react

• React Native
  
  react

Guides & Concepts

• Important Defaults
  
  react

• Queries
  
  react

• Query Keys
  
  react

• Query Functions
  
  react

• Query Options
  
  react

• Network Mode
  
  react

• Parallel Queries
  
  react

• Dependent Queries
  
  react

• Background Fetching Indicators
  
  react

• Window Focus Refetching
  
  react

• Disabling/Pausing Queries
  
  react

• Query Retries
  
  react

• Paginated Queries
  
  react

• Infinite Queries
  
  react

• Initial Query Data
  
  react

• Placeholder Query Data
  
  react

• Mutations
  
  react

• Query Invalidation
  
  react

• Invalidation from Mutations
  
  react

• Updates from Mutation Responses
  
  react

• Optimistic Updates
  
  react

• Query Cancellation
  
  react

• Scroll Restoration
  
  react

• Filters
  
  react

• Performance & Request Waterfalls
  
  react

• Prefetching & Router Integration
  
  react

• Server Rendering & Hydration
  
  react

• Advanced Server Rendering
  
  react

• Caching
  
  react

• Render Optimizations
  
  react

• Default Query Fn
  
  react

• Suspense
  
  react

• Testing
  
  react

• Does this replace [Redux, MobX, etc]?
  
  react

• Migrating to v3
  
  react

• Migrating to v4
  
  react

• Migrating to v5
  
  react

API Reference

• QueryClient
  
  core

• QueryCache
  
  core

• MutationCache
  
  core

• QueryObserver
  
  core

• InfiniteQueryObserver
  
  core

• QueriesObserver
  
  core

• streamedQuery
  
  core

• focusManager
  
  core

• onlineManager
  
  core

• notifyManager
  
  core

• timeoutManager
  
  core

• useQuery
  
  react

• useQueries
  
  react

• useInfiniteQuery
  
  react

• useMutation
  
  react

• useIsFetching
  
  react

• useIsMutating
  
  react

• useMutationState
  
  react

• useSuspenseQuery
  
  react

• useSuspenseInfiniteQuery
  
  react

• useSuspenseQueries
  
  react

• QueryClientProvider
  
  react

• useQueryClient
  
  react

• queryOptions
  
  react

• infiniteQueryOptions
  
  react

• mutationOptions
  
  react

• usePrefetchQuery
  
  react

• usePrefetchInfiniteQuery
  
  react

• QueryErrorResetBoundary
  
  react

• useQueryErrorResetBoundary
  
  react

• hydration
  
  react

ESLint

• ESLint Plugin Query
  
  core

• Exhaustive Deps
  
  core

• Stable Query Client
  
  core

• No Rest Destructuring
  
  core

• No Unstable Deps
  
  core

• Infinite Query Property Order
  
  core

Examples

• Simple
  
  react

• Basic
  
  react

• Basic w/ GraphQL-Request
  
  react

• Auto Refetching / Polling / Realtime
  
  react

• Optimistic Updates (UI)
  
  react

• Optimistic Updates (Cache)
  
  react

• Pagination
  
  react

• Load-More & Infinite Scroll
  
  react

• Infinite query with Max pages
  
  react

• Suspense
  
  react

• Default Query Function
  
  react

• Playground
  
  react

• Prefetching
  
  react

• Star Wars
  
  react

• Rick And Morty
  
  react

• Next.js Pages
  
  react

• Next.js app with prefetching
  
  react

• Next.js app with streaming
  
  react

• React Native
  
  react

• React Router
  
  react

• Offline Queries and Mutations
  
  react

• Algolia
  
  react

• Shadow DOM
  
  react

• Devtools Embedded Panel
  
  react

• Chat example (streaming)
  
  react

Plugins

• persistQueryClient
  
  react

• createSyncStoragePersister
  
  react

• createAsyncStoragePersister
  
  react

• broadcastQueryClient (Experimental)
  
  react

• createPersister (Experimental)
  
  react

usePrefetchInfiniteQuery

Copy Markdown

tsx

usePrefetchInfiniteQuery(options)


usePrefetchInfiniteQuery(options)

Options

You can pass everything to usePrefetchInfiniteQuery that you can pass to queryClient.prefetchInfiniteQuery . Remember that some of them are required as below:

• queryKey: QueryKey

  • Required
  • The query key to prefetch during render

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

  • Required, but only if no default query function has been defined See Default Query Function for more information.

• initialPageParam: TPageParam

  • Required
  • The default page param to use when fetching the first page.

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

  • Required
  • When new data is received for this query, this function receives both the last page of the infinite list of data and the full array of all pages, as well as pageParam information.
  • It should return a single variable that will be passed as the last optional parameter to your query function.
  • Return undefined or null to indicate there is no next page available.

• Returns

The usePrefetchInfiniteQuery 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 useSuspenseInfiniteQuery

Edit on GitHub

usePrefetchQuery

QueryErrorResetBoundary

Partners Become a Partner

[###### Want to Skip the Docs?

Query.gg - The Official React Query Course
\

“If you’re serious about *really* understanding React Query, there’s no better way than with query.gg”—Tanner Linsley

Learn More](https://query.gg/?s=tanstack)