Interface UriCommandHandler<T>

A command handler is an implementation of a command.

A command can have multiple handlers but they should be active in different contexts, otherwise first active will be executed.

interface UriCommandHandler<T extends MaybeArray<URI>> {
    onDidChangeEnabled?: Event<void>;
    execute(uri: T, ...args: any[]): any;
    isEnabled?(uri: T, ...args: any[]): boolean;
    isToggled?(...args: any[]): boolean;
    isVisible?(uri: T, ...args: any[]): boolean;
}

Type Parameters

T extends MaybeArray<URI>

Hierarchy (View Summary)

CommandHandler
- UriCommandHandler
  - SingleUriCommandHandler
  - MultiUriCommandHandler

Implemented by

Index

Properties

onDidChangeEnabled?

Methods

execute isEnabled? isToggled? isVisible?

Properties

`Optional`onDidChangeEnabled

onDidChangeEnabled?: Event<void>

Methods

execute

execute(uri: T, ...args: any[]): any
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- uri: T
- ...args: any[]
Returns any
Overrides CommandHandler.execute
- Defined in packages/core/src/common/uri-command-handler.ts:27

`Optional`isEnabled

isEnabled?(uri: T, ...args: any[]): boolean
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- uri: T
- ...args: any[]
Returns boolean
Overrides CommandHandler.isEnabled
- Defined in packages/core/src/common/uri-command-handler.ts:29

`Optional`isToggled

isToggled?(...args: any[]): boolean
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- ...args: any[]
Returns boolean
Inherited from CommandHandler.isToggled
- Defined in packages/core/src/common/command.ts:139

`Optional`isVisible

isVisible?(uri: T, ...args: any[]): boolean
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- uri: T
- ...args: any[]
Returns boolean
Overrides CommandHandler.isVisible
- Defined in packages/core/src/common/uri-command-handler.ts:31