Interface IObservableDisposable

A disposable object with an observable disposed signal.

interface IObservableDisposable {
    disposed: ISignal<IObservableDisposable, void>;
    isDisposed: boolean;
    dispose(): void;
}

Hierarchy (view full)

IDisposable
- IObservableDisposable

Implemented by

Index

Properties

disposed isDisposed

Methods

Properties

`Readonly` disposed

disposed: ISignal<IObservableDisposable, void>

A signal emitted when the object is disposed.

`Readonly` isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Methods

dispose

dispose(): void
Dispose of the resources held by the object.

Notes
If the object's dispose method is called more than once, all calls made after the first will be a no-op.

Undefined Behavior
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

Returns void
Inherited from IDisposable.dispose
- Defined in index.ts:39