← Back to rules

eslint/prefer-promise-reject-errors 风格

它的作用

要求在作为 Promise 拒绝原因时使用 Error 对象。

为什么这是不好的？

在 Promise 中，对于用户定义的错误，最佳实践是仅将内置 Error 对象的实例传递给 reject() 函数。Error 对象会自动存储堆栈跟踪信息，这有助于通过确定错误来源来调试问题。如果使用非 Error 值拒绝一个 Promise，就很难判断拒绝发生的位置。

示例

此规则的 错误 代码示例：

Promise.reject("something bad happened");

Promise.reject(5);

Promise.reject();

new Promise(function (resolve, reject) {
  reject("something bad happened");
});

new Promise(function (resolve, reject) {
  reject();
});

此规则的 正确 代码示例：

Promise.reject(new Error("something bad happened"));

Promise.reject(new TypeError("something bad happened"));

new Promise(function (resolve, reject) {
  reject(new Error("something bad happened"));
});

var foo = getUnknownValue();
Promise.reject(foo);

配置

此规则接受一个配置对象，包含以下属性：

allowEmptyReject

type: boolean

default: false

是否允许调用 Promise.reject() 时不传参数。

如何使用

要通过配置文件或 CLI 启用 此规则，可以使用：

配置文件 (.oxlintrc.json)

{
  "rules": {
    "prefer-promise-reject-errors": "error"
  }
}

CLI

oxlint --deny prefer-promise-reject-errors

参考资料

• 规则源码