Interface Action<T>

interface Action {
    description?: string;
    forUser?: boolean;
    handler: ActionHandler<T>;
    keys?: null | (string | number)[];
    name: T;
    when?: (() => boolean);
}

Type Parameters

  • T extends string = string

Properties

description? forUser? handler keys? name when?

Properties

Optional description

description?: string

Description

Optional forUser

forUser?: boolean

user can set keybinding or list in action manager

handler

handler: ActionHandler<T>

Handler

Optional keys

keys?: null | (string | number)[]

Associate shortcuts

name

name: T

Name

Optional when

when?: (() => boolean)

Type declaration

    • (): boolean

    • When should execute handler

      Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc