puppeteer/new-docs/puppeteer.protocol.input.dispatchkeyeventrequest.md

Home > puppeteer > Protocol > Input > DispatchKeyEventRequest

Protocol.Input.DispatchKeyEventRequest interface

Signature:

export interface DispatchKeyEventRequest 

Properties

Property	Type	Description
autoRepeat	boolean	Whether the event was generated from auto repeat (default: false).
code	string	Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").
isKeypad	boolean	Whether the event was generated from the keypad (default: false).
isSystemKey	boolean	Whether the event was a system key event (default: false).
key	string	Unique DOM defined string value describing the meaning of the key in the context of active modifiers, keyboard layout, etc (e.g., 'AltGr') (default: "").
keyIdentifier	string	Unique key identifier (e.g., 'U+0041') (default: "").
location	integer	Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default: 0).
modifiers	integer	Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).
nativeVirtualKeyCode	integer	Native virtual key code (default: 0).
text	string	Text as generated by processing a virtual key code with a keyboard layout. Not needed for for keyUp and rawKeyDown events (default: "")
timestamp	TimeSinceEpoch	Time at which the event occurred.
type	('keyDown' | 'keyUp' | 'rawKeyDown' | 'char')	Type of the key event.
unmodifiedText	string	Text that would have been generated by the keyboard if no modifiers were pressed (except for shift). Useful for shortcut (accelerator) key handling (default: "").
windowsVirtualKeyCode	integer	Windows virtual key code (default: 0).