Type Alias CommandExecute<TName>

Type Declaration

• • <
        T extends
            AnyInputEvent
            | MinimalInputEvent = AnyInputEvent | MinimalInputEvent,
    >(
        args: {
            command: Command<TName>;
            context: Context;
            event?: T;
            isKeydown: boolean;
            manager?: Manager;
            shortcut?: Shortcut<TName>;
        },
    ): void

  • Type Parameters

    • T extends AnyInputEvent | MinimalInputEvent = AnyInputEvent | MinimalInputEvent

    Parameters

    • args: {
          command: Command<TName>;
          context: Context;
          event?: T;
          isKeydown: boolean;
          manager?: Manager;
          shortcut?: Shortcut<TName>;
      }

      • command: Command<TName>

      • context: Context

      • Optionalevent?: T

        The event that triggered the command. It might be undefined if a virtual event triggered the key. It's typed as AnyInputEvent because you might also receive Emulated events from the Emulator if you use it. If you don't you can safely ignore the EmulatedEvent type or type the execute function as CommandExecute<AnyInputEvent>

      • isKeydown: boolean

      • Optionalmanager?: Manager

        The manager might be undefined. This is to allow calling the command manually without it.

      • Optionalshortcut?: Shortcut<TName>

    Returns void