upstream-tanstack-query/docs/framework/angular/reference/functions/dehydrate.md

id, title

id	title
dehydrate	dehydrate

function dehydrate(client, options): DehydratedState;

Defined in: packages/query-core/src/hydration.ts:207

Dehydrates a QueryClient's cache (queries and mutations) into a plain, serializable DehydratedState, typically to embed in server-rendered markup and later restore into a client-side QueryClient via hydrate. Which queries/mutations are included, and how their data/errors are transformed, is controlled by options, falling back to the client's dehydrate default options, and finally to defaultShouldDehydrateQuery / defaultShouldDehydrateMutation.

Parameters

client

QueryClient

options

DehydrateOptions = {}

Returns

DehydratedState

Example

const queryClient = new QueryClient()

await queryClient.prefetchQuery({
  queryKey: ['posts'],
  queryFn: getPosts,
})

const dehydratedState = dehydrate(queryClient)