npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript.Learn more »

any-event

0.3.6 • Public • Published

any-event NPM Version npm bundle size (minified + gzip) codecov CircleCI

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

安装

npm i -S any-event

使用

import EventEmitter from  'any-event';
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);

has(eventName)

是否绑定了指定事件

名称 类型 数据类型 是否必填 说明
eventName 参数 String/Symbol 事件名称
emitter.on('add', callback);
 
emitter.has('add'; // true

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);

install

npm i any-event

Downloadsweekly downloads

22

version

0.3.6

license

ISC

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability