This is documentation for the next version of K6. For the latest stable release, go to the latest version.
dispatchEvent(selector, type, eventInit[, options])
Warning
Use locator-basedlocator.dispatchEvent(type, eventInit[, options])
instead.
Dispatches HTML DOM event types e.g. 'click'
.
Parameter | Type | Defaults | Description |
---|---|---|---|
selector | string | '' | A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. |
type | string | '' | DOM event type e.g. 'click' . |
eventInit | object | null | Optional event specific properties. See eventInit for more details. |
options | object | null | |
options.strict | boolean | false | When true , the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. |
options.timeout | number | 30000 | Maximum 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
Type | Description |
---|---|
Promise<void> | A Promise that fulfills when the event is dispatched. |
Example
import { browser } from 'k6/browser';
export const options = {
scenarios: {
browser: {
executor: 'shared-iterations',
options: {
browser: {
type: 'chromium',
},
},
},
},
};
export default async function () {
const page = await browser.newPage();
await page.goto('https://test.k6.io/browser.php');
await page.dispatchEvent('#counter-button', 'click');
}