schema-dsl
  • 简体中文

      • schema-dsl 文档地图

      本页是文档地图。左侧菜单保留主要学习路径；本页额外列出较短的参考页和附录页，方便已经知道大致方向的读者快速查找。

      开始

      文档何时阅读
      首页了解产品定位和文档站入口。
      快速上手第一个可运行 schema、验证结果和常见使用路径。
      设计理念理解 schema-dsl 为什么采用紧凑 DSL、JSON Schema 输出和运行时验证。
      TypeScript 指南类型推导边界、编辑器提示和 TypeScript 使用方式。

      Schema 写法

      文档何时阅读
      DSL 语法字符串与对象 schema 的完整 DSL 语法。
      完整类型列表基础类型、格式、factory 调用和类型相关行为。
      链式字段方法列表完整字段 builder 方法列表和入口支持。
      可选标记 ?可选字段语法和 required 字段行为。
      多类型支持字段支持多类型的设计说明。
      联合类型types: 语法和跨类型验证。
      联合类型指南一个字段接受多种类型的实用指南。
      数字比较运算符数字比较运算符和范围写法。
      枚举枚举语法和允许值验证。
      String 扩展JavaScript String 链式 helper 与副作用受控入口。

      验证与运行时

      文档何时阅读
      validate()同步验证 helper 和返回结构。
      validateAsync()异步验证与 ValidationError 行为。
      批量验证批量数据验证和汇总结果。
      DSL 对象支持直接把 DSL 对象定义传给验证 helper。
      验证指南端到端验证场景、失败路径和选项。
      ValidatorValidator 类、生命周期和缓存行为。
      条件 APIConditionalBuilder 与条件验证链。
      错误处理错误格式化、消息和恢复模式。
      编译重复验证前预编译 schema。
      运行时隔离app、plugin、tenant 或 worker 边界下的隔离运行时状态。

      导出与互操作

      文档何时阅读
      JSON Schema 基础schema-dsl 输出涉及的 JSON Schema 概念。
      导出指南JSON Schema 如何映射到数据库和 Markdown 导出器。
      导出限制哪些验证语义无法被数据库 DDL 表达。
      MongoDB 导出MongoDB $jsonSchema 和集合命令。
      MySQL 导出MySQL DDL 和类型映射。
      PostgreSQL 导出PostgreSQL DDL、schema 和索引。
      Markdown 导出从 schema 生成 Markdown 文档。
      TypeConverterJSON Schema 到数据库类型的转换工具。

      复用与工具

      文档何时阅读
      SchemaUtilsschema 复用、组合、过滤和工具导出。
      SchemaUtils 链式调用链式复用操作。
      SchemaUtils 最佳实践可复用 schema 的实践模式和常见陷阱。
      SchemaUtils 进阶问题更深入的边界问题和维护说明。
      SchemaHelperschema 分析和辅助工具。
      Validator 缓存编译缓存、容量、TTL 与命中率统计。
      标签与错误消息.label()、.description()、.messages()、.error() 的区别。

      国际化

      文档何时阅读
      i18n 概览国际化模型和 locale 概念。
      多语言支持内置多语言行为。
      i18n 用户指南面向使用者的 i18n 配置和用法。
      前端 i18n 指南前端语言切换模式。
      添加自定义语言包添加自定义语言包。
      动态语言切换运行时语言切换。
      运行时 locale 支持运行时验证中的 locale 行为。

      扩展与集成

      文档何时阅读
      扩展概览在自定义业务类型、校验关键字、runtime 隔离和插件之间选择路径。
      自定义 DSL 类型一份定义同时支撑纯 DSL、s('...') 和 s.xxx() 入口。
      自定义校验关键字添加自定义 AJV keyword。
      框架集成与目录结构为应用和框架组织可复用扩展模块。
      插件管理器（高级）插件生命周期、hook 和集成编排。

      生产实践与排错

      文档何时阅读
      最佳实践生产项目中的推荐用法。
      项目结构最佳实践在真实项目中组织 schema-dsl。
      性能指南性能调优和缓存注意事项。
      安全注意事项schema 使用、自定义 validator 和导出时的安全注意事项。
      故障排查常见失败和可复现修复方式。
      FAQ常见问题的短答案。

      参考与索引

      文档何时阅读
      API 参考完整公开 API 参考。
      API 概览紧凑 API 入口。
      文档地图本页，按主题组织。
      功能索引按能力查找对应文档。

      示例

      资源用途
      examples/docs文档页对应的 companion examples。
      doc-index.ts串起快速开始、编译和文档导出的最小入口脚本。

      当前验证命令和测试数量以仓库脚本与项目 Profile 为准，不在本页维护静态统计。