Skip to content
Hotkey Recorder API Reference

RecorderOptions

Defined in: hotkey-recorder.ts:73

Properties

detectConflicts?

ts
optional detectConflicts?: boolean | HotkeyConflictOptions;

Defined in: hotkey-recorder.ts:79

Opt in to live-registry conflicts, including sequence prefixes. Default: false.


onReject?

ts
optional onReject?: (rejection) => void;

Defined in: hotkey-recorder.ts:81

Rejected candidates leave recording active.

Parameters

rejection

RecorderRejection

Returns

void


platform?

ts
optional platform?: HotkeyPlatform;

Defined in: hotkey-recorder.ts:77

Platform used for Mod and AltGraph handling. Defaults to platform detection.


recordBy?

ts
optional recordBy?: RecorderKeyMode;

Defined in: hotkey-recorder.ts:75

How the pressed key is written. Default: 'auto'.