Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/browserbreadcrumb arrow Locatorbreadcrumb arrow dispatchEvent(type, eventInit, [options])
Open source

dispatchEvent(type, eventInit, [options])

Dispatches HTML DOM event types e.g. 'click'.

ParameterTypeDefaultsDescription
typestring''DOM event type e.g. 'click'.
eventInitobjectnullOptional event specific properties. See eventInit for more details.
optionsobjectnull
options.timeoutnumber30000Maximum time in milliseconds. Pass 0 to disable the timeout. Default is overridden by the setDefaultTimeout option on BrowserContext or Page.

eventInit

Since eventInit is event-specific, please refer to the events documentation for the lists of initial properties:

Returns

TypeDescription
Promise<void>A Promise that fulfills once the event is dispatched.

Example

JavaScript 
import { browser } from 'k6/browser';

export default async function () {
  const page = await browser.newPage();

  await page.goto('https://test.k6.io/browser.php');
  const button = page.locator('#counter-button');
  await button.dispatchEvent('click');

  await page.close();
}