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

✅ This rule is turned on by default.

🛠️ An auto-fix is available for this rule for some violations.

What it does

Disallow passing single-element arrays to Promise methods

Why is this bad?

Passing a single-element array to Promise.all(), Promise.any(), or Promise.race() is likely a mistake.

Examples

Examples of incorrect code for this rule:

async function bad() {
  const foo = await Promise.all([promise]);
  const foo = await Promise.any([promise]);
  const foo = await Promise.race([promise]);
  const promise = Promise.all([nonPromise]);
}

Examples of correct code for this rule:

async function good() {
  const foo = await promise;
  const promise = Promise.resolve(nonPromise);
  const foo = await Promise.all(promises);
  const foo = await Promise.any([promise, anotherPromise]);
  const [{ value: foo, reason: error }] = await Promise.allSettled([promise]);
}

How to use

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

CLI

oxlint --deny unicorn/no-single-promise-in-promise-methods

Config (.oxlintrc.json)

{
  "rules": {
    "unicorn/no-single-promise-in-promise-methods": "error"
  }
}

References

• Rule Source