Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move EventEmitter polyfill from metacom #229

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,26 @@ console.log({ size, bytes });
| mb | 6 | megabyte |
| kb | 3 | kilobyte |

## Class `EnevtEmitter`

- `getMaxListeners(): number`
- `listenerCount(name: string): number`
- `on(name: string, fn: Function)`
- `once(name: string, fn: Function)`
- `emit(name: string, ...args: Array<unknown>)`
- `remove(name: string, fn: Function)`
- `clear(name: string)`

## `EnevtEmitter` utilities

- `once(emitter: EventEmitter, name: string): Promise<unknown>`

```js
const ee = new metautil.EventEmitter();
setTimeout(() => ee.emit('name3', 'value'), 100);
const result = await metautil.once(ee, 'name3');
```

## License & Contributors

Copyright (c) 2017-2023 [Metarhia contributors](https://github.com/metarhia/metautil/graphs/contributors).
Expand Down
1 change: 1 addition & 0 deletions dist.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ module.exports = {
...require('./lib/async.js'),
...require('./lib/datetime.js'),
...require('./lib/error.js'),
...require('./lib/events.js'),
...require('./lib/http.js'),
...require('./lib/objects.js'),
...require('./lib/pool.js'),
Expand Down
69 changes: 69 additions & 0 deletions lib/events.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
'use strict';

class EventEmitter {
constructor() {
this.events = new Map();
this.maxListenersCount = 10;
}

getMaxListeners() {
return this.maxListenersCount;
}

listenerCount(name) {
const event = this.events.get(name);
if (event) return event.size;
return 0;
}

on(name, fn) {
const event = this.events.get(name);
if (event) {
event.add(fn);
const tooManyListeners = event.size > this.maxListenersCount;
if (tooManyListeners) {
const name = 'MaxListenersExceededWarning';
const warn = 'Possible EventEmitter memory leak detected';
const max = `Current maxListenersCount is ${this.maxListenersCount}`;
const hint = 'Hint: avoid adding listeners in loops';
console.warn(`${name}: ${warn}. ${max}. ${hint}`);
}
} else {
this.events.set(name, new Set([fn]));
}
}

once(name, fn) {
const dispose = (...args) => {
this.remove(name, dispose);
return void fn(...args);
};
this.on(name, dispose);
}

emit(name, ...args) {
const event = this.events.get(name);
if (!event) return;
for (const fn of event.values()) {
fn(...args);
}
}

remove(name, fn) {
const event = this.events.get(name);
if (!event) return;
event.delete(fn);
}

clear(name) {
if (!name) return void this.events.clear();
this.events.delete(name);
}
}

const once = (emitter, name) =>
new Promise((resolve) => {
emitter.once(name, resolve);
});

module.exports = { EventEmitter, once };
16 changes: 15 additions & 1 deletion metautil.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { EventEmitter } from 'node:events';
import { IncomingMessage } from 'node:http';
import { ScryptOptions, X509Certificate } from 'node:crypto';

Expand Down Expand Up @@ -260,3 +259,18 @@ export function collect(
keys: Array<string>,
options?: CollectorOptions,
): Collector;

// Submodule: Events

export class EventEmitter {
constructor();
getMaxListeners(): number;
listenerCount(name: string): number;
on(name: string, fn: Function): void;
once(name: string, fn: Function): void;
emit(name: string, ...args: Array<unknown>): void;
remove(name: string, fn: Function): void;
clear(name: string): void;
}

export function once(emitter: EventEmitter, name: string): Promise<unknown>;
1 change: 1 addition & 0 deletions metautil.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ module.exports = {
...require('./lib/crypto.js'),
...require('./lib/datetime.js'),
...require('./lib/error.js'),
...require('./lib/events.js'),
...require('./lib/fs.js'),
...require('./lib/http.js'),
...require('./lib/network.js'),
Expand Down
63 changes: 63 additions & 0 deletions test/events.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
'use strict';

const metatests = require('metatests');
const metautil = require('..');

metatests.test('EventEmitter', async (test) => {
const ee = new metautil.EventEmitter();

test.strictSame(ee.getMaxListeners(), 10);
test.assert(ee.events instanceof Map);

let onCount = 0;
let onceCount = 0;

ee.on('name1', (data) => {
test.strictSame(data, 'value');
onCount++;
});

ee.once('name1', (data) => {
test.strictSame(data, 'value');
onceCount++;
});

ee.emit('name1', 'value');
ee.emit('name1', 'value');

test.strictSame(onCount, 2);
test.strictSame(onceCount, 1);

test.strictSame(ee.listenerCount('name1'), 1);
test.strictSame(ee.listenerCount('name2'), 0);

let count = 0;
const fn = () => {
count++;
};
ee.on('name1', fn);
ee.emit('name1', 'value');
test.strictSame(count, 1);

test.strictSame(ee.listenerCount('name1'), 2);
ee.remove('name1', fn);
test.strictSame(ee.listenerCount('name1'), 1);

ee.emit('name1', 'value');
test.strictSame(count, 1);

ee.clear('name1');
test.strictSame(ee.listenerCount('name1'), 0);

setTimeout(() => {
ee.emit('name3', 'value');
}, 50);

const result = await metautil.once(ee, 'name3');
test.strictSame(result, 'value');

ee.clear();
test.strictSame(ee.listenerCount('name3'), 0);

test.end();
});
Loading