Playwright Library

Playwright module provides a method to launch a browser instance. The following is a typical example of using Playwright to drive automation:

const { chromium, firefox, webkit } = require('playwright');

(async () => {
  const browser = await chromium.launch();  // Or 'firefox' or 'webkit'.
  const page = await browser.newPage();
  await page.goto('http://example.com');
  // other actions...
  await browser.close();
})();

Properties​

chromium​

This object can be used to launch or connect to Chromium, returning instances of Browser.

Usage

playwright.chromium

Type

• BrowserType

devices​

Returns a dictionary of devices to be used with browser.newContext() or browser.newPage().

const { webkit, devices } = require('playwright');
const iPhone = devices['iPhone 6'];

(async () => {
  const browser = await webkit.launch();
  const context = await browser.newContext({
    ...iPhone
  });
  const page = await context.newPage();
  await page.goto('http://example.com');
  // other actions...
  await browser.close();
})();

Usage

playwright.devices

Type

• Object

errors​

Playwright methods might throw errors if they are unable to fulfill a request. For example, locator.waitFor() might fail if the selector doesn't match any nodes during the given timeframe.

For certain types of errors Playwright uses specific error classes. These classes are available via playwright.errors.

An example of handling a timeout error:

try {
  await page.locator('.foo').waitFor();
} catch (e) {
  if (e instanceof playwright.errors.TimeoutError) {
    // Do something if this is a timeout.
  }
}

Usage

playwright.errors

Type

• Object

  • TimeoutError function

    A class of TimeoutError.

firefox​

This object can be used to launch or connect to Firefox, returning instances of Browser.

Usage

playwright.firefox

Type

• BrowserType

request​

Exposes API that can be used for the Web API testing.

Usage

playwright.request

Type

• APIRequest

selectors​

Selectors can be used to install custom selector engines. See extensibility for more information.

Usage

playwright.selectors

Type

• Selectors

webkit​

This object can be used to launch or connect to WebKit, returning instances of Browser.

Usage

playwright.webkit

Type

• BrowserType