- Important Defaults
- Queries
- Query Keys
- Query Functions
- Query Options
- Network Mode
- Parallel Queries
- Dependent Queries
- Background Fetching Indicators
- Window Focus Refetching
- Disabling/Pausing Queries
- Query Retries
- Paginated Queries
- Infinite Queries
- Initial Query Data
- Placeholder Query Data
- Mutations
- Mutation Options
- Query Invalidation
- Invalidation from Mutations
- Optimistic Updates
- Query Cancellation
- Scroll Restoration
- Filters
- Caching
- Default Query Fn
- SSR
- Testing
- Does this replace state managers?
- Migrating from Experimental
- Migrating from ngneat/query
- Error Handling
SSR
For Angular SSR, provideTanStackQuery serializes the QueryClient cache into Angular's TransferState and restores it when the browser application starts.
See the Angular SSR example. The SSR persistence example builds on the same setup with browser persistence.
Query client factory#
import { isPlatformBrowser } from '@angular/common'
import { inject, PLATFORM_ID } from '@angular/core'
import { QueryClient } from '@tanstack/angular-query'
export function createQueryClient() {
const isBrowser = isPlatformBrowser(inject(PLATFORM_ID))
return new QueryClient({
defaultOptions: {
queries: {
// Retry failed queries in the browser, but not on the server.
retry: isBrowser ? 3 : 0,
},
},
})
}Browser config#
Use the factory with provideTanStackQuery in your application config. Angular's HTTP transfer cache is enabled by default with provideClientHydration. Add withNoHttpTransferCache so query results are not serialized once by each cache.
import { provideHttpClient } from '@angular/common/http'
import {
provideClientHydration,
withEventReplay,
withNoHttpTransferCache,
} from '@angular/platform-browser'
import { provideTanStackQuery } from '@tanstack/angular-query'
import { withDevtools } from '@tanstack/angular-query-devtools'
import { createQueryClient } from './query-client'
import type { ApplicationConfig } from '@angular/core'
export const appConfig: ApplicationConfig = {
providers: [
provideHttpClient(),
provideClientHydration(withEventReplay(), withNoHttpTransferCache()),
provideTanStackQuery(createQueryClient, withDevtools()),
],
}Server config#
Merge the application config with provideServerRendering in the server config.
import { mergeApplicationConfig } from '@angular/core'
import { provideServerRendering, withRoutes } from '@angular/ssr'
import { appConfig } from './app.config'
import { serverRoutes } from './app.routes.server'
export const serverConfig = mergeApplicationConfig(appConfig, {
providers: [provideServerRendering(withRoutes(serverRoutes))],
})Multiple query clients#
Built-in hydration uses a default transfer key. For a second QueryClient in a child injector, pass a distinct key with withHydrationKey so each client's serialized cache stays separate.
providers: [
provideTanStackQuery(
createSecondaryQueryClient,
withHydrationKey('my-secondary-query-cache'),
),
]Disabling built-in hydration#
If you need to opt out of TanStack Query's built-in TransferState integration for a specific injector, add withNoQueryHydration().
providers: [provideTanStackQuery(createQueryClient, withNoQueryHydration())]