mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* docs(query-core): add JSDoc across the package and expose it in generated reference docs * docs(config.json): add sidebar entries for newly generated query-core reference docs * docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc * docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference * docs(query-core): regenerate reference docs after merging main * docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type * fix(query-devtools): drop unnecessary 'query-core' project reference * docs(query-core): document missing default values and normalize 'Defaults to' spacing * docs(query-core): fix 'environmentManager' JSDoc example
1.1 KiB
1.1 KiB
| 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
options
DehydrateOptions = {}
Returns
Example
const queryClient = new QueryClient()
await queryClient.prefetchQuery({
queryKey: ['posts'],
queryFn: getPosts,
})
const dehydratedState = dehydrate(queryClient)