Class CommandRegistry

The command registry manages commands and handlers.

Hierarchy

CommandRegistry

Implements

CommandService

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CommandRegistry(contributionProvider: ContributionProvider<CommandContribution>): CommandRegistry

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

Properties

Protected Readonly _commands

_commands: {} = {}

Type declaration

[id: string]: Command

Protected Readonly _handlers

_handlers: {} = {}

Type declaration

[id: string]: CommandHandler[]

Protected _recent

_recent: Command[] = []

Protected Readonly contributionProvider

contributionProvider: ContributionProvider<CommandContribution>

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[]

- Defined in packages/core/src/common/command.ts:413
Get all registered commands identifiers.

Returns string[]

commands

get commands(): Command[]

- Defined in packages/core/src/common/command.ts:392
Get all registered commands.

Returns Command[]

recent

get recent(): Command[]
set recent(commands: Command[]): void

- Defined in packages/core/src/common/command.ts:420
Get the list of recently used commands.

Returns Command[]
- Defined in packages/core/src/common/command.ts:428
Set the list of recently used commands.

Parameters
- commands: Command[]
  
  the list of recently used commands.
Returns void

Methods

addRecentCommand

addRecentCommand(recent: Command | Command[]): void

- Defined in packages/core/src/common/command.ts:438
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

clearCommandHistory

clearCommandHistory(): void

- Defined in packages/core/src/common/command.ts:454
Clear the list of recently used commands.

Returns void

Protected doRegisterCommand

doRegisterCommand(command: Command): Disposable

- Defined in packages/core/src/common/command.ts:222
Parameters
- command: Command
Returns Disposable

executeCommand

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

Implementation of CommandService.executeCommand
- Defined in packages/core/src/common/command.ts:304
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>

- Defined in packages/core/src/common/command.ts:316
Parameters
- commandId: string
- args: any[] = []
Returns Promise<void>

getActiveHandler

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

- Defined in packages/core/src/common/command.ts:344
Get an active handler for the given command or undefined.

Parameters
- commandId: string
- Rest ...args: any[]
Returns undefined | CommandHandler

getAllHandlers

getAllHandlers(commandId: string): CommandHandler[]

- Defined in packages/core/src/common/command.ts:384
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[]

getCommand

getCommand(id: string): undefined | Command

- Defined in packages/core/src/common/command.ts:406
Get a command for the given command identifier.

Parameters
- id: string
Returns undefined | Command

getToggledHandler

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

- Defined in packages/core/src/common/command.ts:364
Get a toggled handler for the given command or undefined.

Parameters
- commandId: string
- Rest ...args: any[]
Returns undefined | CommandHandler

getVisibleHandler

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

- Defined in packages/core/src/common/command.ts:324
Get a visible handler for the given command or undefined.

Parameters
- commandId: string
- Rest ...args: any[]
Returns undefined | CommandHandler

isEnabled

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

- Defined in packages/core/src/common/command.ts:278
Test whether there is an active handler for the given command.

Parameters
- command: string
- Rest ...args: any[]
Returns boolean

isToggled

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

- Defined in packages/core/src/common/command.ts:294
Test whether there is a toggled handler for the given command.

Parameters
- command: string
- Rest ...args: any[]
Returns boolean

isVisible

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

- Defined in packages/core/src/common/command.ts:286
Test whether there is a visible handler for the given command.

Parameters
- command: string
- Rest ...args: any[]
Returns boolean

onStart

onStart(): void

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

registerCommand

registerCommand(command: Command, handler?: CommandHandler): Disposable

- Defined in packages/core/src/common/command.ts:208
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

registerHandler

registerHandler(commandId: string, handler: CommandHandler): Disposable

- Defined in packages/core/src/common/command.ts:258
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

unregisterCommand

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

- Defined in packages/core/src/common/command.ts:236
Unregister command from the registry

Parameters
- command: Command
Returns void
- Defined in packages/core/src/common/command.ts:242
Unregister command from the registry

Parameters
- id: string
Returns void