no-async-promise-executor

禁止使用异步函数作为 Promise 执行器

new Promise 构造函数接受一个执行器函数作为参数，该函数具有resolve和reject参数，可用于控制创建的 Promise 的状态。例如

const result = new Promise(function executor(resolve, reject) {
  readFile('foo.txt', function(err, result) {
    if (err) {
      reject(err);
    } else {
      resolve(result);
    }
  });
});
1
2
3
4
5
6
7
8
9

执行器函数也可以是async function。但是，这通常是一个错误，原因如下：

• 如果异步执行器函数抛出错误，则该错误将丢失，并且不会导致新构造的Promise被拒绝。这可能会使调试和处理某些错误变得困难。
• 如果 Promise 执行器函数正在使用await，这通常表示实际上没有必要使用new Promise构造函数，或者可以减少new Promise构造函数的作用域。

规则详细信息

此规则旨在禁止异步 Promise 执行器函数。

此规则的错误代码示例

/*eslint no-async-promise-executor: "error"*/

const foo = new Promise(async (resolve, reject) => {
  readFile('foo.txt', function(err, result) {
    if (err) {
      reject(err);
    } else {
      resolve(result);
    }
  });
});

const result = new Promise(async (resolve, reject) => {
  resolve(await foo);
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

此规则的正确代码示例

/*eslint no-async-promise-executor: "error"*/

const foo = new Promise((resolve, reject) => {
  readFile('foo.txt', function(err, result) {
    if (err) {
      reject(err);
    } else {
      resolve(result);
    }
  });
});

const result = Promise.resolve(foo);
1
2
3
4
5
6
7
8
9
10
11
12
13

何时不使用它

如果您的代码库不支持异步函数语法，则无需启用此规则。

版本

此规则在 ESLint v5.3.0 中引入。

资源

• 规则源代码
• 测试源代码