对象 EventEmitter

事件触发对象,可用于建立观察者模式,支持事件触发的对象均继承于此,同一事件的同一函数只会产生一次回调

Event 对象可独立创建,以用于组建自定义的事件系统:

var EventEmitter = require('events');

var e = new EventEmitter();

继承关系

构造函数

EventEmitter

构造函数

new EventEmitter();

静态属性

defaultMaxListeners

Integer, 默认全局最大监听器数

static Integer EventEmitter.defaultMaxListeners;

成员函数

on

绑定一个事件处理函数到对象

Object EventEmitter.on(String ev,
    Function func);

调用参数:

返回结果:


绑定一个事件处理函数到对象

Object EventEmitter.on(Object map);

调用参数:

返回结果:


addListener

绑定一个事件处理函数到对象

Object EventEmitter.addListener(String ev,
    Function func);

调用参数:

返回结果:


绑定一个事件处理函数到对象

Object EventEmitter.addListener(Object map);

调用参数:

返回结果:


prependListener

绑定一个事件处理函数到对象起始

Object EventEmitter.prependListener(String ev,
    Function func);

调用参数:

返回结果:


绑定一个事件处理函数到对象起始

Object EventEmitter.prependListener(Object map);

调用参数:

返回结果:


once

绑定一个一次性事件处理函数到对象,一次性处理函数只会触发一次

Object EventEmitter.once(String ev,
    Function func);

调用参数:

返回结果:


绑定一个一次性事件处理函数到对象,一次性处理函数只会触发一次

Object EventEmitter.once(Object map);

调用参数:

返回结果:


prependOnceListener

绑定一个事件处理函数到对象起始

Object EventEmitter.prependOnceListener(String ev,
    Function func);

调用参数:

返回结果:


绑定一个事件处理函数到对象起始

Object EventEmitter.prependOnceListener(Object map);

调用参数:

返回结果:


off

从对象处理队列中取消指定函数

Object EventEmitter.off(String ev,
    Function func);

调用参数:

返回结果:


取消对象处理队列中的全部函数

Object EventEmitter.off(String ev);

调用参数:

返回结果:


从对象处理队列中取消指定函数

Object EventEmitter.off(Object map);

调用参数:

返回结果:


removeListener

从对象处理队列中取消指定函数

Object EventEmitter.removeListener(String ev,
    Function func);

调用参数:

返回结果:


取消对象处理队列中的全部函数

Object EventEmitter.removeListener(String ev);

调用参数:

返回结果:


从对象处理队列中取消指定函数

Object EventEmitter.removeListener(Object map);

调用参数:

返回结果:


removeAllListeners

从对象处理队列中取消所有事件的所有监听器, 如果指定事件,则移除指定事件的所有监听器。

Object EventEmitter.removeAllListeners(Array evs = []);

调用参数:

返回结果:


setMaxListeners

监听器的默认限制的数量,仅用于兼容

EventEmitter.setMaxListeners(Integer n);

调用参数:


getMaxListeners

获取监听器的默认限制的数量,仅用于兼容

Integer EventEmitter.getMaxListeners();

返回结果:


listeners

查询对象指定事件的监听器数组

Array EventEmitter.listeners(String ev);

调用参数:

返回结果:


listenerCount

查询对象指定事件的监听器数量

Integer EventEmitter.listenerCount(String ev);

调用参数:

返回结果:


eventNames

查询监听器事件名称

Array EventEmitter.eventNames();

返回结果:


emit

主动触发一个事件

Boolean EventEmitter.emit(String ev,
    ...);

调用参数:

返回结果:


dispose

强制回收对象,调用此方法后,对象资源将立即释放

EventEmitter.dispose();

equals

比较当前对象与给定的对象是否相等

Boolean EventEmitter.equals(object expected);

调用参数:

返回结果:


toString

返回对象的字符串表示,一般返回 "[Native Object]",对象可以根据自己的特性重新实现

String EventEmitter.toString();

返回结果:


toJSON

返回对象的 JSON 格式表示,一般返回对象定义的可读属性集合

Value EventEmitter.toJSON(String key = "");

调用参数:

返回结果:


valueOf

返回对象本身的数值

Value EventEmitter.valueOf();

返回结果: