@zturnlibs/ztron-api

---

global-shortcut#

Variables#

globalShortcut#

const globalShortcut: object

Defined in: global-shortcut.ts:56

Type Declaration#

isRegistered#

isRegistered: (id) => Promise<boolean>

Whether a shortcut with this id is currently registered.

Parameters#

id#

string

Returns#

Promise<boolean>

onShortcut#

onShortcut: (handler) => Promise<() => Promise<void>>

Listens to global shortcut activations. The handler receives the shortcut id registered via registerShortcut.

Parameters#

handler#

(event) => void

Returns#

Promise<() => Promise<void>>

register#

register: (id, accelerator) => Promise<boolean> = registerShortcut

Registers a global hotkey. Accelerator format: Cmd+Shift+K, Ctrl+Alt+1, F5, etc. Returns whether the OS accepted the registration.

Parameters#

id#

string

accelerator#

string

Returns#

Promise<boolean>

registerAll#

registerAll: (entries) => Promise<boolean[]>

Registers a batch of hotkeys in one call (upstream registerAll). Returns per-entry success flags, in order.

Parameters#

entries#

object[]

Returns#

Promise<boolean[]>

unregister#

unregister: (id) => Promise<boolean> = unregisterShortcut

Unregisters a previously registered hotkey by id.

Parameters#

id#

string

Returns#

Promise<boolean>

unregisterAll#

unregisterAll: () => Promise<boolean>

Unregisters every hotkey registered by this process (upstream name).

Returns#

Promise<boolean>

Functions#

isRegistered()#

isRegistered(id): Promise<boolean>

Defined in: global-shortcut.ts:40

Whether a shortcut with this id is currently registered.

Parameters#

id#

string

Returns#

Promise<boolean>

---

onShortcut()#

onShortcut(handler): Promise<() => Promise<void>>

Defined in: global-shortcut.ts:48

Listens to global shortcut activations. The handler receives the shortcut id registered via registerShortcut.

Parameters#

handler#

(event) => void

Returns#

Promise<() => Promise<void>>

---

registerAll()#

registerAll(entries): Promise<boolean[]>

Defined in: global-shortcut.ts:28

Registers a batch of hotkeys in one call (upstream registerAll). Returns per-entry success flags, in order.

Parameters#

entries#

object[]

Returns#

Promise<boolean[]>

---

registerShortcut()#

registerShortcut(id, accelerator): Promise<boolean>

Defined in: global-shortcut.ts:12

Registers a global hotkey. Accelerator format: Cmd+Shift+K, Ctrl+Alt+1, F5, etc. Returns whether the OS accepted the registration.

Parameters#

id#

string

accelerator#

string

Returns#

Promise<boolean>

---

unregisterAll()#

unregisterAll(): Promise<boolean>

Defined in: global-shortcut.ts:35

Unregisters every hotkey registered by this process (upstream name).

Returns#

Promise<boolean>

---

unregisterShortcut()#

unregisterShortcut(id): Promise<boolean>

Defined in: global-shortcut.ts:20

Unregisters a previously registered hotkey by id.

Parameters#

id#

string

Returns#

Promise<boolean>