npm 包 kestryl 使用教程

什么是 kestryl

kestryl 是一款前端的轻量级表单验证库，它基于正则表达式，提供了一系列常见的验证规则，包括邮箱、手机号码、身份证号码、URL 地址等等。同时，它也支持自定义规则，方便开发者扩展自己的验证模块。

安装 kestryl

使用 npm 进行安装：

npm install kestryl --save

基本使用

kestryl 提供了一个 Validator 类，我们可以通过创建一个实例来进行验证。

在浏览器端，可以按照如下方式引入 kestryl：

<script src="path/to/kestryl/kestryl.min.js"></script>

然后，我们就可以调用 Validator 类的静态方法 isValid 进行验证了。例如，下面的代码可以判断一个字符串是否为合法的手机号码：

let phone = '13112345678';
let isValid = Validator.isValid(phone, 'phone');
console.log(isValid); // true

这里用到了 isValid 方法，它接受两个参数：待验证的字符串和验证规则名称。kestryl 内置的验证规则有：

• required：必填项
• email：邮箱
• phone：手机号码
• password：密码（6-16 位，必须同时包含数字和字母）
• url：URL 地址
• idCard：身份证号码

如果需要自定义规则，可以使用 addRule 方法：

Validator.addRule('zip', /\d{6}/, '请输入正确的邮政编码');

其中，addRule 方法接受三个参数：规则名称，正则表达式，和错误提示信息。上面的代码添加了一个名为 zip 的验证规则，用来判断邮政编码是否合法。

然后，我们就可以使用 isValid 方法进行验证了：

let zipCode = '100000';
let isValidZip = Validator.isValid(zipCode, 'zip');
console.log(isValidZip); // true

错误提示信息

Validator 类默认不会返回错误提示信息，而是返回一个 boolean 值，表示是否验证通过。如果需要提示信息，可以使用 getErrorMessage 方法：

let password = '12345';
let isValidPwd = Validator.isValid(password, 'password');
let errorMessage = isValidPwd ? '' : Validator.getErrorMessage('password');
console.log(errorMessage); // '请输入符合要求的密码'

总结

以上就是 kestryl 的基本使用方法。它是一款轻量级的验证库，可以满足前端常用的表单验证需求，同时也支持自定义扩展。使用它可以提高表单验证的效率和准确性，值得推荐。

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