review.tizen.org Git - platform/framework/web/crosswalk-tizen.git/blob

   1 # event-emitter
   2 ## Environment agnostic event emitter
   3
   4 ### Installation
   5
   6         $ npm install event-emitter
   7
   8 To port it to Browser or any other (non CJS) environment, use your favorite CJS bundler. No favorite yet? Try: [Browserify](http://browserify.org/), [Webmake](https://github.com/medikoo/modules-webmake) or [Webpack](http://webpack.github.io/)
   9
  10 ### Usage
  11
  12 ```javascript
  13 var ee = require('event-emitter');
  14
  15 var emitter = ee({}), listener;
  16
  17 emitter.on('test', listener = function (args) {
  18   // …emitter logic
  19 });
  20
  21 emitter.once('test', function (args) {
  22   // …invoked only once(!)
  23 });
  24
  25 emitter.emit('test', arg1, arg2/*…args*/); // Two above listeners invoked
  26 emitter.emit('test', arg1, arg2/*…args*/); // Only first listener invoked
  27
  28 emitter.off('test', listener);              // Removed first listener
  29 emitter.emit('test', arg1, arg2/*…args*/); // No listeners invoked
  30 ```
  31 ### Additional utilities
  32
  33 #### allOff(obj) _(event-emitter/all-off)_
  34
  35 Removes all listeners from given event emitter object
  36
  37 #### hasListeners(obj[, name]) _(event-emitter/has-listeners)_
  38
  39 Whether object has some listeners attached to the object.
  40 When `name` is provided, it checks listeners for specific event name
  41
  42 ```javascript
  43 var emitter = ee();
  44 var hasListeners = require('event-emitter/has-listeners');
  45 var listener = function () {};
  46
  47 hasListeners(emitter); // false
  48
  49 emitter.on('foo', listener);
  50 hasListeners(emitter); // true
  51 hasListeners(emitter, 'foo'); // true
  52 hasListeners(emitter, 'bar'); // false
  53
  54 emitter.off('foo', listener);
  55 hasListeners(emitter, 'foo'); // false
  56 ```
  57
  58 #### pipe(source, target[, emitMethodName]) _(event-emitter/pipe)_
  59
  60 Pipes all events from _source_ emitter onto _target_ emitter (all events from _source_ emitter will be emitted also on _target_ emitter, but not other way).
  61 Returns _pipe_ object which exposes `pipe.close` function. Invoke it to close configured _pipe_.
  62 It works internally by redefinition of `emit` method, if in your interface this method is referenced differently, provide its name (or symbol) with third argument.
  63
  64 #### unify(emitter1, emitter2) _(event-emitter/unify)_
  65
  66 Unifies event handling for two objects. Events emitted on _emitter1_ would be also emitter on _emitter2_, and other way back.
  67 Non reversible.
  68
  69 ```javascript
  70 var eeUnify = require('event-emitter/unify');
  71
  72 var emitter1 = ee(), listener1, listener3;
  73 var emitter2 = ee(), listener2, listener4;
  74
  75 emitter1.on('test', listener1 = function () { });
  76 emitter2.on('test', listener2 = function () { });
  77
  78 emitter1.emit('test'); // Invoked listener1
  79 emitter2.emit('test'); // Invoked listener2
  80
  81 var unify = eeUnify(emitter1, emitter2);
  82
  83 emitter1.emit('test'); // Invoked listener1 and listener2
  84 emitter2.emit('test'); // Invoked listener1 and listener2
  85
  86 emitter1.on('test', listener3 = function () { });
  87 emitter2.on('test', listener4 = function () { });
  88
  89 emitter1.emit('test'); // Invoked listener1, listener2, listener3 and listener4
  90 emitter2.emit('test'); // Invoked listener1, listener2, listener3 and listener4
  91 ```
  92
  93 ### Tests [![Build Status](https://travis-ci.org/medikoo/event-emitter.png)](https://travis-ci.org/medikoo/event-emitter)
  94
  95         $ npm test