Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WorkspaceCommand

A workspace command.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new Disposable calling the provided function on dispose.

    Parameters

    • callOnDispose: Function

      Function that disposes something.

    Returns WorkspaceCommand

Properties

Optional button

button: StatusBarItem

The optional button.

command

command: Disposable

The command instance.

description

description: string

A description of the command.

execute

execute: function

Executes the command.

param

The execution context.

param

One or more argument for the execution.

returns

The result of the execution.

Type declaration

id

id: string

The ID of the command.

item

item: CommandItem

The item from the settings.

name

name: string

The name for display.

Methods

dispose

  • dispose(): any

  • Dispose this object.

    Returns any

Static from

  • from(...disposableLikes: object[]): Disposable

  • Combine many disposable-likes into one. Use this method when having objects with a dispose function which are not instances of Disposable.

    Parameters

    • Rest ...disposableLikes: object[]

      Objects that have at least a dispose-function member.

    Returns Disposable

    Returns a new disposable which, upon dispose, will dispose all provided disposables.

Generated using TypeDoc