Menu

This is documentation for the next version of K6. For the latest stable release, go to the latest version.

Open source

check([options])

Warning

Use locator.check([options]) instead.

Use this method to select an input checkbox.

ParameterTypeDefaultDescription
optionsobjectnullOptional parameters.
options.forcebooleanfalseSetting this to true will bypass the actionability checks (visible, stable, enabled).
options.noWaitAfterbooleanfalseIf set to true and a navigation occurs from performing this action, it will not wait for it to complete.
options.positionobjectnullA point to use relative to the top left corner of the element. If not supplied, a visible point of the element is used.
options.position.xnumber0The x coordinate.
options.position.ynumber0The y coordinate.
options.timeoutnumber30000Maximum time in milliseconds. Pass 0 to disable the timeout. Default is overridden by the setDefaultTimeout option on BrowserContext or Page.
options.trialbooleanfalseSetting this to true will perform the actionability checks without performing the action.

Returns

TypeDescription
Promise<void>A Promise that fulfills when the check action is finished.

Example

JavaScript
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');

  const checkbox = await page.$('#checkbox1');
  await checkbox.check();

  await page.close();
}