puppeteer/website/versioned_docs/version-19.8.2/api/puppeteer.keyboard.press.md

sidebar_label
Keyboard.press

Keyboard.press() method

Shortcut for Keyboard.down() and Keyboard.up().

Signature:

class Keyboard {
  press(
    key: KeyInput,
    options?: {
      delay?: number;
      text?: string;
      commands?: string[];
    }
  ): Promise<void>;
}

Parameters

Parameter	Type	Description
key	KeyInput	Name of key to press, such as ArrowLeft. See KeyInput for a list of all key names.
options	{ delay?: number; text?: string; commands?: string[]; }	(Optional) An object of options. Accepts text which, if specified, generates an input event with this text. Accepts delay which, if specified, is the time to wait between keydown and keyup in milliseconds. Defaults to 0. Accepts commands which, if specified, is the commands of keyboard shortcuts, see Chromium Source Code for valid command names.

Returns:

Promise<void>

Remarks

If key is a single character and no modifier keys besides Shift are being held down, a keypress/input event will also generated. The text option can be specified to force an input event to be generated.

Modifier keys DO effect Keyboard.press(). Holding down Shift will type the text in upper case.