Function: createSequenceMatcher()

function createSequenceMatcher(sequence, options): object;

Defined in: sequence.ts:332

Creates a simple sequence matcher for one-off use.

Parameters

sequence

HotkeySequence

The sequence of hotkeys to match

options

Options including timeout

platform?

"mac" | "windows" | "linux"

timeout?

number

Returns

object

An object with match() and reset() methods

getProgress()

getProgress: () => number;

Returns

number

match()

match: (event) => boolean;

Parameters

event

KeyboardEvent

Returns

boolean

reset()

reset: () => void;

Returns

void

Example

const matcher = createSequenceMatcher(['G', 'G'], { timeout: 500 })

document.addEventListener('keydown', (event) => {
  if (matcher.match(event)) {
    console.log('Sequence matched!')
  }
})