https://github.com/erffy/erfevents
A powerful EventEmitter module based on Map and Set.
https://github.com/erffy/erfevents
eventemitter nodejs npm npmjs typescript
Last synced: 2 months ago
JSON representation
A powerful EventEmitter module based on Map and Set.
- Host: GitHub
- URL: https://github.com/erffy/erfevents
- Owner: erffy
- Created: 2024-07-16T17:31:49.000Z (10 months ago)
- Default Branch: stable
- Last Pushed: 2024-12-12T17:03:17.000Z (5 months ago)
- Last Synced: 2025-01-18T20:00:38.921Z (4 months ago)
- Topics: eventemitter, nodejs, npm, npmjs, typescript
- Language: TypeScript
- Homepage:
- Size: 28.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/erffy/erfevents/actions/workflows/github-code-scanning/codeql)
## erfevents
- A powerful EventEmitter module based on Map and Set.
### Features
- 🚀 High Performance: Designed for speed and efficiency in event management.
- 🛠️ Easy to Use: Provides intuitive methods for adding, removing, and emitting events.
- 🖥️ Versatile Compatibility: Supports ESM and CJS, ensuring seamless integration with modern JavaScript environments.
### Installation
Note: Before installation, you need to install 'typescript' globally with the package manager you use.
```sh
npm install erffy/erfevents
pnpm add erffy/erfevents
yarn add erffy/erfevents
bun add erffy/erfevents
```
### Usage
```js
// TypeScript / ESM
import EventEmitter from 'erfevents';
//
// CJS
const EventEmitter = require('erfevents').default;
//
const ee = new EventEmitter();
ee.on('test', console.log);
ee.emit('test');
ee.on('limitedRun', console.log, 3); // Only emit 3 times
for (let i = 0; i < 5; i++) ee.emit('limitedRun', i);
//
ee.once('runOnce', console.log);
// or
ee.on('runOnce', console.log, 1);
//
function seeDetails() {
console.log('Hello')
}
ee.on('see', seeDetails);
ee.emit('see', 'test');
console.log(seeDetails.emitLimit);
console.log(seeDetails.emitTimes);
console.log(seeDetails.emitted); // or ee.isEmitted(seeDetails)
```
### Contact
- Join our [Flux Development](https://discord.gg/C8fXXjADQE) discord server.
[](https://github.com/erffy/erfevents)