Skip to content
0

katanakit-js / DehydrateOptions

Interface: DehydrateOptions ​

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2819

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 ​

PropertyTypeDescriptionDefined in
serializeData?TransformerFnTransforms a query's data before it is dehydrated. Useful for non-JSON-serializable data.node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2821
shouldDehydrateMutation?(mutation) => booleanPredicate to decide whether a given Mutation should be dehydrated. Defaults to defaultShouldDehydrateMutation.node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2823
shouldDehydrateQuery?(query) => booleanPredicate to decide whether a given Query should be dehydrated. Defaults to defaultShouldDehydrateQuery.node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2825
shouldRedactErrors?(error) => booleanPredicate 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.node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:2831

Released under the MIT License.