diode

---

---

A dead simple event emitter. Diode only has one event.

Diode.listen(callback)
Diode.emit()

It is also quite small (see API). We found ourselves building something similar to it on several projects and decided it was better to keep it in one place.

Usage

For React projects, Diode includes a Stateful mixin, it expects a getState method that is called every time Diode publishes a change.

First include the Stateful mixin into a component, and provide a getState method:

var React    = require('react/addons');
var Stateful = require('diode/stateful');
var MyStore  = require('./myStore');
var Pure     = React.addons.PureRenderMixin;

var Component = React.createClass({
  mixins: [ Stateful, Pure ],

  getState: function() {
    return {
      items: MyStore.all()
    }
  },

  render: function() {
    // render something purely
  }
})

Then in your stores, execute 'publish' on the Diode when you want to propagate a change:

var Diode = require('diode')
var _data = []

MyStore.add = function(record) {
  _data = _data.concat(record)
  Diode.volley()
}

And that's it!

Diode as a decorator

Diode is both an event emitter and a decorator that can add event subscription to another object:

var MyData = Diode({
  data: [],
  add: function(record) {
    this.data.push(record)
    this.publish()
  }
})

New instances of Diode

Diode also supports the new operator:

var myDiode = new Diode()

API

Diode

• listen,subscribe: Add a subscription
• ignore,unsubscribe: Remove a subscription
• emit,publish: Trigger all subscriptions

Stateful

• getState: This method is called by Stateful whenever the Diode executes emit to update the state of a component. It is required.

Changelog

6.0.0

• Removed decorate (just use Diode(entity))
• Removed <Stateful /> this mixin required the use of Diode as a global which caused a lot of issues.
• Made some internal changes for file savings