browser

Experimental module, use at your own risk

While we intend to keep this module as simple and stable as possible, we may need to add features or introduce breaking changes. This could happen at any time until we release this module as stable.

Feel free to provide user feedback, and open an issue or pull request if you have any suggestions.

The browser module APIs aim for rough compatibility with the Playwright API for NodeJS.

Note that because k6 does not run in NodeJS, the browser module APIs will slightly differ from their Playwright counterparts.

note

To work with the browser module, make sure you are using k6 version 0.43.0 or above.

Modules

The table below lists the importable properties from the top level module ('k6/experimental/browser').

Devices Example

To emulate the browser behaviour on a mobile device and approximately measure the browser performance, you can import devices from k6/experimental/browser.

1import { chromium, devices } from 'k6/experimental/browser';
2
3export default async function () {
4  const browser = chromium.launch({ headless: false });
5  const iphoneX = devices['iPhone X'];
6  const context = browser.newContext(iphoneX);
7  const page = context.newPage();
8
9  try {
10    await page.goto('https://test.k6.io/');
11  } finally {
12    page.close();
13    browser.close();
14  }
15}

Browser-level APIs