HSHotkey
TypeObject representing a system-wide hotkey. You should not create these objects directly, but rather, use the methods in hs.hotkey to instantiate these.
Properties
message
string
An optional description of what this hotkey does, or null if none was set.
When set, it is shown as an on-screen toast via `hs.ui.alert()` (duration controlled by
`hs.hotkey.alertDuration`) just before the hotkey's callback runs: before the pressed
callback if one exists, otherwise before the released callback if one exists.
onRepeat
function | null
The callback function to be called repeatedly while the hotkey is held down, or null to remove it. Repeats at the system keyboard-repeat delay/interval, matching how held-down keys repeat elsewhere in macOS.
onPressed
function | null
The callback function to be called when the hotkey is pressed, or null to remove it
onReleased
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.hotkey.bind(["cmd"], "h", () => {})
hk.enable()disable() -> None
Disable the hotkey
Declaration
disable() -> NoneReturns
None
Example
const hk = hs.hotkey.bind(["cmd"], "h", () => {})
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.hotkey.bind(["cmd"], "h", () => {})
console.log(hk.isEnabled())destroy() -> None
Disable and permanently remove this hotkey, releasing all associated resources
Declaration
destroy() -> NoneReturns
None
Example
const hk = hs.hotkey.bind(["cmd"], "h", () => {})
hk.destroy()