Atom

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.

{CompositeDisposable} = require 'atom'
 
class Something
  constructor: ->
    @disposables = new CompositeDisposable
    editor = atom.workspace.getActiveTextEditor()
    @disposables.add editor.onDidChange ->
    @disposables.add editor.onDidChangePath ->
 
  destroy: ->
    @disposables.dispose()

Construct an instance, optionally with one or more disposables

Dispose all disposables added to this composite disposable.

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

Add disposables to be disposed when the composite is disposed.

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

...disposables

Disposable instances or any objects with .dispose() methods.

Remove a previously added disposable.

disposable

Disposable instance or any object with a .dispose() method.

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

CompositeDisposable essential

Examples

Construction and Destruction

::constructor()

::dispose()

Managing Disposables

::add(...disposables)

::remove(disposable)

::clear()