require-await

禁止没有 await 表达式的异步函数

JavaScript 中的异步函数在两个重要方面与其他函数不同：

使用异步函数的主要原因通常是使用 await 运算符，例如：

async function fetchData(processDataItem) {
    const response = await fetch(DATA_URL);
    const data = await response.json();

    return data.map(processDataItem);
}

不使用 await 的异步函数可能不需要是异步函数，并且可能是重构的无意结果。

注意：此规则忽略异步生成器函数。这是因为生成器产生而不是返回值，并且异步生成器可能会产生另一个异步生成器的所有值，而实际上不需要使用等待。

规则详情

此规则警告没有 await 表达式的异步函数。

此规则的错误代码示例：

/*eslint require-await: "error"*/

async function foo() {
    doSomething();
}

bar(async () => {
    doSomething();
});

此规则的正确代码示例：

/*eslint require-await: "error"*/

async function foo() {
    await doSomething();
}

bar(async () => {
    await doSomething();
});

function foo() {
    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。

如果您为此目的在异步函数内部抛出错误，那么您可能需要禁用此规则。