diff --git a/github-electron/github-electron.global-shortcut.d.ts b/github-electron/github-electron.global-shortcut.d.ts index b0d1a3c9be..6ea804b722 100644 --- a/github-electron/github-electron.global-shortcut.d.ts +++ b/github-electron/github-electron.global-shortcut.d.ts @@ -4,14 +4,18 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare namespace Electron { - + /** + * The globalShortcut module can register/unregister a global keyboard shortcut + * with the operating system so that you can customize the operations for various shortcuts. + * Note: The shortcut is global; it will work even if the app does not have the keyboard focus. + * You should not use this module until the ready event of the app module is emitted. + */ interface GlobalShortcut { /** * Registers a global shortcut of accelerator. * @param accelerator Represents a keyboard shortcut. It can contain modifiers * and key codes, combined by the "+" character. * @param callback Called when the registered shortcut is pressed by the user. - * @returns {} */ register(accelerator: string, callback: Function): void; /**