press(key, [options])

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

press(key, [options])

Warning

Use locator.press(key[, options]) instead.

Press a single key on the keyboard or a combination of keys.

ParameterTypeDefaultDescription
keystring''Name of the key to press or a character to generate, such as ArrowLeft or a. A superset of the key values can be found here.
optionsobjectnull
options.delaynumber0Milliseconds to wait between keydown and keyup.
options.noWaitAfterbooleanfalseIf set to true and a navigation occurs from performing this action, it will not wait for it to complete.
options.timeoutnumber30000Maximum time in milliseconds. Pass 0 to disable the timeout. Default is overridden by the setDefaultTimeout option on BrowserContext or Page.

Returns

TypeDescription
Promise<void>A Promise that fulfills when the key is pressed.

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 text = await page.$('#text1');
  await text.press('i');
  await text.press('ArrowLeft');
  await text.press('h');

  await page.close();
}