← Back to rules

vitest/require-awaited-expect-poll Correctness

What it does

This rule ensures that promises returned by expect.poll and expect.element calls are handled properly.

Why is this bad?

expect.poll and expect.element return promises. If not awaited or returned, the test completes before the assertion resolves, meaning the test will pass regardless of whether the assertion succeeds or fails.

Examples

Examples of incorrect code for this rule:

test("element exists", () => {
  asyncInjectElement();

  expect.poll(() => document.querySelector(".element")).toBeInTheDocument();
});

Examples of correct code for this rule:

test("element exists", () => {
  asyncInjectElement();

  return expect.poll(() => document.querySelector(".element")).toBeInTheDocument();
});
test("element exists", async () => {
  asyncInjectElement();

  await expect.poll(() => document.querySelector(".element")).toBeInTheDocument();
});

How to use

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

Config (.oxlintrc.json)

{
  "plugins": ["vitest"],
  "rules": {
    "vitest/require-awaited-expect-poll": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["vitest"],
  rules: {
    "vitest/require-awaited-expect-poll": "error",
  },
});

CLI

oxlint --deny vitest/require-awaited-expect-poll --vitest-plugin

Version

This rule was added in v1.58.0.

References

• Rule Source
• Open rule in Oxc Playground