TanStack Query v5

Framework

Version

Menu

Getting Started

Guides & Concepts

Important Defaults

Query Functions

Parallel Queries

Dependent Queries

Background Fetching Indicators

Window Focus Refetching

Disabling/Pausing Queries

Paginated Queries

Infinite Queries

Initial Query Data

Placeholder Query Data

Query Invalidation

Invalidation from Mutations

Updates from Mutation Responses

Optimistic Updates

Query Cancellation

Scroll Restoration

Performance & Request Waterfalls

Prefetching & Router Integration

Server Rendering & Hydration

Advanced Server Rendering

Render Optimizations

Default Query Fn

Does this replace [Redux, MobX, etc]?

Migrating to v3

Migrating to v4

Migrating to v5

API Reference

InfiniteQueryObserver

QueriesObserver

useInfiniteQuery

useMutationState

useSuspenseQuery

useSuspenseInfiniteQuery

useSuspenseQueries

QueryClientProvider

infiniteQueryOptions

QueryErrorResetBoundary

useQueryErrorResetBoundary

ESLint

ESLint Plugin Query

Exhaustive Deps

Stable Query Client

No Rest Destructuring

Community Resources

Community Projects

Examples

Basic w/ GraphQL-Request

Auto Refetching / Polling / Realtime

Optimistic Updates (UI)

Optimistic Updates (Cache)

Load-More & Infinite Scroll

Infinite query with Max pages

Default Query Function

Next.js app with streaming

Offline Queries and Mutations

Plugins

persistQueryClient

createSyncStoragePersister

createAsyncStoragePersister

broadcastQueryClient (Experimental)

createPersister (Experimental)

TanStack Query v5

Framework

Version

Menu

Getting Started

Guides & Concepts

Important Defaults

Query Functions

Parallel Queries

Dependent Queries

Background Fetching Indicators

Window Focus Refetching

Disabling/Pausing Queries

Paginated Queries

Infinite Queries

Initial Query Data

Placeholder Query Data

Query Invalidation

Invalidation from Mutations

Updates from Mutation Responses

Optimistic Updates

Query Cancellation

Scroll Restoration

Performance & Request Waterfalls

Prefetching & Router Integration

Server Rendering & Hydration

Advanced Server Rendering

Render Optimizations

Default Query Fn

Does this replace [Redux, MobX, etc]?

Migrating to v3

Migrating to v4

Migrating to v5

API Reference

InfiniteQueryObserver

QueriesObserver

useInfiniteQuery

useMutationState

useSuspenseQuery

useSuspenseInfiniteQuery

useSuspenseQueries

QueryClientProvider

infiniteQueryOptions

QueryErrorResetBoundary

useQueryErrorResetBoundary

ESLint

ESLint Plugin Query

Exhaustive Deps

Stable Query Client

No Rest Destructuring

Community Resources

Community Projects

Examples

Basic w/ GraphQL-Request

Auto Refetching / Polling / Realtime

Optimistic Updates (UI)

Optimistic Updates (Cache)

Load-More & Infinite Scroll

Infinite query with Max pages

Default Query Function

Next.js app with streaming

Offline Queries and Mutations

Plugins

persistQueryClient

createSyncStoragePersister

createAsyncStoragePersister

broadcastQueryClient (Experimental)

createPersister (Experimental)

infiniteQueryOptions

Options

You can generally pass everything to queryOptions that you can also pass to useInfiniteQuery. Some options will have no effect when then forwarded to a function like queryClient.prefetchInfiniteQuery, but TypeScript will still be fine with those excess properties.

queryKey: QueryKey
- Required
- The query key to generate options for.

QueryErrorResetBoundary

Want to Skip the Docs?

“This course is the best way to learn how to use React Query in real-world applications.”—Tanner Linsley

Want to Skip the Docs?

“This course is the best way to learn how to use React Query in real-world applications.”—Tanner Linsley