Normalization & format API Reference

checkHotkey

ts

function checkHotkey(hotkey): boolean;

Defined in: validate.ts:161

Validates a hotkey and logs errors and warnings to the console. Useful for development-time feedback. Logs nothing in production builds.

Parameters

hotkey

ValidatableHotkey

The hotkey string to validate

Returns

boolean

True if the hotkey is valid (may still have warnings)

Example

ts

checkHotkey('Control+escape')
// Console: [hotkeys] Hotkey 'Control+escape' may never fire: unknown-key 'escape'
// Returns: true

checkHotkey('Ctl+K')
// Console: [hotkeys] Invalid hotkey 'Ctl+K': unknown-modifier 'Ctl'
// Returns: false

PreviousvalidateHotkey

NextassertValidHotkey