{"bugs":{"url":"https://github.com/PengJiyuan/b-validate/issues"},"dist":{"shasum":"5b7d65e7f3a41660f6ddf032c6fc051c15788dc3","tarball":"https://registry.npmjs.org/b-validate/-/b-validate-1.4.0-beta.2.tgz","fileCount":19,"integrity":"sha512-BP0nNv/E62RPPIav7mAferJzjcuVwnuBiCAD/6KxmXTESMCcmCIcerHMebTLqtH80gQ/s8c5UZIkUdncL1RfIQ==","signatures":[{"sig":"MEYCIQDeVXtvLbhCwIYbuh4vo6PvQtjnceCqAp0ilfITJH0bGQIhAKY3yIkyZodQ5UesKtkIWU2Ny3+duViBVUA8VyJdpNkX","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":85126,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiWScaACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrM8w/9HaQxE1pIU+35UGbNw45D6ZUFcl+IRo7l0cbZt/znB4EErWLo\r\nwrbYviaawLEDZlwwF/1Ye5GcQIvJpXFZq90BjANnDWA826g+1fRyE3jzvwhN\r\nfzKWmRHJPqifvYb8il2O2tCLLkXm3aFEiVPdbNDAgjiFhfelEZ73s5+0DEum\r\nCZdAL6DgXVauFuHmc9KKD/WbZMEijTyHZJNEY4kUKCKz9VqioqFTHB1cpRId\r\nCT+nRhsHyPQaWXuta23+0wufNETy9L29PNrBPt8w8jFDCNWDtNpfV5rXJzKU\r\nLb+etMQiTu/o/yF50VUiW7jI5v7IdQWcJ0sdLPq85D/sw9DDIDOek0E8RixQ\r\n/qoZUT1RkwMLqN5k/eBMznTgdz7dsMYhvwHkjCgiSdyY2WFks3eEVLQNM+jT\r\nvZ3OiWmd6hq7ltTOItWSCNtRWvj2c40788pdGclXQVVh+uSlQM/JSYAOOVyN\r\nN5w/SifIHejOEMcx6pvwBIR81Yz0a2QdP11jASDPXcxQ2TUzvckrHZAy93Ll\r\n7O+BVSWohduBm8/4FjOuFozCVJCgtd48VdsGRWhzSb9zKJdFP1Uc2ip/5XHr\r\nGkLh4kOZl5L8TujwUumJVXHGqrG51lE3PRIbbzlfqig0ifiy2GObxjJjdSr3\r\njJ8MVQjcPcg64CuHakBPxwdJ4rZs0QTZCD4=\r\n=KdYS\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./dist/b-validate.cjs.js","name":"b-validate","author":{"name":"PengJiyuan"},"module":"./es/index.js","readme":"[![Travis](https://img.shields.io/travis/PengJiyuan/b-validate.svg)](https://travis-ci.org/PengJiyuan/b-validate)\n[![npm](https://img.shields.io/npm/v/b-validate.svg)](https://www.npmjs.com/package/b-validate)\n[![npm](https://img.shields.io/npm/l/b-validate.svg)](https://www.npmjs.com/package/b-validate)\n[![codecov.io](https://codecov.io/github/PengJiyuan/b-validate/coverage.svg?branch=master)](https://codecov.io/github/PengJiyuan/b-validate?branch=master)\n\n# b-validate\nJavascript type validate.\n\n## Highlight\n\n* chainable api\n* support custom validator\n* support schema validate\n* support async validate\n\n## Usage\n\n```bash\nnpm i b-validate\n```\n\n```js\nimport bv from 'b-validate';\n\nbv(123)\n  .number\n  .min(2)\n  .max(10)\n  .collect((error) => {\n    console.log(error); // { value: 123, type: 'number', message: '123 is not less than 10' }\n    // if no error, error equal to null\n  });\n\n// or get error message like this:\n\nconst error = bv('b-validate').string.isRequired.match(/Validator/).end;\n// { value: 'b-validate', type: 'string', message: '`b-validate` is not match pattern /Validator/' }\n```\n\n### Schema\n\n```js\nimport { Schema } from 'b-validate';\n\nconst schema = new Schema({\n  name: [{\n    type: 'string',\n    required: true,\n    message: '必填字段'\n  }, {\n    type: 'string',\n    maxLength: 10,\n    message: '最大长度是10'\n  }],\n  age: [{\n    type: 'number',\n    min: 2,\n    max: 5,\n    message: '在2和5之间'\n  }],\n  email: [{\n    type: 'email',\n    message: '邮箱格式不对'\n  }],\n  ip: [{\n    type: 'ip',\n    message: 'ip格式不对'\n  }],\n  url: [{\n    type: 'url',\n    message: 'url格式不对'\n  }],\n  custom: [{\n    validator: (value, callback) => {\n      if (value > 10) {\n        callback('不能大于10！');\n      }\n    }\n  }],\n  // Async validate\n  async: [{\n    validator: async (value, callback) => {\n      if (value > 10) {\n        callback('不能大于10！');\n      }\n    }\n  }]\n});\n\nschema.validate({\n  name: 'pengjiyuan is a nice boy',\n  age: 24,\n  email: 'pengjiyuan@bytedance.com',\n  ip: '127.0.0.1',\n  url: 'https://bytedancecom',\n  custom: 20,\n  async: 20\n}, (errors) => {\n  console.log(errors);\n  /*\n   * {\n   *  value: 'pengjiyuan is a nice boy', type: 'string', message: '最大长度是10' },\n   *  age: { value: 24, type: 'number', message: '在2和5之间' },\n   *  url: { value: 'https://bytedancecom', type: 'url', message: 'url格式不对' },\n   *  custom: { value: 20, type: 'custom', message: '不能大于10！' }\n   * }\n   */\n});\n```\n\n### validate messages\n\n```\nimport bv from 'b-validate';\n\nconst error = bv('', {validateMessages: {required: '必须有值'}}).string.isRequired.end.message;\n// output: 必须有值\n```\n\n## Api\n\n### String\n\n#### .maxLength(length: number)\n\nValidate string's max length.\n\n#### .minLength(length: number)\n\nValidate string's min length.\n\n#### .length(length: number)\n\nValidate string's length\n\n#### .match(pattern: regexPattern)\n\nValidate whether string is match regex pattern.\n\n#### .uppercase\n\nValidate whether string is uppercase.\n\n#### .lowercase\n\nValidate whether string is lowercase.\n\n#### Demo\n\n```js\nbv('vvvv').string.isRequired.minLength(2).maxLength(10).lowercase.end; // pass\n```\n\n### Number\n\n#### .min(num: number)\n\nMinimum value.\n\n#### .max(num: number)\n\nMaximum value.\n\n#### .equal(num: number)\n\nEqual to number.\n\n#### .range(min: number, max: number)\n\nIn range min ~ max.\n\n#### .positive\n\nIs it a positive number?\n\n#### .negative\n\nIs it a negative number?\n\n#### Demo\n\n```js\nbv(123).number.min(2).max(250).positive.end; // pass\n```\n\n### Array\n\n#### .length(length: number)\n\nValidate array's length\n\n#### .includes(arrays: any[])\n\nWhether array includes some array.\n\n#### .deepEqual(other: any[])\n\nDeep equal to other array\n\n#### Demo\n\n```js\nbv([1, 2, 3]).array.length(3).includes([1, 2]).deepEqual([1, 2, 3]).end; // pass\n```\n\n### Object\n\n#### .hasKeys(keys: string[])\n\nObject has some keys?\n\n#### .deepEqual(obj: object)\n\nDeep equal to other object.\n\n#### .empty\n\nEmpty object.\n\n#### Demo\n\n```js\nbv({a: 1, b: 2}).object.hasKeys(['a', 'b']).deepEqual({a: 1, b: 2}).not.empty.end; // pass\n```\n\n### Type\n\n#### .email\n\n```js\nbv('abc@qq.com').type.email.end; // pass\n```\n\n#### .url\n\n```js\nbv('https://baidu.com').type.url.end; // pass\n```\n\n#### .ip\n\n```js\nbv('127.0.0.1').type.ip.end; // pass\n```\n\n### Custom validator\n\n```js\nbv('xxxxxx').custom.validate((value, callback) => {\n  if (value !== 'x') {\n    callback(`Expect x but got ${value}`);\n  }\n}, (error) => {\n  console.log(error); // { value: 'xxxxxx', type: 'string', message: 'Expect x but got xxxxxx' }\n});\n```\n\n### Async validate\n\n```js\nbv('xxxxxx').custom.validate(async (value, callback) => {\n  const apiValue = api.getValue();\n  if (value !== apiValue) {\n    callback(`Expect x but got ${apiValue}`);\n  }\n}, (error) => {\n  console.log(error);\n});\n```\n\n## LICENSE\n\n[MIT](./LICENSE) © [PengJiyuan](https://github.com/PengJiyuan)\n","gitHead":"43d6fb683ba445c05d3d10cb0c6a2b182614d213","license":"MIT","scripts":{"test":"npm run build:es && jest","build":"npm run build:es & npm run build:dist ","dev-es":"rollup -c -w","dev-cjs":"rollup -c -f cjs -o ./dist/b-validate.cjs.js -w","build:es":"rm -rf es/* && BUILD_TYPE=es rollup -c","build:dist":"rm -rf dist/*  && BUILD_TYPE=dist rollup -c ","prepublishOnly":"npm run build"},"_npmUser":{"name":"yinkaihui","email":"yinkaihui0828@163.com"},"homepage":"https://github.com/PengJiyuan/b-validate#readme","keywords":["validate","type"],"repository":{"url":"git+https://github.com/PengJiyuan/b-validate.git","type":"git"},"_npmVersion":"6.14.15","description":"Javascript type validate","directories":{},"maintainers":[{"name":"pjy","email":"731401082@qq.com"},{"name":"yinkaihui","email":"yinkaihui0828@163.com"}],"_nodeVersion":"14.17.6","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^24.5.0","tslib":"^2.3.1","rollup":"^1.6.0","babel-jest":"^24.5.0","typescript":"^4.6.3","@babel/preset-env":"^7.3.4","rollup-plugin-buble":"^0.19.6","rollup-plugin-commonjs":"^10.1.0","rollup-plugin-typescript":"^1.0.1","@rollup/plugin-typescript":"^8.3.1","rollup-plugin-node-resolve":"^5.2.0"},"_npmOperationalInternal":{"tmp":"tmp/b-validate_1.4.0-beta.2_1650009882579_0.6872549301477842","host":"s3://npm-registry-packages"},"_id":"b-validate@1.4.0-beta.2","version":"1.4.0-beta.2"}