SuperAPI AI 工具集

arktype-validation

编程与开发

查看项目

更新于 10-16 02:35

技能介绍

用途:ArkType 是 TypeScript 原生的运行时校验库,用镜像 TypeScript 语法的字符串表达式定义 schema,适合构建类型安全 API、校验 JSON 载荷,或作为更贴近 TypeScript 习惯的 Zod 替代方案。

主要能力:支持 type({ key: "string" }) 定义对象、type("string") 定义原始类型;内置 string.email、string.url 等字符串校验器,string.trim、string.lower 等变形(morph);支持 "string.json.parse" 解析 JSON、"number > 0" 内联约束、"string | number" 联合、"'a' | 'b'" 字面量联合、"string[]" 数组、"key?" 可选属性、"key = 'default'" 默认值;提供 .pipe()/.to() 变形、.narrow() 自定义校验、.pick()/.omit()/.merge() 对象操作、scope({...}).export() 命名作用域与交叉引用、type("<t>", {...}) 泛型、type.errors 错误处理、.assert() 抛错、"(number % 2)#even" 品牌标记、"0 <= number <= 100" 范围约束、configure() 全局默认、match() 模式匹配、"+": "reject" 未声明键处理。ArkEnv 提供 arkenv({ PORT: "number" }) 环境变量校验与 arkenvVitePlugin(Env) 构建期校验。

使用方式:从 "arktype" 导入 type 与 scope;错误用 instanceof type.errors 判断,而非 === null;可选属性写作 { "key?": "string" };跨引用类型用 scope() 而非嵌套 type();可能抛错的操作使用 .pipe.try();大小写变形用 string.lower/string.upper;配置需在导入 arktype 前先导入 arktype/config;环境变量用 arkenv() 自动转换与校验。

适用场景:类型安全 API、JSON 载荷校验、表单校验、API 响应校验、环境变量校验。

限制:不适合需要 Zod 生态兼容或 JSON Schema 输出的项目;Zod 相关校验应改用 zod-validation。具体收费、价格与平台信息暂未提供。