Interface ChordHandler<E>

Object with handlers that get fired based on the conditional checks.

interface ChordHandler<E extends ChordedEvent> {
    on(chords: ChordInput, listener: ChordMatchListener<E>): ChordHandler<E>;
    when(
        condition: WhenCondition<E>,
        listener: ChordMatchListener<E>,
    ): ChordHandler<E>;
}

Type Parameters

E extends ChordedEvent
Keyboard or mouse event.

Index

Methods

Methods

on

on(chords: ChordInput, listener: ChordMatchListener<E>): ChordHandler<E>
Fired when the specified chord or array of chords is pressed.
Parameters
- chords: ChordInput
  Single chord or array of chords that represent a combination of Token elements that meet the conditions in the specified event.
- listener: ChordMatchListener<E>
  Callback to fire if a chord match is found.
Returns ChordHandler<E>
- Defined in handleChords.ts:39

when

when(
condition: WhenCondition<E>,
listener: ChordMatchListener<E>,
): ChordHandler<E>
Fired when the specified condition is met.
Parameters
- condition: WhenCondition<E>
  Either a boolean value or a function that returns a boolean.
- listener: ChordMatchListener<E>
  Callback to fire if the condition is true.
Returns ChordHandler<E>
- Defined in handleChords.ts:47