PlaywrightAssertions

Source URL: https://playwright.dev/docs/api/class-playwrightassertions

PlaywrightAssertions | Playwright

Playwright gives you Web-First Assertions with convenience methods for creating assertions that will wait and retry until the expected condition is met.

Consider the following example:

    import { test, expect } from '@playwright/test';

    test('status becomes submitted', async ({ page }) => {
      // ...
      await page.locator('#submit-button').click();
      await expect(page.locator('.status')).toHaveText('Submitted');
    });

Playwright will be re-testing the node with the selector .status until fetched Node has the "Submitted" text. It will be re-fetching the node and checking it over and over, until the condition is met or until the timeout is reached. You can pass this timeout as an option.

By default, the timeout for assertions is set to 5 seconds.

---

Methods​

expect(response)​

Added in: v1.18 playwrightAssertions.expect(response)

Creates a APIResponseAssertions object for the given APIResponse.

Usage

Arguments

• response APIResponse#

APIResponse object to use for assertions.

Returns

• APIResponseAssertions#

---

expect(value)​

Added in: v1.9 playwrightAssertions.expect(value)

Creates a GenericAssertions object for the given value.

Usage

    expect(value);

Arguments

• value Object#

Value that will be asserted.

Returns

• GenericAssertions#

---

expect(locator)​

Added in: v1.18 playwrightAssertions.expect(locator)

Creates a LocatorAssertions object for the given Locator.

Usage

Arguments

• locator Locator#

Locator object to use for assertions.

Returns

• LocatorAssertions#

---

expect(page)​

Added in: v1.18 playwrightAssertions.expect(page)

Creates a PageAssertions object for the given Page.

Usage

Arguments

• page Page#

Page object to use for assertions.

Returns

• PageAssertions#