@zturnlibs/ztron-api

---

global-shortcut#

Variables#

globalShortcut#

const globalShortcut: object

Defined in: global-shortcut.ts:56

Type Declaration#

isRegistered#

isRegistered: (id) => Promise<boolean>

是否已有此 id 的快捷键处于注册状态。

Parameters#

id#

string

Returns#

Promise<boolean>

onShortcut#

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

监听全局快捷键触发。

Parameters#

handler#

(event) => void

Returns#

Promise<() => Promise<void>>

register#

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

注册一个全局热键。

Parameters#

id#

string

accelerator#

string

Returns#

Promise<boolean>

registerAll#

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

一次调用批量注册热键（上游 registerAll）。按顺序返回每条的成功标志。

Parameters#

entries#

object[]

Returns#

Promise<boolean[]>

unregister#

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

按 id 注销之前注册的热键。

Parameters#

id#

string

Returns#

Promise<boolean>

unregisterAll#

unregisterAll: () => Promise<boolean>

注销本进程注册的全部热键（上游同名）。

Returns#

Promise<boolean>

Functions#

isRegistered()#

isRegistered(id): Promise<boolean>

Defined in: global-shortcut.ts:40

是否已有此 id 的快捷键处于注册状态。

Parameters#

id#

string

Returns#

Promise<boolean>

---

onShortcut()#

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

Defined in: global-shortcut.ts:48

监听全局快捷键触发。handler 收到 registerShortcut 注册时用的快捷键 id。

Parameters#

handler#

(event) => void

Returns#

Promise<() => Promise<void>>

---

registerAll()#

registerAll(entries): Promise<boolean[]>

Defined in: global-shortcut.ts:28

一次调用批量注册热键（上游 registerAll）。按顺序返回每条的成功标志。

Parameters#

entries#

object[]

Returns#

Promise<boolean[]>

---

registerShortcut()#

registerShortcut(id, accelerator): Promise<boolean>

Defined in: global-shortcut.ts:12

注册一个全局热键。accelerator 形如 Cmd+Shift+K、Ctrl+Alt+1、F5 等。返回 OS 是否接受了这次注册。

Parameters#

id#

string

accelerator#

string

Returns#

Promise<boolean>

---

unregisterAll()#

unregisterAll(): Promise<boolean>

Defined in: global-shortcut.ts:35

注销本进程注册的全部热键（上游同名）。

Returns#

Promise<boolean>

---

unregisterShortcut()#

unregisterShortcut(id): Promise<boolean>

Defined in: global-shortcut.ts:20

按 id 注销之前注册的热键。

Parameters#

id#

string

Returns#

Promise<boolean>