← Back to rules

eslint/require-await Pedantic

⚠️ 🛠️ A dangerous auto-fix is available for this rule.

What it does

Disallow async functions which have no await expression.

NOTE

This rule is inferior to the accuracy of the type-aware typescript/require-await rule. If using type-aware rules, always prefer that rule over this one.

Why is this bad?

Asynchronous functions in JavaScript behave differently than other functions in two important ways:

1. The return value is always a Promise.
2. You can use the await operator inside of them.

The primary reason to use asynchronous functions is typically to use the await operator, such as this:

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

  return data.map(processDataItem);
}

Asynchronous functions that don’t use await might not need to be asynchronous functions and could be the unintentional result of refactoring.

Note: this rule ignores async generator functions. This is because generators yield rather than return a value and async generators might yield all the values of another async generator without ever actually needing to use await.

Examples

Examples of incorrect code for this rule:

async function foo() {
  doSomething();
}

Examples of correct code for this rule:

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

How to use

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)

{
  "rules": {
    "require-await": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "require-await": "error",
  },
});

CLI

oxlint --deny require-await

Version

This rule was added in v0.4.2.

References

• Rule Source
• Open rule in Oxc Playground