← Back to rules

eslint/no-promise-executor-return 严格

An auto-fix is available for this rule.

它的作用

禁止在 Promise 执行器函数中返回值。

为什么这是个问题？

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

执行器函数的返回值会被忽略。从执行器函数中返回值可能是错误的，因为返回的值无法被使用，并且对 Promise 不产生任何影响。

示例

此规则的错误代码示例：

new Promise((resolve, reject) => {
  if (someCondition) {
    return defaultResult;
  }
  getSomething((err, result) => {
    if (err) {
      reject(err);
    } else {
      resolve(result);
    }
  });
});

new Promise((resolve, reject) =>
  getSomething((err, data) => {
    if (err) {
      reject(err);
    } else {
      resolve(data);
    }
  }),
);

new Promise(() => {
  return 1;
});

此规则的正确代码示例：

new Promise((resolve, reject) => {
  if (someCondition) {
    resolve(defaultResult);
    return;
  }
  getSomething((err, result) => {
    if (err) {
      reject(err);
    } else {
      resolve(result);
    }
  });
});

new Promise((resolve, reject) => {
  getSomething((err, data) => {
    if (err) {
      reject(err);
    } else {
      resolve(data);
    }
  });
});

new Promise((r) => {
  r(1);
});

配置

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

allowVoid

type: boolean

default: false

如果为 true，则允许返回 void 表达式（例如：return void resolve()）。

如何使用

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

配置文件 (.oxlintrc.json)

{
  "rules": {
    "no-promise-executor-return": "error"
  }
}

CLI

oxlint --deny no-promise-executor-return

参考资料

• 规则源码