0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
query/docs/framework/angular/reference/interfaces/DehydrateOptions.md
Wonsuk Choi e57f8163b1
docs(query-core): add JSDoc across the package and expose it in generated reference docs (#11438)
* 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
2026-09-07 18:22:38 +02:00

2.1 KiB

id title
DehydrateOptions DehydrateOptions

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

Options for dehydrate, controlling which queries/mutations are included in the resulting DehydratedState and how their data/errors are transformed before being serialized (e.g. for embedding in server-rendered markup).

Properties

serializeData?

optional serializeData: TransformerFn;

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

Transforms a query's data before it is dehydrated. Useful for non-JSON-serializable data.


shouldDehydrateMutation()?

optional shouldDehydrateMutation: (mutation) => boolean;

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

Predicate to decide whether a given Mutation should be dehydrated. Defaults to defaultShouldDehydrateMutation.

Parameters

mutation

Mutation

Returns

boolean


shouldDehydrateQuery()?

optional shouldDehydrateQuery: (query) => boolean;

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

Predicate to decide whether a given Query should be dehydrated. Defaults to defaultShouldDehydrateQuery.

Parameters

query

Query

Returns

boolean


shouldRedactErrors()?

optional shouldRedactErrors: (error) => boolean;

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

Predicate to decide whether a query's error should be redacted before dehydration. Errors are redacted (replaced with a generic Error('redacted')) unless this function is provided and returns false for the given error, in which case the original error is kept.

Parameters

error

unknown

Returns

boolean