2.1 KiB
id, title
| 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
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
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