Function bindHotkey

bindHotkey(
    mods: string[],
    key: string,
    callbackPressed: (() => void) | null,
    callbackReleased: (() => void) | null,
): HSEventTapHotkey | null
Bind a keyboard shortcut using an event tap. Unlike hs.hotkey.bind(), this supports the fn modifier and left/right modifier key distinction (e.g. leftCmd, rightAlt). The hotkey is active immediately and consumes (suppresses) the key events. It's important to note that this a much heavier-weight tool than hs.hotkey - every single key you press will be examined by Hammerspoon to see if it matches one of the EventTap hotkeys (where hs.hotkey relies on macOS to efficiently deliver only matching keypresses). Please consider this when choosing to use hs.eventtap for hotkeys. Requires Accessibility permission. ctrl, fn) and side-specific names (leftCmd, rightCmd, leftAlt, rightAlt, leftCtrl, rightCtrl, leftShift, rightShift).
Parameters
- mods: string[]
  An array of modifier key strings. Supports generic names (cmd, shift, alt,
- key: string
  The key name or character (e.g., "a", "space", "f1")
- callbackPressed: (() => void) | null
  Called when the key combination is pressed, or null
- callbackReleased: (() => void) | null
  Called when the key combination is released, or null
Returns HSEventTapHotkey | null
An HSEventTapHotkey object, or null if binding failed