Zod v4 手册定位为本仓库中 Zod 4 用法的单一事实来源,目标是让查阅成本尽可能低:先定位到一个文件,只有当该文件不足以解决问题时,才沿着 See also 继续深入。
用途 该手册用于在 TypeScript 和 JavaScript 项目中定义 Zod schema、解析与校验数据、塑造对象结构、组合联合类型等任务。它适合实现 API 请求或响应校验、定义由 schema 驱动的配置、表单或环境变量校验、让同一份 schema 同时用于运行时解析与静态类型、调试 ZodError 处理与面向用户的错误消息,以及把 Zod schema 转换为 JSON Schema 或附加元数据。
主要能力与知识范围 手册按三个维度组织内容:
- 按领域(sections)
- Foundations:schema 定义、解析、类型推断、异步边界
- 原始类型:字符串、数字、布尔、枚举、字面量、日期
- 对象与集合建模
- 组合与校验逻辑
- 转换、预处理、默认值、编解码
- 错误与报告
- 元数据与 JSON Schema
- 按特性(topics)
- parse / safeParse / 异步解析
- z.input / z.output / z.infer
- 字符串格式校验
- z.object / z.strictObject / z.looseObject / catchall
- 数组 / 元组 / 记录 / Map / Set
- optional / nullable / nullish / 联合类型
- 递归 schema
- refine / superRefine / check
- preprocess / transform / pipe
- default / prefault / catch
- z.codec / z.decode / z.encode
- 错误映射与单次解析定制
- z.treeifyError / z.flattenError / z.prettifyError
- z.toJSONSchema 及带 io 选项的用法
- meta / describe / 注册表 / z.globalRegistry
- instanceof / file / function / branded / readonly
- 按索引结构
- 章节索引 sections/00-basics.md、10-primitives.md、20-objects-collections.md、30-composition.md、40-transforms-codecs.md、50-errors.md、60-json-schema-metadata.md
- 主题索引 topics/string-formats.md、object-shape-control.md、collection-types.md、unions-and-optionality.md、recursive-schemas.md、refinements.md、fallbacks.md、codecs.md、error-customization.md、error-formatting.md、json-schema.md、metadata-registries.md、special-types.md
使用方式 手册给出了 Quick Picks 任务到文件的映射表,例如定义首个 schema、解析数据、推断类型指向 sections/00-basics.md;校验 email、UUID、URL、ISO 日期时间等字符串格式指向 topics/string-formats.md;建模递归树或图指向 topics/recursive-schemas.md。使用时不要线性通读,先选定恰好一个目标文件:宽泛任务从 sections 文件入手,狭窄 API 问题从 topics 文件入手,只有当第一个文件信息不足时才查看 See also。除非用户明确要求,否则忽略发布说明、版本管理、迁移和库作者内部实现细节。文件采用统一约定:section 文件按“是什么 | 何时使用 | 快速规则 | 最小示例 | 常见陷阱 | See also”组织,topic 文件结构相同但更紧凑、更面向任务;路径相对于 SKILL.md。
适用场景 适用于 API 校验、配置与表单校验、运行时解析与静态类型复用、ZodError 调试与用户提示、JSON Schema 转换与元数据附加等。
限制与说明 包引用方面,默认使用 zod,只有在用户明确询问相关包时才使用 zod/mini 或 zod/v4/core。关于具体版本号、安装命令、收费与授权信息,资料暂未提供。