prefer-promise-reject-errors

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

对于 Promise 中的用户定义错误，仅将内置 Error 对象的实例传递给 reject() 函数被认为是最佳实践。Error 对象会自动存储堆栈跟踪，可用于通过确定错误来自何处来调试错误。如果 Promise 使用非 Error 值拒绝，则可能难以确定拒绝发生的位置。

规则详情

此规则旨在确保 Promise 仅使用 Error 对象拒绝。

选项

此规则接受一个可选的对象参数

• allowEmptyReject: true（默认情况下为 false）允许对 Promise.reject() 进行不带参数的调用。

此规则的错误代码示例

/*eslint prefer-promise-reject-errors: "error"*/

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();
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

此规则的正确代码示例

/*eslint prefer-promise-reject-errors: "error"*/

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);
1
2
3
4
5
6
7
8
9
10
11
12

使用 allowEmptyReject: true 选项的此规则的正确代码示例

/*eslint prefer-promise-reject-errors: ["error", {"allowEmptyReject": true}]*/

Promise.reject();

new Promise(function(resolve, reject) {
  reject();
});
1
2
3
4
5
6
7

已知限制

由于静态分析的限制，此规则无法保证您只使用 Error 对象来拒绝 Promise。虽然该规则会报告它可以保证拒绝原因明显不是 Error 的情况，但它不会报告无法确定给定原因是否为 Error 的情况。有关此注意事项的更多信息，请参阅no-throw-literal 规则中的类似限制。

为了避免规则之间的冲突，此规则不会报告异步函数中 throw 语句中使用的非错误值，即使它们会导致 Promise 拒绝。要对这些情况进行代码检查，请使用no-throw-literal 规则。

何时不使用它

如果您使用自定义的非错误值作为 Promise 拒绝原因，您可以关闭此规则。

相关规则

• no-throw-literal

版本

此规则是在 ESLint v3.14.0 中引入的。

进一步阅读

警告说明 | bluebird
bluebirdjs.com

资源

• 规则来源
• 测试来源