EventEmitter2: 简单易用的事件发布/订阅库

EventEmitter2: 简单易用的事件发布/订阅库

EventEmitter2A nodejs event emitter implementation with namespaces, wildcards, TTL, works in the browser项目地址:https://gitcode.com/gh_mirrors/ev/EventEmitter2

项目简介

EventEmitter2 是一个简单易用的事件发布/订阅库，适用于 Node.js 和浏览器环境。它提供了丰富的特性，包括多事件监听、可配置的事件名称分隔符等，帮助开发者轻松处理应用程序中的事件通信。

主要功能

多事件监听

EventEmitter2 支持在同一个实例上为多个事件添加监听器。例如：

const EventEmitter = require('eventemitter2').EventEmitter2;

const ee = new EventEmitter({
  wildcard: true,
  delimiter: '.',
  maxListeners: 100
});

ee.on('foo.bar', (data) => {
  console.log('foo.bar event triggered with data:', data);
});

ee.on('baz.qux', (data) => {
  console.log('baz.qux event triggered with data:', data);
});

可配置的事件名称分隔符

您可以根据需要自定义事件名称之间的分隔符。默认情况下，事件名称之间使用点（.）作为分隔符。如果您想使用其他字符，可以设置 delimiter 选项。例如：

const EventEmitter = require('eventemitter2').EventEmitter2;

const ee = new EventEmitter({
  wildcard: true,
  delimiter: ':',
  maxListeners: 100
});

ee.on('foo:bar', (data) => {
  console.log('foo:bar event triggered with data:', data);
});

通配符支持

EventEmitter2 支持使用通配符（*）匹配多个事件。这对于处理具有相似模式的一组事件非常有用。例如：

const EventEmitter = require('eventemitter2').EventEmitter2;

const ee = new EventEmitter({
  wildcard: true,
  delimiter: '.',
  maxListeners: 100
});

ee.on('foo.*', (data) => {
  console.log('foo.* event triggered with data:', data);
});

ee.emit('foo.bar', { message: 'Hello, World!' });
ee.emit('foo.baz', { message: 'Nice to meet you!' });

自动移除监听器

您可以在监听器函数中传递一个额外的布尔参数（removeListener），以便在执行完成后自动删除该监听器。这有助于保持代码整洁，并避免内存泄漏。

const EventEmitter = require('eventemitter2').EventEmitter2;

const ee = new EventEmitter();

ee.on('cleanup', (data, removeListener) => {
  // 执行清理操作...
  console.log('Cleanup completed.');

  if (removeListener) {
    ee.off('cleanup');
  }
}, true /* 自动移除监听器 */);

ee.emit('cleanup', { message: 'Cleaning up...' });

特点

轻量级

EventEmitter2 的体积小巧，对性能影响很小，非常适合用于各种规模的应用程序。

兼容性

EventEmitter2 兼容 Node.js 和浏览器环境，方便您在不同平台上开发应用程序。

易于使用

EventEmitter2 提供了一组简单的 API，易于理解和使用。只需导入模块并创建一个新的实例即可开始使用。

高度可配置

您可以根据项目的需要调整 EventEmitter2 的行为，如自定义事件名称分隔符、启用或禁用通配符支持等。

如何使用

要在您的项目中使用 EventEmitter2，请按需安装：

npm install eventemitter2

然后，导入模块并创建一个新的实例以开始使用：

const EventEmitter = require('eventemitter2').EventEmitter2;
const ee = new EventEmitter();

现在您可以利用提供的 API 添加监听器、触发事件以及管理事件处理器了。

结论

EventEmitter2 提供了一个简洁而强大的事件发布/订阅实现，使您能够在 Node.js 和浏览器应用中轻松处理事件通信。无论是小型项目还是大型应用程序，EventEmitter2 都能够满足您的需求。尝试将其集成到您的项目中，体验更高效的事件管理和组织。

EventEmitter2A nodejs event emitter implementation with namespaces, wildcards, TTL, works in the browser项目地址:https://gitcode.com/gh_mirrors/ev/EventEmitter2