Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WorkspaceEvent

A workspace event.

Hierarchy

  • Disposable
    • WorkspaceEvent

Index

Constructors

Properties

Methods

Constructors

constructor

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

    Parameters

    • callOnDispose: Function

      Function that disposes something.

    Returns WorkspaceEvent

Properties

execute

execute: function

Executes the event.

param

The type for what the event should be executed.

param

One or more arguments for the execution.

Type declaration

    • (type: string, ...args: any[]): void | PromiseLike<void>

    • Parameters

      • type: string
      • Rest ...args: any[]

      Returns void | PromiseLike<void>

type

type: string

Gets the type.

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