No results for

Powered byAlgolia

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.


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


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

chromiumA BrowserType to launch tests in a Chromium-based browser.
devicesReturns predefined emulation settings for many end-user devices that can be used to simulate browser behavior on a mobile device. See the devices example below.
versionReturns the version number of k6 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';
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();
9 try {
10 await page.goto('');
11 } finally {
12 page.close();
13 browser.close();
14 }

Browser-level APIs

k6 ClassDescription
The entry point for all tests and used to launch BrowserContexts and Pages.
Enables independent browser sessions with separate Pages, cache, and cookies.
BrowserTypeThe BrowserType is the entry point into launching a browser process; chromium is currently the only supported BrowserType.
Represents an in-page DOM element.
Access and interact with the Page.'s Frames.
JSHandleRepresents an in-page JavaScript object.
KeyboardUsed to simulate the keyboard interactions with the associated Page.
LocatorThe Locator API makes it easier to work with dynamically changing elements.
MouseUsed to simulate the mouse interactions with the associated Page.
Provides methods to interact with a single tab in a Browser.
Used to keep track of the request the Page makes.
Represents the response received by the Page.
TouchscreenUsed to simulate touch interactions with the associated Page.
WorkerRepresents a WebWorker.