Skip to content

Commit 590cd36

Browse files
committed
Update global-shortcut module
1 parent 1541baf commit 590cd36

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

github-electron/github-electron.global-shortcut.d.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,18 @@
44
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
55

66
declare namespace Electron {
7-
7+
/**
8+
* The globalShortcut module can register/unregister a global keyboard shortcut
9+
* with the operating system so that you can customize the operations for various shortcuts.
10+
* Note: The shortcut is global; it will work even if the app does not have the keyboard focus.
11+
* You should not use this module until the ready event of the app module is emitted.
12+
*/
813
interface GlobalShortcut {
914
/**
1015
* Registers a global shortcut of accelerator.
1116
* @param accelerator Represents a keyboard shortcut. It can contain modifiers
1217
* and key codes, combined by the "+" character.
1318
* @param callback Called when the registered shortcut is pressed by the user.
14-
* @returns {}
1519
*/
1620
register(accelerator: string, callback: Function): void;
1721
/**

0 commit comments

Comments
 (0)