All files / evt listener.js

100% Statements 17/17
100% Branches 4/4
100% Functions 7/7
100% Lines 17/17

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103                                                    1x   1x 3x 3x 3x 2x       1x                 4x                 1x                     3x                     1x                     4x     4x     4x 4x 3x           1x  
/**
 * 广播组件
 * - 构造实例时,需要传入事件白名单列表。
 * - 只有在白名单列表上的事件才可以被触发。
 * - 事件添加,移除,激发的调用方法参考 Events。
 * @see [evt/Events](#evt-events)
 * @class evt/Listener
 * @example
 * @example
 * var $listener = require('@spore-ui/kit/packages/evt/listener');
 *
 * // 白名单里只记录了 event1 事件
 * var channelGlobal = new $listener([
 *   'event1'
 * ]);
 * channelGlobal.on('event1', function(){
 *   console.log('event1');
 * });
 * channelGlobal.on('event2', function(){
 *   // will not run
 *   console.log('event2');
 * });
 * channelGlobal.trigger('event1');
 * channelGlobal.trigger('event2');
 */
 
var $events = require('./events');
 
var Listener = function (events) {
  this.privateWhiteList = {};
  this.privateReceiver = new $events();
  if (Array.isArray(events)) {
    events.forEach(this.define.bind(this));
  }
};
 
Listener.prototype = {
  constructor: Listener,
  /**
   * 在白名单上定义一个事件名称
   * @method Listener#define
   * @memberof evt/Listener
   * @param {String} eventName
   */
  define: function (eventName) {
    this.privateWhiteList[eventName] = true;
  },
  /**
   * 移除白名单上定义的事件名称
   * @method Listener#undefine
   * @memberof evt/Listener
   * @param {String} eventName
   */
  undefine: function (eventName) {
    delete this.privateWhiteList[eventName];
  },
  /**
   * 广播组件绑定事件
   * @see [Events#on](#events-on)
   * @method Listener#on
   * @memberof evt/Listener
   * @param {String} eventName 要绑定的事件名称
   * @param {Function} fn 要绑定的事件回调函数
   */
  on: function () {
    this.privateReceiver.on.apply(this.privateReceiver, arguments);
  },
  /**
   * 广播组件移除事件
   * @see [Events#off](#events-off)
   * @method Listener#off
   * @memberof evt/Listener
   * @param {String} eventName 要移除绑定的事件名称
   * @param {Function} fn 要移除绑定的事件回调函数
   */
  off: function () {
    this.privateReceiver.off.apply(this.privateReceiver, arguments);
  },
  /**
   * 广播组件派发事件
   * @see [Events#trigger](#events-trigger)
   * @method Listener#trigger
   * @memberof evt/Listener
   * @param {String} eventName 要触发的事件名称
   * @param {...*} [arg] 事件参数
   */
  trigger: function (events) {
    var rest = [].slice.call(arguments, 1);
 
    // 按照Events.trigger的调用方式,第一个参数是用空格分隔的事件名称列表
    events = events.split(/\s+/);
 
    // 遍历事件列表,依据白名单决定事件是否激发
    events.forEach(function (evtName) {
      if (this.privateWhiteList[evtName]) {
        this.privateReceiver.trigger.apply(this.privateReceiver, [evtName].concat(rest));
      }
    }.bind(this));
  },
};
 
module.exports = Listener;