weight-event-emmitter

weight-event-emmitter是客户端与服务端均可复用的事件监听器。支持带权事件注册与触发。

使用

npm install weight-event-emmitter

安装了weight-event-emmitter后，你可以在任何一处业务代码里使用weight-event-emmitter。

测试

npm run test

示例

const WeightEventEmmitter = require('weight-event-emmitter');

const eventHub = new WeightEventEmmitter();

const eventListener = () => console.log('event')

weightEventEmmitter.$on('event', eventListener);
weightEventEmmitter.$on('event.-1', () => console.log('event.-1'));
weightEventEmmitter.$on('event.2', () => console.log('event.2'));
weightEventEmmitter.$on('event.1', () => console.log('event.1'));

weightEventEmmitter.$emit('event');
// print event.2
// print event.1
// print event.-1
// print event
weightEventEmmitter.$off('event', eventListener);

weightEventEmmitter.$emit('event');
// no longer print event

weightEventEmmitter.$once('event.1', () => console.log('once'));
weightEventEmmitter.$emit('event');
// print event.2
// print event.1
// print once
// print event.-1

API

首先需要在需要使用weight-event-emmitter的任意一处，创建weight-event-emmitter实例：

const WeightEventEmmitter = require('weight-event-emmitter');

const weightEventEmmitter = new WeightEventEmmitter();

$on

$on方法注册一个事件监听器。

参数

• eventName：事件名称，支持权重添加。如未添加权重，则认为权重为最低。 事件名称举例：
  • 'event'：注册一个名为event的事件，权重级别为最低，即-Infinity，它等同于创建一个名为event.-Infinity的事件监听器。
  • 'event.1'：注册一个名为event的事件，权重级别为1。
  • 'event.1.1'：注册一个名为event的事件，权重级别为1.1。
  • 'event.1.1.1'：不合法，不能创建权重为1.1.1的事件监听器。
  • 'event.e'：合法，注册一个名为event.e的事件，权重级别为-Infinity，但不推荐，不能为此类事件增加权重。
• listener：事件监听回调函数。

返回值

• 返回weight-event-emmitter实例，以便于链式调用。

$emit

$emit方法触发一个事件。

参数

• eventName：触发的事件名称，如event，不需要带权重。
• 第1~n个参数：传递给事件监听器回调函数的参数。

返回值

• 返回weight-event-emmitter实例，以便于链式调用。

$off

$off方法取消一个事件监听器。

参数

• eventName：触发的事件名称，如event，不需要带权重。
• listener：事件监听回调函数。

$offAll

$off方法取消指定的所有事件监听器。

参数

• eventName/eventNameRegExp：触发的事件名称或者正则表达式，如event或者/^eve*$/，不需要带权重。

返回值

• 返回weight-event-emmitter实例，以便于链式调用。

$once

$once方法参数类似于$on方法，在事件触发一次后取消。