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 Recorder API Reference

HotkeySequenceRecorderOptions

Interface: HotkeySequenceRecorderOptions

Defined in: hotkey-sequence-recorder.ts:28

Options for configuring a HotkeySequenceRecorder instance.

Properties

commitKeys?

ts
optional commitKeys: HotkeySequenceRecorderCommitKeys;

Defined in: hotkey-sequence-recorder.ts:44

Keyboard commit mode. When 'none', use HotkeySequenceRecorder.commit (and optional idle timeout).

Default

ts
'enter'

commitOnEnter?

ts
optional commitOnEnter: boolean;

Defined in: hotkey-sequence-recorder.ts:39

Whether plain Enter commits the current steps. Ignored when commitKeys is 'none'.

Default

ts
true

idleTimeoutMs?

ts
optional idleTimeoutMs: number;

Defined in: hotkey-sequence-recorder.ts:49

Milliseconds of inactivity after the last completed chord before auto-committing. The timer does not run while waiting for the first chord (steps.length === 0).


onCancel()?

ts
optional onCancel: () => void;

Defined in: hotkey-sequence-recorder.ts:32

Optional callback when recording is cancelled (Escape pressed)

Returns

void


onClear()?

ts
optional onClear: () => void;

Defined in: hotkey-sequence-recorder.ts:34

Optional callback when the sequence is cleared (Backspace/Delete with no steps)

Returns

void


onRecord()

ts
onRecord: (sequence) => void;

Defined in: hotkey-sequence-recorder.ts:30

Callback when a sequence is successfully recorded (including empty array when cleared)

Parameters

sequence

HotkeySequence

Returns

void