blear.classes.events

1Introduction

description：事件的监听与派发类
author：ydr.me
create：2016-04-18 13:50
update：2016-04-18 13:50
github：https://github.com/blearjs/blear.classes.events

2Example

var Events = require('blear.classes.events');

// 用于实例化
var events = new Events();

// 用于继承
var MyClass = Events.extend({
    constructor: function() {
        MyClass.parent(this);
        // ...
    }
});

Events 模块充当着和 NodeJS 里的 Events 模块一样的功能，可以派发事件，接受传递事件，实现的是一个观察者模式。

3Prototype

原型属性、方法

3.1`#emit(event, ...args): result`

发射事件。

events.emit('my-first-event', 1, 2, 3);
events.emit('mySecondEvent', 1);
events.emit('myThirdEvent');

如果有某事件被监听了，在发射的时候是同步执行的。因此，合理的做法是先 on 然后再 emit。

3.1.1`event`

类型：String
说明：事件名称，多个事件名称使用空格分开

3.1.2`...args`

类型：*
说明：该事件附加的一些参数

3.2`#on(event, fn(...args)): Events`

监听事件。

3.2.1`event`

类型：String
说明：事件名称，多个事件名称使用空格分开

3.2.2`fn(...args)`

类型：Function
说明：回调

3.2.3`fn: this`

类型：Events

3.2.4`fn: ...args`

类型：*
说明：参数需要与 emit 一致。

3.2.5`result`

类型：Boolean
说明：如果某个监听返回 false，则为 false，否则为 true

3.3`#once(event, fn(...args)): Events`

一次性监听事件，使用方法与 on 一致。

3.4`#un(event, [fn]): Events`

卸载事件监听。

// 卸载 fn1 监听在 myEvent 上的事件
event.un('myEvent', fn1);

// 卸载所有监听在 myEvent 上的事件
event.un('myEvent');

3.4.1`event`

类型：String
说明：事件名称，多个事件名称使用空格分开

3.4.2`fn`

类型：Function
说明：卸载对应的事件，如果为空卸载所有对应的事件
默认：null

3.5`#size([event]): size`

获取监听某个事件的长度。

event.on('a', fn1);
event.on('a', fn2);
event.on('b', fn3);

event.size('a');
// => 2

event.size();
// => 3

3.5.1`event`

类型：String
说明：单个事件名称
默认：null

3.5.2`size`

类型：Number
说明：如果指定了事件名称，则返回对应事件的监听数量，否则返回所有数量

3.6`#destroy(): undefined`

销毁实例。