require-await

NOTE: this rule is part of the recommended rule set.

Enable full set in deno.json:

{
  "lint": {
    "rules": {
      "tags": ["recommended"]
    }
  }
}

Enable full set using the Deno CLI:

deno lint --rules-tags=recommended

This rule can be explictly included to or excluded from the rules present in the current tag by adding it to the include or exclude array in deno.json:

{
  "lint": {
    "rules": {
      "include": ["require-await"],
      "exclude": ["require-await"]
    }
  }
}

Disallows async functions that have no await expression or await using declaration.

In general, the primary reason to use async functions is to use await expressions or await using declarations inside. If an async function has neither, it is most likely an unintentional mistake.

Invalid:

async function f1() {
  doSomething();
}

const f2 = async () => {
  doSomething();
};

const f3 = async () => doSomething();

const obj = {
  async method() {
    doSomething();
  },
};

class MyClass {
  async method() {
    doSomething();
  }
}

Valid:

await asyncFunction();

function normalFunction() {
  doSomething();
}

async function f1() {
  await asyncFunction();
}

const f2 = async () => {
  await asyncFunction();
};

const f3 = async () => await asyncFunction();

async function f4() {
  for await (const num of asyncIterable) {
    console.log(num);
  }
}

async function f5() {
  using = createResource();
}

// empty functions are valid
async function emptyFunction() {}
const emptyArrowFunction = async () => {};

// generators are also valid
async function* gen() {
  console.log(42);
}

require-await

Did you find what you needed?