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.

Open source

reload([options])

This reloads the current page and returns the main resource response.

ParameterTypeDefaultDescription
optionsobjectnull
options.timeoutnumber30000Maximum operation time in milliseconds. Pass 0 to disable the timeout. The default value can be changed via the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods. Setting the value to 0 will disable the timeout.
options.waitUntilstringloadWhen to consider operation to have succeeded. See Events for more details.

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 the DOMContentLoaded event is fired.
  • 'load' - consider operation to be finished when the load event is fired.
  • 'networkidle' - Consider operation to be finished when there are no network connections for at least 500 ms.

Returns

TypeDescription
null or ResponseThe Response instance associated with the page. Else, it returns null.

Example

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

export const options = {
  scenarios: {
    browser: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

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

  await page.goto('https://test.k6.io/browser.php');
  page.reload();
}