npm 包 willcheck 使用教程

前言

在前端开发中，输入校验是一个非常重要的内容。我们需要保证用户输入的数据格式正确，否则会导致系统出现错误，严重情况下还会违反相关法律法规。因此，输入校验功能是我们日常开发中必须掌握的内容。

随着 JavaScript 社区的发展，出现了各种输入校验的库和工具。今天，我要介绍的是一个名为 willcheck 的 npm 包。它是一个简单、易用的输入校验库，可以大大减少我们开发的工作量。

什么是 willcheck

willcheck 是一个基于 正则表达式 的输入校验库，它具有以下特点：

• 支持常用的输入校验规则，如电子邮箱、手机号码、身份证号码等。
• 可以通过链式调用实现多个校验规则同时检查。
• 提供了非常友好的错误提示信息。

安装 willcheck 的方式非常简单，你只需要在命令行中执行以下命令即可：

npm install willcheck --save

安装完成后，你就可以在项目中使用 willcheck 了。

使用 willcheck 进行输入校验

在使用 willcheck 进行输入校验时，你需要做以下几个步骤：

1. 引入 willcheck 库。

const willcheck = require('willcheck');

1. 实例化 willcheck。

const validator = willcheck();

1. 定义校验规则。

validator.isEmail();
validator.isMobilePhone();

1. 执行校验。

const result = validator.check('example@gmail.com');

1. 处理校验结果。

if (result) {
  console.log('输入正确');
} else {
  console.log('输入有误');
}

willcheck 的常见规则

isEmail

检查输入是否为合法的电子邮箱地址。

const result = validator.isEmail().check('example@gmail.com');

isMobilePhone

检查输入是否为合法的手机号码。

const result = validator.isMobilePhone().check('13912345678');

isIDCard

检查输入是否为合法的身份证号码。

const result = validator.isIDCard().check('110101190001011234');

isURL

检查输入是否为合法的 URL 地址。

const result = validator.isURL().check('https://www.google.com');

isInt

检查输入是否为整数。

const result = validator.isInt().check('123');

处理校验结果

willcheck 检查输入结果后，会返回一个布尔值。如果输入符合规则，则返回 true，否则返回 false。但是，在实际开发中，我们往往需要对输入校验结果进行更多的处理。willcheck 也提供了一些接口来实现这些功能：

getError

获取校验失败的第一条错误信息。

validator.isEmail().isIDCard().check('example@gmail.com');
const error = validator.getError();
console.log(error); //输出："身份证号码必须为合法身份证号码"

getErrors

获取所有的校验失败信息。

validator.isEmail().isIDCard().check('example@gmail.com');
const errors = validator.getErrors();
console.log(errors); //输出：["身份证号码必须为合法身份证号码"]

总结

willcheck 是一个简单易用的输入校验库，它能够大大减少我们开发的工作量。在实际开发中，我们应当选择合适的输入校验工具，保证用户输入的数据格式正确，从而提高系统的稳定性。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006710f8dd3466f61ffe255