mini-events

mini-events

:cake: 一个mini的事件管理器, 希望能在您的代码中做一块砖, 支持node/browser.

安装

npm i -S mini-events

使用

import EventEmitter from  'mini-events';
const emitter = new EventEmitter();
emitter.on('add', data=>{
    console.log(data) // 1
});
emitter.emit('add', 1);

方法

on(eventName, listener)

绑定事件

名称	类型	数据类型	是否必填	说明
eventName	参数	`String	Symbol`	是
listener	参数	Function	是	对应的回调函数
emitter	返回值	EventEmitter	---	实例

off(eventName, listener)

解除绑定, 如果不填写listener, 那么eventName对应的listener都会被移除.

名称	类型	数据类型	是否必填	说明
eventName	参数	`String	Symbol`	是
listener	参数	Function	是	对应的回调函数
emitter	返回值	EventEmitter	---	实例

const callback = data=>{
    alert(data)
};
emitter.on('add', callback);
// 解除绑定
emitter.on('off', callback);
// add事件不会触发
emitter.emit('add', 1);

once(eventName, listener)

绑定事件, 只触发一次

名称	类型	数据类型	是否必填	说明
eventName	参数	`String	Symbol`	是
listener	参数	Function	是	对应的回调函数
emitter	返回值	EventEmitter	---	实例

const callback = data=>{
    alert(data)
};
emitter.once('add', callback);
// add事件触发
emitter.emit('add', 1);
// add事件不会触发
emitter.emit('add', 1);

emit(eventName [, ...args])

触发事件, 支持任意数量参数

名称	类型	数据类型	是否必填	说明
eventName	参数	`String	Symbol`	是
...args	参数	Any	是	对应的回调函数
emitter	返回值	Boolean	---	实例

const callback = (a,b,c,d)=>{
    console(a,b,c,d); // 1,2,3,4
};
emitter.once('add', callback);
// add事件触发
emitter.emit('add', 1,2,3,4);

destroy()

销毁实例

const callback = (a,b,c,d)=>{
    console(a,b,c,d); // 1,2,3,4
};
emitter.once('add', callback);
emitter.destroy();

// add事件不会触发
emitter.emit('add', 1,2,3,4);

Changelog

0.2.0 (2018-12-02)

Bug Fixes

• 修复打包输入路径 (f552bb0)
• 修复错误的声明文件 (ccb8da4)
• 错误的打包配置 (1e7c4bd)

Features

• packages.json增加typings字段 (e276b2d)
• 增加声明文件 (b279b89)

<a name="0.1.0"></a>