Class CommandRegistry

The command registry manages commands and handlers.

Implements

CommandService

Constructors

constructor

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

Properties

`Protected` `Readonly`_commands

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

`Protected` `Readonly`_handlers

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

`Protected`_recent

_recent: string[] = []

List of recently used commands.

`Protected` `Readonly`contributionProvider

contributionProvider: ContributionProvider<CommandContribution>

`Protected`fireDidChange

fireDidChange: (...arguments: []) => 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: Command[]): 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: Command | Command[]): 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: Command): Disposable
Parameters
- command: Command
Returns Disposable
- Defined in packages/core/src/common/command.ts:247

executeCommand

executeCommand<T>(commandId: string, ...args: any[]): Promise<undefined | T>
eslint-disable-next-line @typescript-eslint/no-explicit-any
Type Parameters
- T
Parameters
- commandId: string
- ...args: any[]
Returns Promise<undefined | T>
Implementation of CommandService.executeCommand
- Defined in packages/core/src/common/command.ts:337

`Protected`fireWillExecuteCommand

fireWillExecuteCommand(commandId: string, args?: any[]): Promise<void>
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- commandId: string
- args: any[] = []
Returns Promise<void>
- Defined in packages/core/src/common/command.ts:349

getActiveHandler

getActiveHandler(commandId: string, ...args: any[]): undefined | CommandHandler
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- commandId: string
- ...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: string): 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: string): 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: string, ...args: any[]): undefined | CommandHandler
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- commandId: string
- ...args: any[]
Returns undefined | CommandHandler
- Defined in packages/core/src/common/command.ts:397

getVisibleHandler

getVisibleHandler(commandId: string, ...args: any[]): undefined | CommandHandler
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- commandId: string
- ...args: any[]
Returns undefined | CommandHandler
- Defined in packages/core/src/common/command.ts:357

isEnabled

isEnabled(command: string, ...args: any[]): boolean
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- command: string
- ...args: any[]
Returns boolean
- Defined in packages/core/src/common/command.ts:311

isToggled

isToggled(command: string, ...args: any[]): boolean
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- command: string
- ...args: any[]
Returns boolean
- Defined in packages/core/src/common/command.ts:327

isVisible

isVisible(command: string, ...args: any[]): boolean
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- command: string
- ...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: Command, handler?: CommandHandler): Disposable
Register the given command and handler if present.

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

registerHandler

registerHandler(commandId: string, handler: CommandHandler): 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: Command): void
Unregister command from the registry
Parameters
- command: Command
Returns void
- Defined in packages/core/src/common/command.ts:261
unregisterCommand(id: string): 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

Protected Readonly_handlers

Protected_recent

Protected ReadonlycontributionProvider

ProtectedfireDidChange

ReadonlyonCommandsChanged

Protected ReadonlyonCommandsChangedEmitter

ReadonlyonDidExecuteCommand

Protected ReadonlyonDidExecuteCommandEmitter

ReadonlyonWillExecuteCommand

Protected ReadonlyonWillExecuteCommandEmitter

Protected ReadonlytoUnregisterCommands

Accessors

commandIds

Returns string[]

commands

Returns Command[]

recent

Returns Command[]

Parameters

Returns void

Methods

addRecentCommand

Parameters

Returns void

clearCommandHistory

Returns void

ProtecteddoFireDidChange

Returns void

ProtecteddoRegisterCommand

Parameters

Returns Disposable

executeCommand

Type Parameters

Parameters

Returns Promise<undefined | T>

ProtectedfireWillExecuteCommand

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

Returns boolean

isVisible

Parameters

Returns boolean

onStart

Returns void

registerCommand

`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