npm 包 Valle 使用教程

阅读时长 5 分钟读完

介绍

Valle 是一个非常方便的 JavaScript 格式验证器。它可以帮助你定义你的 JavaScript 对象的格式,并且使得验证操作变得容易。Valle 不仅能够在浏览器中使用,也可以在 Node 环境下使用。你可以使用 npm 来安装 Valle。

安装

使用 npm 进行安装:

在你的代码里,你要引入 Valle:

基本语法

以下是一个简单的例子,使用 valle 来验证一个 JavaScript 对象:

-- -------------------- ---- -------
--- ------ - -
  --- - --------- ---- --
  ----- - --------- ---- --
  ------ -
    ------ ----
  -
--

--- ---- - -
  --- --
  ----- ---------
  ------ --------------------
--

--- ------ - ------------- ------
--------------------

-- --

在上面的例子中,我们定义了一个用户的对象,并且在定义了一个验证的 schema。我们将用户对象和 schema 作为参数传递给 valle 函数,并且得到了一个错误数组。因为我们的用户对象符合 schema 的规则,所以 errors 数组是空的。

规则

下面是 valle 可用的规则:

  • presence: 属性必须存在
  • length: 属性的长度必须属于某个区间内
  • numericality: 属性必须是数字
  • email: 属性必须是一个有效的电子邮件地址
  • url: 属性必须是一个有效的 URL 地址
  • format: 属性必须符合特定的自定义格式
  • inclusion: 属性必须属于某个枚举值集合中
  • exclusion: 属性不能属于某个枚举值集合中
  • equality: 属性必须等于特定值

实践案例

以下是一个更复杂的实践案例,使用 valle 来验证一个注册表单:

-- -------------------- ---- -------
--- ------ - -
  --------- -
    --------- -----
    ------- -
      -------- --
      -------- --
    -
  --
  --------- -
    --------- -----
    ------- -
      -------- -
    -
  --
  ---------------- -
    --------- -----
    --------- ----------
  --
  ------ -
    --------- -----
    ------ ----
  --
  ------ -
    ------- -
      -------- ---
      -------- --
    --
    ------- -
      -------- ----------------------------
      -------- ------------
    -
  --
  ---------- -
    --------- - -------- ------------ -
  -
--

--- ---- - -
  --------- ---------
  --------- -----------
  ---------------- -----------
  ------ ---------------------
  ------ --------------
  ---------- ----
--

--- ------ - ------------- ------
--------------------

-- --

在上面的例子中,我们定义了一个注册表单的对象,并且在定义了一个验证的 schema。我们将用户对象和 schema 作为参数传递给 valle 函数,并且得到了一个错误数组。因为我们的用户对象符合 schema 的规则,所以 errors 数组是空的。

如果我们修改一下用户对象,让它不符合 schema 的规则,那么我们就可以得到错误数组:

-- -------------------- ---- -------
--- ---- - -
  --------- -----
  --------- ----------
  ---------------- -----------
  ------ -----------------
  ------ ----------
  ---------- -----
--

--- ------ - ------------- ------
--------------------

-- -
--   --------- -- --- ----- -------- -- - -------------
--   --------- -- --- ----- -------- -- - -------------
--   ------ -- --- -- -------
--   ------ ------ ----- --- ------- ------ ----- --------
--   ----------  --- ---- -- ----- -- --- ----------
-- -

结语

Valle 是一个非常好用的 JavaScript 格式验证器。通过定义规则,我们可以轻松地验证 JavaScript 对象的格式。它非常适合用来验证表单数据等。希望这篇文章对你有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600562e081e8991b448e061b

纠错
反馈