npm 包 node-error-for-humans 使用教程

在开发中使用 Node.js 时，经常会遇到错误信息。然而，错误信息通常是针对机器人显示的，很难理解，尤其对于新手而言。为了解决这一问题，npm 包 node-error-for-humans 应运而生。

node-error-for-humans 是一个 Node.js 模块，可以将系统和自定义错误转换为可读性更好的字符串格式，这样开发人员可以轻松地理解错误信息。以下是 node-error-for-humans 的使用教程。

第一步：安装

安装 node-error-for-humans 非常简单，只需要在终端运行以下命令即可：

npm install node-error-for-humans

第二步：使用

在安装完 node-error-for-humans 后，您需要将其导入到您的 Node.js 项目中。然后，您可以将错误对象传递给 getErrorString 函数，以获得更易读的错误消息。以下是示例代码：

const nodeErrorForHumans = require('node-error-for-humans');

try {
    // 代码发生错误时抛出异常
} catch (error) {
    console.log(nodeErrorForHumans.getErrorString(error));
}

上面的代码块中，我们使用 try...catch 语句捕获代码中的异常，并将错误对象传递给 getErrorString 函数。

第三步：添加自定义错误

您还可以使用 node-error-for-humans 来将自定义错误转换为可读性更好的格式。节点错误对象必须包括 statusCode 和 message 属性。例如：

const nodeErrorForHumans = require('node-error-for-humans');

const myCustomError = {
    statusCode: 400,
    message: 'Bad request.',
};

console.log(nodeErrorForHumans.getErrorString(myCustomError));

上述代码会将自定义错误转换为以下可读性更好的字符串格式：

StatusCode: 400
Message: Bad request.

结论

npm 包 node-error-for-humans 使开发人员能够更好地理解系统和自定义错误，从而更好地修复错误。在使用时，只需要安装模块，将其导入到您的项目中，并将错误对象传递给 getErrorString 函数即可。这个工具对于初学者来说尤其有意义，因为他们经常难以理解繁琐的错误信息。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005560181e8991b448d300f