简介
Chai 是一款 Node.js 的断言库，许多前端开发者都选择使用它来进行单元测试。其中，expect() 方法是 chai 提供的一种语义化的测试方式，可以方便地编写易读易懂的测试。除此之外，expect() 方法还有一个可选参数 explain，本文将重点介绍这个参数的作用及用法。
explain 参数的作用
explain 参数是在测试结果不符合预期时，提供更详细的错误信息，帮助开发者快速定位问题。默认情况下，当 expect() 方法断言失败时，chai 会返回类似以下的错误信息：
--------------- -------- - -- ----- -
这个错误信息就很简洁，不过有时候并不能提供足够的上下文信息，这时我们就可以使用 explain 参数来增加更多信息。当使用了 explain 参数时，错误信息会变为类似以下的格式：
--------------- -------- - -- ----- -
- -------- - ------
-
--
------------
--- -------- ------ ------ -- -- --- -- --- -------- --其中，Explanation 就是 explain 参数提供的信息，它会出现在错误信息的最后一行。
explain 参数的使用
可以在 expect() 方法中通过传入一个字符串来使用 explain 参数：
-- --- --------------------- ---- -------- ------ -- -----
上面的代码中，第二个参数 'The expected number is 2.' 就是 explain 的内容。当这个断言失败时，chai 会在错误信息最后一行附加这个字符串。
另外，如果不希望在测试中直接暴露错误信息，可以通过 chai.config.includeStack 属性来打开错误栈输出，如下：
-- --- ------------------------ - ----- --------------------------------------------
开启 includeStack 后，chai 会在命令行输出更详细的错误栈信息，包括错误信息和发生错误的代码位置。这种方式比直接在测试代码中暴露错误信息更加安全和可靠。
总结
使用 explain 参数可以为测试结果提供更加详细的上下文信息，有助于开发者快速定位代码问题。需要注意的是，不应该在测试代码中随意暴露敏感信息，应该尽量使用开启 includeStack 的方式来保证测试代码的安全性。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/646839aa968c7c53b086a2e5