CompositeDisposable

Description

An object that aggregates multiple Disposable instances together into a single disposable, so they can all be disposed as a group.

These are very useful when subscribing to multiple events.

Examples

const {CompositeDisposable} = require('atom')

class Something {
  constructor() {
    this.disposables = new CompositeDisposable()
    const editor = atom.workspace.getActiveTextEditor()
    this.disposables.add(editor.onDidChange(() => {})
    this.disposables.add(editor.onDidChangePath(() => {})
  }

  destroy() {
    this.disposables.dispose();
  }
}

API documentation

Construction and Destruction

::constructor()

Construct an instance, optionally with one or more disposables

::dispose()

Dispose all disposables added to this composite disposable.

If this object has already been disposed, this method has no effect.

Managing Disposables

::add(...disposables)

Add disposables to be disposed when the composite is disposed.

If this object has already been disposed, this method has no effect.

Argument	Description
`...disposables`	Disposable instances or any objects with `.dispose()` methods.

::remove(disposable)

Remove a previously added disposable.

Argument	Description
`disposable`	Disposable instance or any object with a `.dispose()` method.

::delete()

Alias to CompositeDisposable::remove

::clear()

Clear all disposables. They will not be disposed by the next call to dispose.