Schemix

库 / SDKTypeScriptschema类型

工具介绍

Schemix 让你用一份 TypeScript 代码定义数据结构,自动导出为 TypeScript 类型、JSON Schema、Zod 校验器等多种产物。单一数据源,消除“类型定义与校验逻辑分裂”的常见痛点。

安装方式

npm install schemix

使用教学

  1. 定义 schema:用 defineSchema 描述字段与类型。
  2. 导出产物:调用 toType() / toZod() / toJsonSchema() 获取对应产物。
  3. 集成校验:在接口边界用导出的 Zod 校验器运行时校验数据。
import { defineSchema } from 'schemix';

const User = defineSchema((s) => ({
  id: s.string(),
  name: s.string(),
  age: s.number().optional(),
}));

注意事项

  • Schemix 生成的类型是工程产物,不要手改导出文件。
  • 导出产物前建议在 CI 加一次全量生成,避免提交过期产物。

安装

npm install schemix