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])

Dispatches a keydown event followed by a keyup event. This is useful for simulating pressing a key.

ParameterTypeDefaultDescription
keystring''Name of the key to press, such as Enter.
optionsobjectnullOptional settings.
options.delaynumber0Optional. Time to wait before running the press action in milliseconds.

Returns

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