Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 994 Bytes

require-await.md

File metadata and controls

46 lines (31 loc) · 994 Bytes
Raw

require-await

Disallow async functions which have no await expression.

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

{
  // 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

Attributes

  • Configs:
    • ✅ Recommended
    • 🔒 Strict
  • 🔧 Fixable
  • 💭 Requires type information