HSEventTapHotkey
TypeA keyboard shortcut binding backed by an event tap. Supports fn modifier and left/right modifier
key distinction. Obtain instances via hs.eventtap.bindHotkey() — do not instantiate directly.
Properties
callbackPressed
function | null
The callback function to be called when the hotkey is pressed, or null to remove it
callbackReleased
function | null
The callback function to be called when the hotkey is released, or null to remove it
Methods
enable() -> boolean
Enable the hotkey
Declaration
enable() -> booleanReturns
boolean
True if the hotkey was enabled, otherwise False
Example
const hk = hs.eventtap.bindHotkey(["fn"], "f1", () => {}, null)
hk.enable()disable() -> None
Disable the hotkey
Declaration
disable() -> NoneReturns
None
Example
const hk = hs.eventtap.bindHotkey(["fn"], "f1", () => {}, null)
hk.disable()isEnabled() -> boolean
Check if the hotkey is currently enabled
Declaration
isEnabled() -> booleanReturns
boolean
True if the hotkey is enabled, otherwise False
Example
const hk = hs.eventtap.bindHotkey(["fn"], "f1", () => {}, null)
console.log(hk.isEnabled())