Class ObservableDisposableSet

An observable object which manages a collection of disposable items.

Hierarchy

DisposableSet
- ObservableDisposableSet

Implements

IObservableDisposable

Index

Constructors

Properties

Accessors

disposed isDisposed

Methods

add clear contains dispose remove

Constructors

constructor

new ObservableDisposableSet(): ObservableDisposableSet
Returns ObservableDisposableSet

Inherited from DisposableSet.constructor

Properties

`Private` _disposed

_disposed: Signal<ObservableDisposableSet, void> = ...

Accessors

disposed

get disposed(): ISignal<this, void>
A signal emitted when the set is disposed.

Returns ISignal<this, void>
Implementation of IObservableDisposable.disposed
- Defined in packages/disposable/src/index.ts:220

isDisposed

get isDisposed(): boolean
Test whether the set has been disposed.

Returns boolean
Implementation of IObservableDisposable.isDisposed

Inherited from DisposableSet.isDisposed
- Defined in packages/disposable/src/index.ts:123

Methods

add

add(item): void
Add a disposable item to the set.
Parameters
- item: IDisposable
  
  The item to add to the set.
  
  Notes
  If the item is already contained in the set, this is a no-op.
Returns void
Inherited from DisposableSet.add
- Defined in packages/disposable/src/index.ts:163

clear

clear(): void
Remove all items from the set.

Returns void
Inherited from DisposableSet.clear
- Defined in packages/disposable/src/index.ts:182

contains

contains(item): boolean
Test whether the set contains a specific item.
Parameters
- item: IDisposable
  
  The item of interest.
Returns boolean
true if the set contains the item, false otherwise.
Inherited from DisposableSet.contains
- Defined in packages/disposable/src/index.ts:151

dispose

dispose(): void
Dispose of the set and the items it contains.

Notes
Items are disposed in the order they are added to the set.

Returns void
Implementation of IObservableDisposable.dispose

Overrides DisposableSet.dispose
- Defined in packages/disposable/src/index.ts:230

remove

remove(item): void
Remove a disposable item from the set.
Parameters
- item: IDisposable
  
  The item to remove from the set.
  
  Notes
  If the item is not contained in the set, this is a no-op.
Returns void
Inherited from DisposableSet.remove
- Defined in packages/disposable/src/index.ts:175

Generated using TypeDoc