parameter-schema

English / 中文

因为调用 API 时，由于传的参数嵌套过于复杂，并受 Zod and raml-typesystem 启发，故创建了本库。

本库用于检验函数参数的合法性，支持对 string, number, boolean, object 以及他们相应的数组参数进行检验。

使用方法

$3

ESModule 方式
``typescript
import { Schema } from 'parameter-schema';
`

CommonJS 方式
`typescript
const { Schema } = require('parameter-schema');
`


$3

#### string 类型的参数

`typescript
const schema = Schema.string(); // 做最简单检验，检验是不是一个字符串
/**
* 可以设置一个默认值，检验 null 或 undefined 值时，将使用默认值作为输出结果
* schema.setDefault('test');
*/
/**
* 可以设置一个字符串的可选范围
* schema.setRange(['test', 'foo', 'bar']):
*/
/**
* 也可以设置自定义的检验函数
* schema.setValidate((param: unknown): boolean => {
* return /(test|foo|bar)/i.test();
* });
*/
const [ isValid, result ] = schema.validate('test');
console.log(isValid, result); // 输出 true "test"
`

#### string 数组类型的参数

`typescript
const schema = Schema.stringArray(); // 做最简单检验，检验是不是一个字符串数组
const [ isValid, result ] = schema.validate(['test']);
console.log(isValid, result); // 输出 true ["test"]
`

#### number 类型的参数

`typescript
const schema = Schema.number(); // 做最简单的检验，检验是不是一个数字，并不小于默认的最小值 0
/**
* 设置一个最小值及最大值
* schema.setMix(0).setMax(2);
*/
/**
* 可以设置一个可选数的范围
* schema.setRange([0, 1, 2]):
*/
/**
* 也可以设置自定义的验证函数
* schema.setValidate((param: unknown): boolean => {
* return [0, 1, 2].includes(param);
* });
*/
const [ isValid, result ] = schema.validate(0);
console.log(isValid, result); // 输出 true 0
`
#### number 数组类型的参数

`typescript
const schema = Schema.numberArray(); // 做最简单检验，检验是不是一个数字数组，并且数组中的每一项都不小于默认的最小值 0
const [ isValid, result ] = schema.validate([1, 2, 3]);
console.log(isValid, result); // 输出 true [1, 2, 3]
`

$3

`typescript
const schema = Schema.boolean(); // 做最简单检验，检验是不是一个布尔值
const [ isValid, result ] = schema.validate(true);
console.log(isValid, result); // 输出 true true
`

#### boolean 数组类型的参数

`typescript
const schema = Schema.booleanArray(); // 做最简单检验，检验是不是一个布尔数组
const [ isValid, result ] = schema.validate([1, 2, 3]);
console.log(isValid, result); // 输出 true [1, 2, 3]
`

#### object 类型的参数

`typescript
const schema = Schema.object().setFieldSchemas({
foo: Schema.string(),
bar: Schema.number(),
test: Schema.boolean().setDefault(true),
}); // 验证传入的参数是不是 object，并且每个属性都能通过对应 Schema 的检验
const [ isValid, result ] = schema.validate({ foo: 'foo', bar: 1 });
console.log(isValid, result); // 输出 true {foo: "foo", bar: 1, test: true}
`

`typescript
// 注，未设置对应 Schema 的属性在输出中将被忽略，如：
const [ isValid, result ] = schema.validate({foo: 'foo', bar: 1, baz: false});
console.log(isValid, result); // 输出 true {foo: "foo", bar: 1, test: true}
`

#### object 数组类型的参数

`typescript
const schema = Schema.objectArray().setSchema(
Schema.object().setFieldSchema({
foo: Schema.string(),
bar: Schema.number(),
}),
); // 验证传入的参数是不是数组，并且数组中每一项都为 object，且都能通过设置的 Schema 的检验
const [ isValid, result ] = schema.validate([{foo: 'foo', bar: 1, test: true}]);
console.log(isValid, result); // 输出 true {foo: "foo", bar: 1}
`

#### array （纯数组）类型的参数

`typescript
const schema = Schema.array().setSchemas([
Schema.number().setRange([1, 2, 3]),
Schema.object().setFieldSchemas({
foo: Schema.string(),
bar: Schema.number(),
}),
]); // 验证传入的参数是不是数组，并且数组中每一项都能通过设置的 Schema 数组中某一个 Schema 的检验
const [ isValid, result ] = schema.validate([{foo: 'foo', bar: 1, test: true}]);
console.log(isValid, result); // 输出 true [{foo: "foo", bar: 1}]
`

`typescript
// 还如
const [ isValid, result ] = schema.validate([1, {foo: 'foo', bar: 1, test: true}, 2]);
console.log(isValid, result); // 输出 true [1, {foo: "foo", bar: 1}, 2]
``

API

更多 API 说明，请查看 Docs