Class Disposable

Represents a type which can release resources, such as event listening or a timer.

See

Implements

DisposableLike

Index

Constructors

Methods

Constructors

constructor

new Disposable(onDispose): Disposable
Creates a new disposable that calls the provided function on dispose.

Note that an asynchronous function is not awaited.
Parameters
- onDispose: (() => void)
  Function that disposes something.
  - - (): void
    - Returns void
Returns Disposable
- Defined in src/framework/util/disposable.ts:50

Methods

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of DisposableLike.dispose
- Defined in src/framework/util/disposable.ts:57

`Static` from

from(...disposables): Disposable
Combine many disposable-likes into one. You can use this method when having objects with a dispose function which aren't instances of Disposable.
Parameters
- Rest ...disposables: DisposableLike[]
  Objects that have at least a dispose-function member. Note that asynchronous dispose-functions aren't awaited.
Returns Disposable
- A new disposable which, upon dispose, will dispose all provided disposables.
- Defined in src/framework/util/disposable.ts:32

Generated using TypeDoc