Class DisposableSet

An object which manages a collection of disposable items.

Hierarchy

DisposableSet
- ObservableDisposableSet

Implements

IDisposable

Index

Constructors

Properties

_isDisposed _items

Accessors

Methods

add clear contains dispose remove

Constructors

constructor

new DisposableSet(): DisposableSet
Returns DisposableSet

Properties

`Private` _isDisposed

_isDisposed: boolean = false

`Private` _items

_items: Set<IDisposable> = ...

Accessors

isDisposed

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

Returns boolean
Implementation of IDisposable.isDisposed
- Defined in packages/disposable/src/index.ts:119

Methods

add

add(item: IDisposable): 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
- Defined in packages/disposable/src/index.ts:159

clear

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

Returns void
- Defined in packages/disposable/src/index.ts:178

contains

contains(item: IDisposable): boolean
Test whether the set contains a specific item.

Returns
true if the set contains the item, false otherwise.
Parameters
- item: IDisposable
  
  The item of interest.
Returns boolean
- Defined in packages/disposable/src/index.ts:147

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 IDisposable.dispose
- Defined in packages/disposable/src/index.ts:129

remove

remove(item: IDisposable): 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
- Defined in packages/disposable/src/index.ts:171

Generated using TypeDoc