HotkeyMetadata
interface exported by @mwillbanks/tuil-hotkeys.
interface
Public interface exported by @mwillbanks/tuil-hotkeys.
export interface HotkeyMetadata {
readonly title?: string;
readonly description?: string;
readonly category?: string;
readonly commandId?: string;
readonly visibleInHelp?: boolean;
readonly platforms?: readonly NodeJS.Platform[];
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
title | string | undefined | No | The title member uses the string | undefined contract. | — |
description | string | undefined | No | The description member uses the string | undefined contract. | — |
category | string | undefined | No | The category member uses the string | undefined contract. | — |
commandId | string | undefined | No | The commandId member uses the string | undefined contract. | — |
visibleInHelp | boolean | undefined | No | The visibleInHelp member uses the boolean | undefined contract. | — |
platforms | readonly NodeJS.Platform[] | undefined | No | The platforms member uses the readonly NodeJS.Platform[] | 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.
Related types
No package-local related types.
Source
View the secondary source reference