在前端开发过程中，验证用户输入的合法性是非常常见的一个功能。而 npm 上已经有很多成熟的验证框架了，比如 joi、validator.js 等等。但是，如果想要更好的控制验证过程，需要一个轻量、灵活、易用的 npm 包，这时就可以使用 consultation-verification。
什么是 consultation-verification
consultation-verification 是一个基于 JavaScript 的轻量级验证库，可以帮助开发者在前端中快速地验证用户输入的内容。它的特点是对验证规则的定义非常灵活，可以支持各种自定义的规则，非常适合需要定制化的验证场景。
安装
在使用之前，需要先安装 consultation-verification，可以通过以下命令进行安装：
npm install consultation-verification
使用
定义验证规则
在开始使用 consultation-verification 之前，需要定义验证规则。验证规则是一个 JavaScript 对象，其中包含了各个需要验证的字段以及对应的验证规则。下面是一个简单的示例：
-- -------------------- ---- ------- ----- ----- - - --------- - - ----- ----------- -------- -------- -- - ----- --------- ---- -- ---- --- -------- --------------- -- - ----- ----------------- -------- ----------------- -- -- --------- -- ----- ----------- -------- ------- --- ---------------- - - ----- ----------- -------- --------- -- - ----- -------- ------ ----------- -------- ----------- -- -- ------ -- ----- -------- -------- --------- --- --展开代码
在上面的示例中，定义了四个字段的验证规则，其中：
username 验证规则：
- 必填项（required）
- 长度限制为 6-20 个字符（length）
- 只能包含字母、数字、下划线（usernameFormat）
password 验证规则：
- 必填项（required）
confirmPassword 验证规则：
- 必填项（required）
- 与 password 字段匹配（match）
email 验证规则：
- 必须是邮箱格式（email）
可以看出，验证规则的定义非常灵活，满足了各种不同的定制化需求。
创建 Validator 实例
在定义好验证规则之后，需要创建 Validator 实例，并将验证规则作为参数传递进去：
const validator = new Validator(rules);
Validator 实例完成后，就可以开始使用它的各种验证方法了。
验证方法
Validator 实例有多种验证方法，可以根据需求进行使用。
validate
validate 方法是最常用的验证方法，可以根据传入的表单数据进行整体验证。如果有错误，就将错误信息保存在 errors 对象中。
下面是一个示例代码：
-- -------------------- ---- ------- ----- ---- - - --------- ---------- --------- --------- ---------------- -------- ------ --------------- -- ----- ------ - ------------------------- -- ----------------- - --------------------------- -展开代码
在上面的示例中，首先定义了一个表单对象 data，然后调用 Validator 实例的 validate 方法进行验证。如果验证不通过，就可以通过 result.errors 查看错误信息。
validateField
validateField 方法是对单个字段进行验证，如果有错误，就将错误信息保存在 fieldsErrors 对象中。
下面是一个示例代码：
const result = validator.validateField("username", "test"); if (!result.isValid) { console.log(result.fieldsErrors.username); }
在上面的示例中，只对 username 字段进行验证，并查看错误信息。
自定义验证方法
除了常见的验证方法之外，还可以自定义验证方法，以支持更灵活的定制化需求。
例如，下面是一个自定义验证方法，用于验证一个输入文本是否包含指定的字符串：
-- -------------------- ---- ------- ------------------------ ---------- ------- -------------- -- --------- --- ------------------ ------- -------------- -- - -- -------------------------------- - ------ ------ - ------ ----- - --展开代码
在上面的代码中，addCustomRule 方法定义了一个名为 include 的验证规则，它需要接受两个参数：
value：需要验证的值includeString：需要包含的字符串
而第二个参数是一个函数，用于判断规则是否通过。
定义完自定义规则之后，就可以在验证对象中使用了：
-- -------------------- ---- ------- ----- ----- - - ----- -- ----- ---------- ------ -------- -------- ----- ------ --- -- ----- --------- - --- ----------------- ----- ------ - ------------------------------- --------- -- ----------------- - -------------------------------------- -展开代码
上面的示例中，在验证规则中应用了自定义规则 include，判断 name 字段是否包含字符串 hello。
总结
通过上面的介绍和示例代码，我们了解了 npm 包 consultation-verification 的使用方法和特性。如果在开发过程中需要对用户输入进行更细致的验证，可以考虑使用这个灵活、易用的验证库。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600557d981e8991b448d4e58
