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

dehydrateQuery

更新于 2026-11-02 React 查看英文原文 ↗
TypeScript
1function dehydrateQuery(2   query: Query, 3   serializeData?: TransformerFn, 4   shouldRedactErrors?: (error: unknown) => boolean5): DehydratedQuery;

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

将单个 Query 序列化为一个可序列化的 DehydratedQuery 快照。注意,大多数查询配置(例如 queryFn、staleTime)不会被序列化,而应在消费该序列化/反序列化数据时重新配置,通常是在客户端使用 useQuery 完成。如果该查询仍处于 pending 状态,其正在进行中的 Promise 也会被序列化,以便在另一端恢复执行,而非重新拉取。

参数

query

Query

待序列化的查询。

serializeData?

TransformerFn

可选的转换函数,在 query.state.data 被包含进快照前对其执行处理。

shouldRedactErrors?

(error: unknown) => boolean

可选的谓词函数;若该函数对 Promise 拒绝时的错误返回 false,则该错误将保持原样,而不被脱敏。

返回值

DehydratedQuery

已序列化的查询。

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

译自上游 59d11de