Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommandRegistry

The command registry manages commands and handlers.

Hierarchy

  • CommandRegistry

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected Readonly _commands

_commands: {} = {}

Type declaration

Protected Readonly _handlers

_handlers: {} = {}

Type declaration

Protected _recent

_recent: string[] = []

Protected Readonly contributionProvider

contributionProvider: ContributionProvider<CommandContribution>

Protected fireDidChange

fireDidChange: ((...arguments: []) => Promise<void>) = ...

Type declaration

    • (...arguments: []): Promise<void>

    • Debounce promise-returning & async functions.

      example
      import pDebounce = require('p-debounce');

      const expensiveCall = async input => input;

      const debouncedFn = pDebounce(expensiveCall, 200);

      for (const i of [1, 2, 3]) {
      debouncedFn(i).then(console.log);
      }
      //=> 3
      //=> 3
      //=> 3

      Parameters

      • Rest ...arguments: []

      Returns Promise<void>

      A function that delays calling fn until after wait milliseconds have elapsed since the last time it was called.

Readonly onCommandsChanged

onCommandsChanged: Event<void> = ...

Protected Readonly onCommandsChangedEmitter

onCommandsChangedEmitter: Emitter<void> = ...

Readonly onDidExecuteCommand

onDidExecuteCommand: Event<CommandEvent> = ...

Protected Readonly onDidExecuteCommandEmitter

onDidExecuteCommandEmitter: Emitter<CommandEvent> = ...

Readonly onWillExecuteCommand

onWillExecuteCommand: Event<WillExecuteCommandEvent> = ...

Protected Readonly onWillExecuteCommandEmitter

onWillExecuteCommandEmitter: Emitter<WillExecuteCommandEvent> = ...

Protected Readonly toUnregisterCommands

toUnregisterCommands: Map<string, Disposable> = ...

Accessors

commandIds

  • get commandIds(): string[]

commands

recent

Methods

addRecentCommand

clearCommandHistory

  • clearCommandHistory(): void

Protected doFireDidChange

  • doFireDidChange(): void

Protected doRegisterCommand

executeCommand

  • executeCommand<T>(commandId: string, ...args: any[]): Promise<undefined | T>

  • Execute the active handler for the given command and arguments.

    Reject if a command cannot be executed.

    Type Parameters

    • T

    Parameters

    • commandId: string
    • Rest ...args: any[]

    Returns Promise<undefined | T>

Protected fireWillExecuteCommand

  • fireWillExecuteCommand(commandId: string, args?: any[]): Promise<void>

getActiveHandler

  • getActiveHandler(commandId: string, ...args: any[]): undefined | CommandHandler

getAllCommands

getAllHandlers

getCommand

  • getCommand(id: string): undefined | Command

getToggledHandler

  • getToggledHandler(commandId: string, ...args: any[]): undefined | CommandHandler

getVisibleHandler

  • getVisibleHandler(commandId: string, ...args: any[]): undefined | CommandHandler

isEnabled

  • isEnabled(command: string, ...args: any[]): boolean

isToggled

  • isToggled(command: string, ...args: any[]): boolean

isVisible

  • isVisible(command: string, ...args: any[]): boolean

onStart

  • onStart(): void

registerCommand

registerHandler

  • Register the given handler for the given command identifier.

    If there is already a handler for the given command then the given handler is registered as more specific, and has higher priority during enablement, visibility and toggle state evaluations.

    Parameters

    Returns Disposable

unregisterCommand

  • unregisterCommand(command: Command): void
  • unregisterCommand(id: string): void