什么是 enforce-js
enforce-js 是一个用于验证输入和输出值的库。它可以让你定义一个 schema 来约束数据的类型和格式，并在运行时对数据进行验证。
安装
enforce-js 是一个 npm 包，可以使用 npm 或 yarn 进行安装：
npm install enforce-js
或
yarn add enforce-js
使用方法
导入
在你的 JavaScript 文件中导入 enforce-js：
const enforce = require('enforce-js');定义 schema
enforce-js 使用 JSON Schema 来定义 schema。
JSON Schema 是一个用于描述 JSON 数据结构的语言。它允许定义数据类型、枚举、正则表达式等。
以下是一个简单的 JSON Schema 示例：
{
"type": "object",
"required": ["name", "age"],
"properties": {
"name": {"type": "string"},
"age": {"type": "number"}
}
}这个 JSON Schema 描述了一个必须包含 name 和 age 字段的对象，其中 name 是字符串，age 是数字。
验证数据
使用 enforce 根据定义的 schema 来验证数据：
-- -------------------- ---- -------
----- ------ - -
----- ---------
--------- -------- -------
----------- -
----- - ----- -------- --
---- - ----- -------- --
--
--
----- --- - -
----- -------
---- ---
--
------------ --------在这个例子中，enforce 函数将 obj 和 schema 作为参数，将检查 obj 是否符合 schema。如果不符合，将抛出错误。
定义错误信息
你可以使用 enforce 函数的第三个参数来定义错误信息：
-- -------------------- ---- -------
----- ------ - -
----- ---------
--------- -------- -------
----------- -
----- - ----- -------- --
---- - ----- -------- --
--
--
----- --- - -
----- -------
---- -----
--
--- -
------------ ------- -
------------- -------
---------- -
------- --
--
---------- -------- --- -
------ --------- ------------- -- -- - -----------------
-
---
- ----- --- -
----------------------- -- -------- ---- -- -- - ------
-在这个例子中，enforce 函数的第三个参数是一个对象，其中包含三个字段：
- coercionMode: 设置强制类型转换的模式
- coercions: 设置强制类型转换的选项
- formatter: 设置错误信息的格式化函数
coerceMode
coerceMode 是强制类型转换的模式，有以下几种取值：
- none: 不进行强制类型转换，将抛出错误
- silent: 进行强制类型转换，但不会抛出错误
- strict: 进行强制类型转换，但会抛出错误
coercions
coercions 是强制类型转换的选项。它是一个对象，用于指定强制类型转换的规则和选项。
以下是 coercions 的示例：
-- -------------------- ---- -------
----- ------ - -
----- ---------
--------- -------- -------
----------- -
----- - ----- -------- --
---- - ----- -------- --
--
--
----- --- - -
----- -------
---- -----
--
------------ ------- -
------------- ---------
---------- -
------- - ----- -- -
--
---
--------------------- -- --在这个示例中，enforce 函数的第三个参数包含 coercions 字段。其中，string 是强制类型转换的类型，{ base: 10 } 表示将字符串转换为数字，使用十进制基数。
formatter
formatter 是一个函数，用于格式化错误信息。
以下是一个 formatter 的示例：
-- -------------------- ---- -------
----- ------ - -
----- ---------
--------- -------- -------
----------- -
----- - ----- -------- --
---- - ----- -------- --
--
--
----- --- - -
----- -------
---- -----
--
--- -
------------ ------- -
------------- -------
---------- -
------- --
--
---------- -------- --- -
------ --------- ------------- -- -- - -----------------
-
---
- ----- --- -
----------------------- -- -------- ---- -- -- - ------
-在这个示例中，formatter 函数接收一个参数 e，它是一个 JSON Schema 中的错误对象。
总结
enforce-js 是一个用于验证输入和输出值的库。它可以帮助你定义 schema 来约束数据的类型和格式，并在运行时对数据进行验证。enforce 函数提供了多种验证方式和格式化方式，为数据验证提供了更多的灵活性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066e25a563576b7b1ecee0