noPlaywrightWaitForNavigation (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v2.4.2
Diagnostic Category: lint/nursery/noPlaywrightWaitForNavigation
This rule doesn’t have a fix.
The default severity of this rule is information.
This rule belongs to the following domains:
- playwright
Sources:
- Same as playwright/no-wait-for-navigation

How to configure

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

Description

Disallow using page.waitForNavigation().

Playwright’s page.waitForNavigation() is deprecated and should be replaced with more reliable alternatives like page.waitForURL() or page.waitForLoadState().

Examples

Invalid

1
await page.waitForNavigation();

code-block.js:1:7 lint/nursery/noPlaywrightWaitForNavigation ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected use of page.waitForNavigation().
  
  > 1 │ await page.waitForNavigation();
      │       ^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ waitForNavigation() is deprecated because it can be unreliable.
  
  ℹ Use page.waitForURL() or page.waitForLoadState() instead.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.

1
await page.click('button');
2
await page.waitForNavigation({ waitUntil: 'networkidle' });

code-block.js:2:7 lint/nursery/noPlaywrightWaitForNavigation ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected use of page.waitForNavigation().
  
    1 │ await page.click('button');
  > 2 │ await page.waitForNavigation({ waitUntil: 'networkidle' });
      │       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    3 │ 
  
  ℹ waitForNavigation() is deprecated because it can be unreliable.
  
  ℹ Use page.waitForURL() or page.waitForLoadState() instead.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.

Valid

1
await page.waitForURL('/home');

1
await page.waitForLoadState('networkidle');

1
await page.goto('/home');