A function that does not contain any await expressions should not be async (except for some edge cases in TypeScript which are discussed below). Asynchronous functions in JavaScript behave differently than other functions in two important ways:

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

Functions are made async so that we can use the await operator inside them. Consider this example:

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 be an unintentional result of refactoring.

Note: This issue ignores async generator functions. 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.

In TypeScript, one might feel the need to make a function async to comply with type signatures defined by an interface. Ideally, the code should be refactored to get rid of such restrictions, but sometimes that isn't feasible (For example, when we are implementing an interface defined in a 3rd party library like Next.js).

This situation can easily be circumvented by returning the value with a call to Promise.resolve:

interface HasAsyncFunc {
  getNum: () => Promise<number>
}

// Not recommended:
const o: HasAsyncFunc = {
  async getNum() { return 1 }
}

// Recommended:
const o: HasAsyncFunc = {
  // We only use `Promise.resolve` to adhere to the type
  // of the surrounding object.
  getNum() { return Promise.resolve(1) }
}

It is also advised to add a comment near the redundant promise to make the intent clear.

Bad Practice

async function promise1() {
  return 1
}

async function fetchJSON(url: string) {
  return axios.get(url)
}

Recommended

function promise1() {
  return Promise.resolve(1);
}

async function fetchJSON(url: string) {
  const data = await axios.get(url)
  return data.payload;
}

Zhihui-Platform / client

No ignore rules found