noPlaywrightUselessAwait (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v2.4.2
Diagnostic Category: lint/complexity/noPlaywrightUselessAwait
This rule isn’t recommended, so you need to enable it.
This rule has a safe fix.
The default severity of this rule is information.
This rule belongs to the following domains:
- playwright
Sources:
- Same as playwright/no-useless-await

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "complexity": {
5
        "noPlaywrightUselessAwait": "error"
6
      }
7
    }
8
  }
9
}

Description

Disallow unnecessary await for Playwright methods that don’t return promises.

Some Playwright methods are frequently, yet incorrectly, awaited when they return synchronous values. This includes locator methods, which return locators (not promises), and synchronous expect matchers.

Examples

Invalid

1
await page.locator('.my-element');

code-block.js:1:1 lint/complexity/noPlaywrightUselessAwait  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unnecessary await expression.
  
  > 1 │ await page.locator('.my-element');
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ This method does not return a Promise.
  
  ℹ Safe fix: Remove unnecessary await
  
    1 │ await·page.locator('.my-element');
      │ ------

1
await page.getByRole('button');

code-block.js:1:1 lint/complexity/noPlaywrightUselessAwait  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unnecessary await expression.
  
  > 1 │ await page.getByRole('button');
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ This method does not return a Promise.
  
  ℹ Safe fix: Remove unnecessary await
  
    1 │ await·page.getByRole('button');
      │ ------

1
await expect(1).toBe(1);

code-block.js:1:1 lint/complexity/noPlaywrightUselessAwait  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unnecessary await expression.
  
  > 1 │ await expect(1).toBe(1);
      │ ^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ This method does not return a Promise.
  
  ℹ Safe fix: Remove unnecessary await
  
    1 │ await·expect(1).toBe(1);
      │ ------

Valid

1
page.locator('.my-element');
2
await page.locator('.my-element').click();

1
page.getByRole('button');
2
await page.getByRole('button').click();

1
expect(1).toBe(1);
2
await expect(page.locator('.foo')).toBeVisible();