跳至主要内容

要求 await

禁止不返回 Promise 且没有 await 表达式的异步函数。

✅

在 "plugin:@typescript-eslint/recommended-type-checked" 中扩展 ESLint 配置 将启用此规则。

💭

此规则需要 类型信息 才能运行。

此规则扩展了基本 eslint/require-await 规则。它使用类型信息允许将返回 Promise 的函数标记为 async，而无需包含 await 表达式。

示例​

此规则的正确代码示例

async function returnsPromise1() {
  return Promise.resolve(1);
}

const returnsPromise2 = () => returnsPromise1();

选项​

参见 eslint/require-await 选项。

使用方法​

.eslintrc.cjs
module.exports = {
  "rules": {
    // Note: you must disable the base rule as it can report incorrect errors
    "require-await": "off",
    "@typescript-eslint/require-await": "error"
  }
};

在游乐场中尝试此规则 ↗

何时不使用它​

类型检查 lint 规则比传统的 lint 规则更强大，但也需要配置 类型检查 lint。如果在启用类型检查规则后遇到性能下降，请参见 性能故障排除。

资源​

来自 ESLint 核心 的 ❤️。