0.5.0 • Published 3 years ago
@domain.js/schema v0.5.0
@domain.js/schema
Installation
cnf
专有配置信息 schema
名称 | 类型 | 必填 | 默认值 | 描述 | 样例 |
---|---|---|---|---|---|
coerceTypes | boolean | 否 | false | 是否尝试转换类型 | true |
useDefaults | boolean | 否 | false | 是否启用默认值 | true |
removeAdditional | boolean | 否 | false | 是否删除未定义的数据,会修改元数据 | true |
deps
Usage
功能 | 描述 | 样例 |
---|---|---|
auto | 封装一个函数,让其拥有自动执行参数格式校验的能力 | schema.auto(fn, jsonSchema, errorFn, extra) |
validate | 验证一个数据是否与指定的 schema 设定匹配 | schema.validate(jsonSchema, data) |
compile | 返回一个基于shema定义的验证器函数 | schema.compile(jsonSchema) |
ajv | 返回一个 Ajv 实例 | new Ajv() 的结果 |