npm 是 Node.js 的包管理器，提供了丰富多彩的开源包和工具来支撑前端开发，其中包括了一款叫做 legitimize 的 npm 包。如其名，legitimize 能够让开发者对输入的字符串进行验证，从而确保其合法性。本篇文章将详细介绍如何使用这款 npm 包。
安装
首先，我们需要安装 legitimize。可以在终端中输入以下命令进行安装：
--- ------- ----------
安装完成后，我们就可以引入 legitimize：
----- ---------- - ----------------------
API
legitimize(input, rule, options)
legitimize 的主要方法是 legitimize(input, rule, options)。
该方法接受三个参数：
input：要验证的字符串，如"example@example.com"。rule：验证规则，如"required|email"。options（可选）：选项对象，包括验证错误信息和其他配置项。
比如：
--------------------------------- ----------------- - ---------------- ------- ----- -- ----- ---------- ------------- ------- ----- - ----- ----- --------- ---
对于验证规则，legitimize 支持使用管道符号 | 进行多条验证。
下面是一些常见的验证规则：
| 规则 | 描述 |
|---|---|
required |
字符串不能为空或全为空格 |
email |
字符串必须是合法的电子邮件地址 |
url |
字符串必须是合法的 URL |
alpha |
字符串必须只包含字母 |
alphaNumeric |
字符串必须只包含字母和数字 |
numeric |
字符串必须只包含数字 |
decimal |
字符串必须只包含数字和小数点 |
hex |
字符串必须只包含十六进制数字 |
同时，我们也可以使用 regex 规则自定义正则表达式进行验证：
----------------------- --------------------------------------------------- - ------------- --------- ---- ------- -- ----- --- --------- ------- --- --------- ------- --- --- ------- ---
选项
legitimize 的第三个参数 options 是可选的，用于配置验证错误信息和其他选项。
常见的选项有：
requiredMessage：验证失败时，字符串必填的错误信息。emailMessage：验证失败时，字符串必须是合法的电子邮件地址的错误信息。urlMessage：验证失败时，字符串必须是合法的 URL 的错误信息。alphaMessage：验证失败时，字符串必须只包含字母的错误信息。alphaNumericMessage：验证失败时，字符串必须只包含字母和数字的错误信息。numericMessage：验证失败时，字符串必须只包含数字的错误信息。decimalMessage：验证失败时，字符串必须只包含数字和小数点的错误信息。hexMessage：验证失败时，字符串必须只包含十六进制数字的错误信息。regexMessage：验证失败时，自定义正则表达式的错误信息。
异步验证
有时候，我们需要进行异步验证，比如验证邮箱是否已经被注册过。在这种情况下，可以使用 asyncRule：
--------------------------------- ----------------------- -
----------- ----- ------- -- -
----- -------- - ----- --------------------------
-- ---------- -
----- --- ------------ ------- ----------
-
-
---其中，checkIfEmailExists 是一个异步方法，用于检查邮箱是否已经被注册过。我们将该方法作为 asyncRule 的值传递给 legitimize，并在选项中进行配置。
示例
下面是使用 legitimize 进行表单验证的示例：
----- ---------- - ----------------------
----- ------------ - ---------- -- -
----- ------ - ---
-------------------------- ----------------- -
---------------- ------- ----- -- ----- ----------
------------- ------- ----- - ----- ----- ---------
---------------- -- -
------------ - --------------
---
----------------------------- ----------------------- -
---------------- ------- ----- - -----------
----------------- --------- ---- ------- -- ----- - ------------
---------------- -- -
--------------- - --------------
---
-- ------------------ --- ------------------------- -
---------------------- - ---------- -- --- --------
-
-- --------------------------- - -- -
----- -------
-
------ -----
--该示例中，使用 legitimize 进行了邮箱和密码的验证。其中，密码还要求长度为至少 6 个字符，并且进行了确认密码的比对。最终通过抛出一个包含错误信息的对象进行统一返回。
总结
本文介绍了 legitimize 的安装、使用方法，并详细讲解了 legitimize 的 API 和一些常见的验证规则。同时，还介绍了 legitimize 的选项和异步验证的使用方式，并给出了一个实际的表单验证的示例。希望能为前端开发者提供一些参考和帮助。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/73972