← Back to rules

jest/no-unneeded-async-expect-function Style

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

What it does

Disallows unnecessary async function wrapper for expected promises.

Why is this bad?

When the only statement inside an async wrapper is await someCall(), the call should be passed directly to expect instead. This makes the test code more concise and easier to read.

Examples

Examples of incorrect code for this rule:

await expect(async () => {
  await doSomethingAsync();
}).rejects.toThrow();

await expect(async () => await doSomethingAsync()).rejects.toThrow();

Examples of correct code for this rule:

await expect(doSomethingAsync()).rejects.toThrow();

This rule is compatible with eslint-plugin-vitest, to use it, add the following configuration to your .oxlintrc.json:

{
  "rules": {
    "vitest/no-unneeded-async-expect-function": "error"
  }
}

How to use

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

Config (.oxlintrc.json)

{
  "plugins": ["jest"],
  "rules": {
    "jest/no-unneeded-async-expect-function": "error"
  }
}

CLI

oxlint --deny jest/no-unneeded-async-expect-function --jest-plugin

References

• Rule Source