Methods for registering/unregistering global keyboard shortcuts for a ToDesktop application.

# Remarks

This package exposes a number of methods for registering/unregistering global keyboard shortcuts for a ToDesktop application.

Note: The shortcut is global; it will work even if the app does not have the keyboard focus. This module cannot be used before the ready event of the app module is emitted.

# Functions

# isRegistered()

Whether this application has registered accelerator.

Signature:

        import { globalShortcut } from "@todesktop/client-core"
globalShortcut.isRegistered(accelerator: string): Promise<boolean>;

      

# Parameters

Returns:

Promise<boolean>

# register()

Registers a global shortcut of accelerator.

Signature:

        import { globalShortcut } from "@todesktop/client-core"
globalShortcut.register(accelerator: string, handler: () => void): Promise<void>;

      

# Parameters

Returns:

Promise<void>

# unregister()

Unregisters a global shortcut of accelerator.

Signature:

        import { globalShortcut } from "@todesktop/client-core"
globalShortcut.unregister(accelerator: string): Promise<void>;

      

# Parameters

Returns:

Promise<void>

# unregisterAll()

Unregisters all global shortcuts.

Signature:

        import { globalShortcut } from "@todesktop/client-core"
globalShortcut.unregisterAll(): Promise<void>;

      

Returns:

Promise<void>