Class UriAwareCommandHandler<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.

Type Parameters

T extends MaybeArray<URI>

Hierarchy (View Summary)

UriAwareCommandHandler
- WorkspaceRootUriAwareCommandHandler

Implements

UriCommandHandler<T>

Index

Constructors

Properties

handler options? selectionService

Methods

execute getArgsWithUri getUri isEnabled isMulti isVisible

Constructors

constructor

new UriAwareCommandHandler<T extends MaybeArray<URI>>(
    selectionService: SelectionService,
    handler: UriCommandHandler<T>,
    options?: UriAwareCommandHandler.Options,
): UriAwareCommandHandler<T>
Type Parameters
- T extends MaybeArray<URI>
Parameters
- selectionService: SelectionService
- handler: UriCommandHandler<T>
- Optionaloptions: UriAwareCommandHandler.Options
Returns UriAwareCommandHandler<T>
Deprecated
since 1.6.0. Please use UriAwareCommandHandler.MonoSelect or UriAwareCommandHandler.MultiSelect.
- Defined in packages/core/src/common/uri-command-handler.ts:53

Properties

`Protected` `Readonly`handler

handler: UriCommandHandler<T>

`Protected` `Optional` `Readonly`options

options?: UriAwareCommandHandler.Options

`Protected` `Readonly`selectionService

selectionService: SelectionService

Methods

execute

execute(...args: any[]): undefined | object
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- ...args: any[]
Returns undefined | object
Implementation of UriCommandHandler.execute
- Defined in packages/core/src/common/uri-command-handler.ts:87

`Protected`getArgsWithUri

getArgsWithUri(...args: any[]): [undefined | T, ...any[]]
Parameters
- ...args: any[]
Returns [undefined | T, ...any[]]
- Defined in packages/core/src/common/uri-command-handler.ts:78

`Protected`getUri

getUri(...args: any[]): undefined | T
Parameters
- ...args: any[]
Returns undefined | T
- Defined in packages/core/src/common/uri-command-handler.ts:59

isEnabled

isEnabled(...args: any[]): boolean
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- ...args: any[]
Returns boolean
Implementation of UriCommandHandler.isEnabled
- Defined in packages/core/src/common/uri-command-handler.ts:103

`Protected`isMulti

isMulti(): undefined | boolean
Returns undefined | boolean
- Defined in packages/core/src/common/uri-command-handler.ts:114

isVisible

isVisible(...args: any[]): boolean
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- ...args: any[]
Returns boolean
Implementation of UriCommandHandler.isVisible
- Defined in packages/core/src/common/uri-command-handler.ts:92