Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
API Reference
Hotkeys API Reference
Hotkey Sequence API Reference
Key Hold API Reference
Held Keys API Reference
Hotkey Recorder API Reference
Hotkey Sequence Recorder API Reference
Format for Display API Reference
Hotkey Sequence API Reference

createSequenceMatcher

Function: createSequenceMatcher()

ts
function createSequenceMatcher(sequence, options): object;

Defined in: sequence-manager.ts:673

Creates a simple sequence matcher for one-off use.

This is a low-level helper that does not support ignoreInputs, target, or other HotkeyOptions. Callers must handle input filtering themselves if attaching to document.

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()

ts
getProgress: () => number;

Returns

number

match()

ts
match: (event) => boolean;

Parameters

event

KeyboardEvent

Returns

boolean

reset()

ts
reset: () => void;

Returns

void

Example

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

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