require-await
禁止没有 await 表达式的异步函数
💡 hasSuggestions
此规则报告的一些问题可以通过编辑器建议手动修复
JavaScript 中的异步函数在两个重要方面与其他函数的行为不同
- 返回值始终为
Promise。 - 您可以在其中使用
await运算符。
使用异步函数的主要原因通常是使用 await 运算符，例如这样
async function fetchData(processDataItem) {
const response = await fetch(DATA_URL);
const data = await response.json();
return data.map(processDataItem);
}
不使用 await 的异步函数可能不需要是异步函数，并且可能是重构的意外结果。
注意：此规则忽略异步生成器函数。这是因为生成器会产生而不是返回值，并且异步生成器可能会产生另一个异步生成器的所有值，而无需实际使用 await。
规则详情
此规则会警告没有 await 表达式的异步函数。
此规则的错误代码示例
在 Playground 中打开
/*eslint require-await: "error"*/
() {
doSomething();
}
bar(async () {
doSomething();
});
此规则的正确代码示例
在 Playground 中打开
/*eslint require-await: "error"*/
async function foo() {
await doSomething();
}
bar(async () => {
await doSomething();
});
function baz() {
doSomething();
}
bar(() => {
doSomething();
});
// Allow empty functions.
async function noop() {}
何时不使用它
异步函数旨在与 Promise 配合使用，以便抛出错误会导致调用 Promise 的拒绝处理程序（例如 catch()）。例如
async function fail() {
throw new Error("Failure!");
}
fail().catch(error => {
console.log(error.message);
});
在这种情况下，fail() 函数抛出一个错误，该错误旨在由稍后分配的 catch() 处理程序捕获。将 fail() 函数转换为同步函数将需要将对 fail() 的调用重构为使用 try-catch 语句而不是 Promise。
如果您出于此目的在异步函数内部抛出错误，则可能需要禁用此规则。
相关规则
版本
此规则在 ESLint v3.11.0 中引入。