Skip to main content

require-await

Disallow async functions which have no await expression.

Attributes

  • Included in configs
    • ✅ Recommended
    • 🔒 Strict
  • Fixable
    • 🔧 Automated Fixer
    • 💡 Suggestion Fixer
  • 💭 Requires type information

Rule Details​

This rule extends the base eslint/require-await rule. It uses type information to add support for async functions that return a Promise.

Examples of correct code for this rule:

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

const returnsPromise2 = () => returnsPromise1();

How to Use​

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

Options​

See eslint/require-await options.

Taken with ❤️ from ESLint core

Resources​