Class CommandRegistry

The command registry manages commands and handlers.

Implements

CommandService

Constructors

constructor

new CommandRegistry(contributionProvider): CommandRegistry
Parameters
- contributionProvider: ContributionProvider<CommandContribution>
Returns CommandRegistry
- Defined in packages/core/src/common/command.ts:210

Properties

`Protected` `Readonly` _commands

_commands: {
[id: string]: Command;
} = {}

Type declaration

[id: string]: Command

`Protected` `Readonly` _handlers

_handlers: {
[id: string]: CommandHandler[];
} = {}

Type declaration

[id: string]: CommandHandler[]

`Protected` _recent

_recent: string[] = []

`Protected` `Readonly` contributionProvider

contributionProvider: ContributionProvider<CommandContribution>

`Protected` fireDidChange

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

Type declaration

- (...arguments): Promise<void>
- Parameters
  - Rest ...arguments: []
  Returns Promise<void>

`Readonly` onCommandsChanged

onCommandsChanged: Event<void> = ...

`Protected` `Readonly` onCommandsChangedEmitter

onCommandsChangedEmitter: Emitter<void> = ...

`Readonly` onDidExecuteCommand

onDidExecuteCommand: Event<CommandEvent> = ...

An event is emitted when a command was executed.

`Protected` `Readonly` onDidExecuteCommandEmitter

onDidExecuteCommandEmitter: Emitter<CommandEvent> = ...

`Readonly` onWillExecuteCommand

onWillExecuteCommand: Event<WillExecuteCommandEvent> = ...

An event is emitted when a command is about to be executed.

It can be used to install or activate a command handler.

`Protected` `Readonly` onWillExecuteCommandEmitter

onWillExecuteCommandEmitter: Emitter<WillExecuteCommandEvent> = ...

`Protected` `Readonly` toUnregisterCommands

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

Accessors

commandIds

get commandIds(): string[]
Get all registered commands identifiers.

Returns string[]
- Defined in packages/core/src/common/command.ts:439

commands

get commands(): Command[]
Get all registered commands.

Returns Command[]
- Defined in packages/core/src/common/command.ts:425

recent

get recent(): Command[]
Get the list of recently used commands.

Returns Command[]
- Defined in packages/core/src/common/command.ts:446
set recent(commands): void
Set the list of recently used commands.
Parameters
- commands: Command[]
  the list of recently used commands.
Returns void
- Defined in packages/core/src/common/command.ts:461

Methods

addRecentCommand

addRecentCommand(recent): void
Adds a command to recently used list. Prioritizes commands that were recently executed to be most recent.
Parameters
- recent: Command | Command[]
  a recent command, or array of recent commands.
Returns void
- Defined in packages/core/src/common/command.ts:471

clearCommandHistory

clearCommandHistory(): void
Clear the list of recently used commands.

Returns void
- Defined in packages/core/src/common/command.ts:485

`Protected` doFireDidChange

doFireDidChange(): void
Returns void
- Defined in packages/core/src/common/command.ts:303

`Protected` doRegisterCommand

doRegisterCommand(command): Disposable
Parameters
- command: Command
Returns Disposable
- Defined in packages/core/src/common/command.ts:247

executeCommand

executeCommand<T>(commandId, ...args): 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>
Implementation of CommandService.executeCommand
- Defined in packages/core/src/common/command.ts:337

`Protected` fireWillExecuteCommand

fireWillExecuteCommand(commandId, args?): Promise<void>
Parameters
- commandId: string
- args: any[] = []
Returns Promise<void>
- Defined in packages/core/src/common/command.ts:349

getActiveHandler

getActiveHandler(commandId, ...args): undefined | CommandHandler
Get an active handler for the given command or undefined.
Parameters
- commandId: string
- Rest ...args: any[]
Returns undefined | CommandHandler
- Defined in packages/core/src/common/command.ts:377

getAllCommands

getAllCommands(): IterableIterator<Readonly<Command & {
handlers: CommandHandler[];
}>>
Returns IterableIterator<Readonly<Command & {
handlers: CommandHandler[];
}>>
- Defined in packages/core/src/common/command.ts:222

getAllHandlers

getAllHandlers(commandId): CommandHandler[]
Returns with all handlers for the given command. If the command does not have any handlers, or the command is not registered, returns an empty array.
Parameters
- commandId: string
Returns CommandHandler[]
- Defined in packages/core/src/common/command.ts:417

getCommand

getCommand(id): undefined | Command
Get a command for the given command identifier.
Parameters
- id: string
Returns undefined | Command
- Defined in packages/core/src/common/command.ts:432

getToggledHandler

getToggledHandler(commandId, ...args): undefined | CommandHandler
Get a toggled handler for the given command or undefined.
Parameters
- commandId: string
- Rest ...args: any[]
Returns undefined | CommandHandler
- Defined in packages/core/src/common/command.ts:397

getVisibleHandler

getVisibleHandler(commandId, ...args): undefined | CommandHandler
Get a visible handler for the given command or undefined.
Parameters
- commandId: string
- Rest ...args: any[]
Returns undefined | CommandHandler
- Defined in packages/core/src/common/command.ts:357

isEnabled

isEnabled(command, ...args): boolean
Test whether there is an active handler for the given command.
Parameters
- command: string
- Rest ...args: any[]
Returns boolean
- Defined in packages/core/src/common/command.ts:311

isToggled

isToggled(command, ...args): boolean
Test whether there is a toggled handler for the given command.
Parameters
- command: string
- Rest ...args: any[]
Returns boolean
- Defined in packages/core/src/common/command.ts:327

isVisible

isVisible(command, ...args): boolean
Test whether there is a visible handler for the given command.
Parameters
- command: string
- Rest ...args: any[]
Returns boolean
- Defined in packages/core/src/common/command.ts:319

onStart

onStart(): void
Returns void
- Defined in packages/core/src/common/command.ts:215

registerCommand

registerCommand(command, handler?): Disposable
Register the given command and handler if present.

Throw if a command is already registered for the given command identifier.
Parameters
- command: Command
- Optional handler: CommandHandler
Returns Disposable
- Defined in packages/core/src/common/command.ts:233

registerHandler

registerHandler(commandId, handler): Disposable
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
- commandId: string
- handler: CommandHandler
Returns Disposable
- Defined in packages/core/src/common/command.ts:283

unregisterCommand

unregisterCommand(command): void
Unregister command from the registry
Parameters
- command: Command
Returns void
- Defined in packages/core/src/common/command.ts:261
unregisterCommand(id): void
Unregister command from the registry
Parameters
- id: string
Returns void
- Defined in packages/core/src/common/command.ts:267

Class CommandRegistry

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CommandRegistry

Properties

Protected Readonly _commands

Type declaration

[id: string]: Command

Protected Readonly _handlers

Type declaration

[id: string]: CommandHandler[]

Protected _recent

Protected Readonly contributionProvider

Protected fireDidChange

Type declaration

Parameters

Returns Promise<void>

Readonly onCommandsChanged

Protected Readonly onCommandsChangedEmitter

Readonly onDidExecuteCommand

Protected Readonly onDidExecuteCommandEmitter

Readonly onWillExecuteCommand

Protected Readonly onWillExecuteCommandEmitter

Protected Readonly toUnregisterCommands

Accessors

commandIds

Returns string[]

commands

Returns Command[]

recent

Returns Command[]

Parameters

Returns void

Methods

addRecentCommand

Parameters

Returns void

clearCommandHistory

Returns void

Protected doFireDidChange

Returns void

Protected doRegisterCommand

Parameters

Returns Disposable

executeCommand

Type Parameters

Parameters

Returns Promise<undefined | T>

Protected fireWillExecuteCommand

Parameters

Returns Promise<void>

getActiveHandler

Parameters

Returns undefined | CommandHandler

getAllCommands

Returns IterableIterator<Readonly<Command & { handlers: CommandHandler[]; }>>

getAllHandlers

Parameters

Returns CommandHandler[]

getCommand

Parameters

Returns undefined | Command

getToggledHandler

Parameters

Returns undefined | CommandHandler

getVisibleHandler

Parameters

Returns undefined | CommandHandler

isEnabled

Parameters

Returns boolean

isToggled

Parameters

`Protected` `Readonly` _commands

`Protected` `Readonly` _handlers

`Protected` _recent

`Protected` `Readonly` contributionProvider

`Protected` fireDidChange

`Readonly` onCommandsChanged

`Protected` `Readonly` onCommandsChangedEmitter

`Readonly` onDidExecuteCommand

`Protected` `Readonly` onDidExecuteCommandEmitter

`Readonly` onWillExecuteCommand

`Protected` `Readonly` onWillExecuteCommandEmitter

`Protected` `Readonly` toUnregisterCommands

`Protected` doFireDidChange

`Protected` doRegisterCommand

`Protected` fireWillExecuteCommand

Returns IterableIterator<Readonly<Command & {
handlers: CommandHandler[];
}>>