tuil
ReferencePackages@mwillbanks/tuil-hotkeysAPI

HotkeyDispatchContext

interface exported by @mwillbanks/tuil-hotkeys.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-hotkeys.

export interface HotkeyDispatchContext {
  readonly activeScopes?:
    | Partial<Record<HotkeyScope, string | true>>
    | (() => Partial<Record<HotkeyScope, string | true>>);
  readonly platform?: NodeJS.Platform;
  readonly onError?: (error: unknown) => void;
  readonly allowApplication?: boolean;
}

Members

MemberTypeRequiredDescriptionRelated types
activeScopesPartial<Record<HotkeyScope, string | true>> | (() => Partial<Record<HotkeyScope, string | true>>) | undefinedNoThe activeScopes member uses the Partial<Record<HotkeyScope, string | true>> | (() => Partial<Record<HotkeyScope, string | true>>) | undefined contract.HotkeyScope
platformNodeJS.Platform | undefinedNoThe platform member uses the NodeJS.Platform | undefined contract.
onError((error: unknown) => void) | undefinedNoThe onError member uses the ((error: unknown) => void) | undefined contract.
allowApplicationboolean | undefinedNoThe allowApplication member uses the boolean | undefined contract.

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-hotkeys

On this page