Class Disposable

Hierarchy

Disposable

Index

Constructors

constructor

Methods

Constructors

constructor

new Disposable(func: (() => void)): Disposable
new Disposable(callOnDispose: Function): Disposable

- Defined in packages/plugin/src/theia.d.ts:40
Parameters
- func: (() => void)
  - - (): void
    - Returns void
Returns Disposable
- Defined in packages/plugin/src/theia.d.ts:64
Creates a new Disposable calling the provided function on dispose.

Parameters
- callOnDispose: Function
  
  Function that disposes something.
Returns Disposable

Methods

dispose

dispose(): void

- Defined in packages/plugin/src/theia.d.ts:44
Dispose this object.

Returns void

Static create

create(func: (() => void)): Disposable

- Defined in packages/plugin/src/theia.d.ts:46
Parameters
- func: (() => void)
  - - (): void
    - Returns void
Returns Disposable

Static from

from(...disposableLikes: { dispose: any }[]): Disposable

- Defined in packages/plugin/src/theia.d.ts:57
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: { dispose: any }[]
  
  Objects that have at least a dispose-function member.
Returns Disposable
Returns a new disposable which, upon dispose, will dispose all provided disposables.