npm 包 @mojotech/json-type-validation 使用教程

阅读时长 5 分钟读完

前言

在前端开发中,经常需要对后端返回的数据进行类型验证。为了方便开发者进行这一项任务,MojoTech 开发了一款npm包@mojotech/json-type-validation。该包可以用于对JSON对象进行类型验证,支持多种数据类型,使用非常方便。

安装

在命令行中输入以下命令安装该包:

使用方法

引入

在需要使用的模块中引入该包:

初始化

创建一个验证规则:

规则中以键值对的形式定义JSON对象中的每一个属性的类型。

验证

对JSON对象进行验证:

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

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

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

validate方法的第一个参数为要验证的JSON对象,第二个参数为验证规则。方法会返回一个包含isValid和message属性的对象,其中isValid属性表示验证结果是否通过,message属性为失败时的错误信息。

支持的数据类型

该工具包支持验证的数据类型包括:

  • String
  • Number
  • Boolean
  • Object
  • Array

特殊情况处理

当需要验证的值为Null或Undefined时,需要分别使用isNullable和isUndefined属性。

比如:

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

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

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

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

示例代码

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

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

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

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

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

结语

本文介绍了MojoTech开发的npm包@mojotech/json-type-validation的使用方法,该包可以方便地对JSON对象进行类型验证。使用该包可以大大简化开发者的工作量,提高开发效率。

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