译零 TransZero · TanStack Query 中文文档
主站

DehydrateOptions

更新于 2026-11-02 Solid 查看英文原文 ↗

定义位置:packages/query-core/src/hydration.ts:49

dehydrate 的选项,用于控制哪些查询/修改被包含在生成的 DehydratedState 中,以及其数据/错误在序列化前(例如嵌入服务端渲染的 HTML 标记时)如何转换。

属性

属性 类型 描述
serializeData? TransformerFn 在查询脱水前转换其 data。适用于非 JSON 可序列化的数据。
shouldDehydrateMutation? (mutation: Mutation) => boolean 判断给定 Mutation 是否应被脱水的谓词函数。默认为 defaultShouldDehydrateMutation。
shouldDehydrateQuery? (query: Query) => boolean 判断给定 Query 是否应被脱水的谓词函数。默认为 defaultShouldDehydrateQuery。
shouldRedactErrors? (error: unknown) => boolean 判断查询错误是否应在脱水前被屏蔽的谓词函数。除非提供该函数且对给定错误返回 false,否则错误将被屏蔽(替换为通用 Error('redacted')),此时保留原始错误。

本页为 TanStack Query 文档(Solid 版)的非官方中文翻译,原文由上游团队维护,遵循 MIT 许可。 译文如有偏差,以英文原文为准。

译自上游 59d11de