@wolfx/struct

用于校验格式，主要用于 nodejs 接口校验

安装

npm i @wolfx/struct --save

使用

const Struct = require("@wolfx/struct").default;
// 或 import Struct from "@wolfx/struct"

// 创建校验规则，以下是针对name,age,isStudent,sex,tags进行校验
const userStruct = new Struct({
  name: {
    require: true,
    msg: "用户名称为必填，且长度必须是2-3", // 如果校验失败会返回这个提示
    type: "string",
    maxLength: 3,
    minLength: 2
  },
  age: {
    msg: "age必须是数字",
    type: "number" // 'object' | 'number' | 'array' | 'string' | 'boolean'
  },
  isStudent: {
    type: "boolean"
  },
  sex: {
    msg: "必须是男",
    validator: function(v) {
      return v === "男"; // 返回 true 则表示校验通过
    }
  },
  tags: {
    msg: "tags必须是数组",
    type: "array" // 'object' | 'number' | 'array' | 'string' | 'boolean'
  }
});

// 对子对象创建校验规则
const tagStruct = new Struct({
  tagName: {
    type: "string"
  }
});

// 你的数据对象
const user = {
  name: "AA",
  sex: "男",
  age: 10,
  isStudent: "",
  tags: [
    {
      tagName: "AAA"
    },
    {
      tagName: "BBB"
    }
  ]
};

// 校验对象
console.log(userStruct.validate(user));
// 默认只校验第一层结构，如果要校验子对象，需要如下处理：
for (let i = 0; i < user.tags.length; i++) {
  console.log(tagStruct.validate(user.tags[i]));
}