EventProcessor | shortcutjs

Process events, mantaining a temporal combo. Then compares combos to find matches.

Hierarchy

EventProcessor

Index

Constructors

constructor

Properties

currentCombo

Methods

Constructors

constructor

new EventProcessor(): EventProcessor

- Defined in event-processor.ts:13
Returns EventProcessor

Properties

currentCombo

currentCombo: KeyCombo

Combo composed by the Keyboard Events keys. It is cleaned on keyup.

Methods

cleanCombo

cleanCombo(options: IOptions): void

- Defined in event-processor.ts:56
Resets the combo and prints debug output

Parameters
- options: IOptions
Returns void

matchesComboAction

matchesComboAction(action: Action): boolean

- Defined in event-processor.ts:93
Checks whether the currentCombo matches a particular action

Parameters
- action: Action
Returns boolean

printDebugActionFound

printDebugActionFound(action: Action): void

- Defined in event-processor.ts:113
Prints when action matches

Parameters
- action: Action
Returns void

printDebugKeyPressed

printDebugKeyPressed(ev: KeyboardEvent): void

- Defined in event-processor.ts:100
Prints keydown events

Parameters
- ev: KeyboardEvent
Returns void

processActionCombos

processActionCombos(ev: KeyboardEvent, actions: Map<string, Action>, options: IOptions): boolean

- Defined in event-processor.ts:67
Search for matching actions, given a keyCombo, and execute its callbacks

Parameters
- ev: KeyboardEvent
- actions: Map<string, Action>
- options: IOptions
Returns boolean

processEvent

processEvent(ev: KeyboardEvent, actions: Map<string, Action>, options: IOptions): boolean

- Defined in event-processor.ts:29
Process a keyboardEvent

Parameters
- ev: KeyboardEvent
- actions: Map<string, Action>
- options: IOptions
Returns boolean

reset

reset(): void

- Defined in event-processor.ts:22
Resets the current Combo

Returns void

Generated using TypeDoc