Class ListenKey

Listen keydown/keyup event on document for a specific keyboard key.

Index

Constructors

Methods

destroy isKeyDown setOnKeyDown setOnKeyUp

Constructors

constructor

new ListenKey(listenedKey: string): ListenKey
Parameters
- listenedKey: string
  the key to listen.
Returns ListenKey
- Defined in event/listen-key.ts:19

Methods

destroy

destroy(): void
Destroy listeners. The instance is then useless.

Returns void
- Defined in event/listen-key.ts:27

isKeyDown

isKeyDown(): boolean
Is the key currently pressed.

Returns boolean
- Defined in event/listen-key.ts:34

setOnKeyDown

setOnKeyDown(callback: callback): void
Register a callback that will be called each time the key is pressed.
Parameters
- callback: callback
Returns void
- Defined in event/listen-key.ts:42

setOnKeyUp

setOnKeyUp(callback: callback): void
Register a callback that will be called each time the key is released.
Parameters
- callback: callback
Returns void
- Defined in event/listen-key.ts:50