noPlaywrightWaitForTimeout (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v2.4.2
Diagnostic Category: lint/suspicious/noPlaywrightWaitForTimeout
This rule isn’t recommended, so you need to enable it.
This rule doesn’t have a fix.
The default severity of this rule is warning.
This rule belongs to the following domains:
- playwright
Sources:
- Same as playwright/no-wait-for-timeout

How to configure

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

Description

Disallow using page.waitForTimeout().

Playwright provides methods like page.waitForLoadState(), page.waitForURL(), and page.waitForFunction() which are better alternatives to using hardcoded timeouts. These methods wait for specific conditions and are more reliable than arbitrary timeouts.

Examples

Invalid

1
await page.waitForTimeout(5000);

code-block.js:1:7 lint/suspicious/noPlaywrightWaitForTimeout ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unexpected use of page.waitForTimeout().
  
  > 1 │ await page.waitForTimeout(5000);
      │       ^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Hardcoded timeouts are flaky and make tests slower. Use conditions that wait for specific events.
  
  ℹ Prefer using built-in wait methods like page.waitForLoadState(), page.waitForURL(), or page.waitForFunction() instead.
  
  ℹ Consider using web-first assertions like expect(locator).toBeVisible() which auto-wait for conditions.

1
await page.waitForTimeout(1000);

code-block.js:1:7 lint/suspicious/noPlaywrightWaitForTimeout ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unexpected use of page.waitForTimeout().
  
  > 1 │ await page.waitForTimeout(1000);
      │       ^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Hardcoded timeouts are flaky and make tests slower. Use conditions that wait for specific events.
  
  ℹ Prefer using built-in wait methods like page.waitForLoadState(), page.waitForURL(), or page.waitForFunction() instead.
  
  ℹ Consider using web-first assertions like expect(locator).toBeVisible() which auto-wait for conditions.

Valid

1
await page.waitForLoadState();

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

1
await page.waitForFunction(() => window.innerWidth < 100);