在前端开发中，使用现有的代码库和工具能够提高开发效率，NPM 又是目前最为流行的 Node.js 包管理器，很多优秀的工具和库都被发布在 NPM 上。其中 @ephox/dispute 是一款用于验证 JavaScript 对象格式的 NPM 包，该包支持验证对象的格式是否合法，根据错误信息进行错误提示等操作。本文章就详细介绍 @ephox/dispute 的使用方法。
安装
使用以下命令安装 @ephox/dispute
npm install @ephox/dispute
或者 yarn 方式安装
yarn add @ephox/dispute
基本用法
@ephox/dispute 提供两个主要的函数 validate 和 validateWithReporter，这两个函数都可以检验目标对象的格式是否符合预期，并返回 true 或者 false。
除了验证函数，@ephox/dispute 带有 report 函数，该函数可以将错误的详细信息输出到控制台。
下面是一个例子：
-- -------------------- ---- -------
------ - -------- - ---- ----------------
----- ------ - -
----- -------
---- -------
-------- ----------
----- -------
---- ------
--
-
----- ---- - -
----- --------
---- ---
-------- --
----- ------
---- --
--
-
----- ---- - -
----- --------
---- -----
-------- --
----- ------
---- ----
--
-
-------------------------- -------- -- ----
-------------------------- -------- -- -----高级用法
在实际应用中，我们可能需要根据不同的验证结果，采取不同的处理方式。这个时候可以使用 validateWithReporter 函数，并通过 reporter 回调函数处理错误信息。
下面是一个例子：
-- -------------------- ---- -------
------ - -------------------- - ---- ----------------
----- ------ - -
----- -------
---- -------
-------- ----------
----- -------
---- ------
--
-
----- ---- - -
----- --------
---- ---
-------- --
----- ------
---- --
--
-
----- ---- - -
----- --------
---- -----
-------- --
----- ------
---- ----
--
-
----- -------- - -------- -- -
-------------------
-- -------
-
-------------------------- ------- ---------在 reporter 回调函数中，issues 参数是一个数组，里面保存了所有出现错误的详细信息。
总结
@ephox/dispute 是一款非常有用的 NPM 包，它可以帮助开发人员在前期就发现代码中出现的格式错误，避免在项目后期出现大量难以修复的问题。同时，使用 @ephox/dispute 也可以帮助开发人员更好的理解和规范对象的传递。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedacdcb5cbfe1ea0610b66