This is documentation for the next version of K6. For the latest stable release, go to the latest version.
waitForLoadState(state[, options])
Caution
This method has known issues. For details, refer to #880.
This waits for the given load state to be reached. It will immediately unblock if that lifecycle event has already been received.
Parameter | Type | Default | Description |
---|---|---|---|
state | string | load | Optional load state to wait for. See Events for more details. |
options | object | null | |
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. |
Events
Caution
networkidle
is DISCOURAGED. Don’t use this method for testing especially with chatty websites where the event may never fire, rely on web assertions to assess readiness instead.
Events can be either:
'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- Consider operation to be finished when there are no network connections for at least500
ms.
Returns
Type | Description |
---|---|
Promise<void> | A Promise that fulfills when the load state is reached. |
Example
import { browser } from 'k6/browser';
import { check } from 'https://jslib.k6.io/k6-utils/1.5.0/index.js';
export const options = {
scenarios: {
browser: {
executor: 'shared-iterations',
options: {
browser: {
type: 'chromium',
},
},
},
},
};
export default async function () {
let page = await browser.newPage();
try {
await page.goto('https://test.k6.io/my_messages.php');
await page.locator('input[name="login"]').type('admin');
await page.locator('input[name="password"]').type('123');
const submitButton = page.locator('input[type="submit"]');
await submitButton.click();
await page.waitForLoadState('networkidle'); // waits until the `networkidle` event
await check(page.locator('h2'), {
'header': async h2 => await h2.textContent() == 'Welcome, admin!'
});
} finally {
await page.close();
}
}