Skip to content

unicorn/no-await-in-promise-methods Correctness

This rule is turned on by default.

What it does

Disallow using await in Promise method parameters

Why is this bad?

Using await on promises passed as arguments to Promise.all(), Promise.allSettled(), Promise.any(), or Promise.race() is likely a mistake.

Examples

Examples of incorrect code for this rule:

javascript
async function foo() {
  Promise.all([await promise, anotherPromise]);
  Promise.allSettled([await promise, anotherPromise]);
  Promise.any([await promise, anotherPromise]);
  Promise.race([await promise, anotherPromise]);
}

Examples of correct code for this rule:

javascript
async function foo() {
  Promise.all([promise, anotherPromise]);
  Promise.allSettled([promise, anotherPromise]);
  Promise.any([promise, anotherPromise]);
  Promise.race([promise, anotherPromise]);
}

How to use

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

json
{
  "rules": {
    "unicorn/no-await-in-promise-methods": "error"
  }
}
bash
oxlint --deny unicorn/no-await-in-promise-methods

References

Released under the MIT License.