Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
eventemitter2
Advanced tools
A Node.js event emitter implementation with namespaces, wildcards, TTL and browser support.
The eventemitter2 npm package is an implementation of the EventEmitter module found in Node.js. It provides an interface for implementing event-driven architecture. It allows you to create objects that can emit named events that cause function objects ('listeners') to be called. It offers several enhancements over the native EventEmitter, such as namespaces, wildcards, and the ability to listen to all events.
Event Emitting
This feature allows you to emit events and register listeners that get called when those events are emitted.
const EventEmitter2 = require('eventemitter2').EventEmitter2;
const emitter = new EventEmitter2();
emitter.on('event', function() {
console.log('an event occurred!');
});
emitter.emit('event');
Namespaces/Wildcards
This feature enables the use of namespaces and wildcards for event names, allowing for more flexible event handling.
const EventEmitter2 = require('eventemitter2').EventEmitter2;
const emitter = new EventEmitter2({
wildcard: true
});
emitter.on('foo.*', function() {
console.log('foo event occurred!');
});
emitter.emit('foo.bar');
Listening to All Events
This feature allows you to listen to all events that are emitted from an EventEmitter2 instance.
const EventEmitter2 = require('eventemitter2').EventEmitter2;
const emitter = new EventEmitter2();
emitter.onAny(function(event, value) {
console.log('All event handler:', event, value);
});
emitter.emit('randomEvent', 'with some value');
The 'events' package is the original EventEmitter that comes with Node.js. It provides the basic functionality for event emitting and listening but lacks some of the advanced features of eventemitter2, such as namespaces and wildcards.
Mitt is a tiny functional event emitter / pubsub. It provides a similar event-driven approach but with a smaller footprint and without namespaces or wildcard features, focusing on simplicity and performance.
This is another EventEmitter implementation with a similar API to eventemitter2. It offers additional features like context binding and once listeners, but it does not support namespaces or wildcards.
EventEmitter2 is a an implementation of the EventEmitter found in Node.js
once
concept with many
. var EventEmitter2 = require('eventemitter2').EventEmitter2;
var server = new EventEmitter2({
wildcard: true, // should the event emitter use wildcards.
delimiter: '::', // the delimiter used to segment namespaces, defaults to `.`.
maxListeners: 20, // the max number of listeners that can be assigned to an event, defaults to 10.
});
server.on('foo.*', function(value1, value2) {
console.log(this.event, value1, value2);
});
once
concept. server.many('foo', 4, function() {
console.log('hello');
});
server.many(['foo', 'bar', 'bazz'], function() {
console.log('hello');
});
When an EventEmitter
instance experiences an error, the typical action is
to emit an error
event. Error events are treated as a special case.
If there is no listener for it, then the default action is to print a stack
trace and exit the program.
All EventEmitters emit the event newListener
when new listeners are
added.
Namespaces with Wildcards
To use namespaces/wildcards, pass the wildcard
option into the EventEmitter constructor.
When namespaces/wildcards are enabled, events can either be strings (foo.bar
) separated
by a delimiter or arrays (['foo', 'bar']
). The delimiter is also configurable as a
constructor option.
An event name passed to any event emitter method can contain a wild card (the *
character).
If the event name is a string, a wildcard may appear as foo.*
. If the event name is an array,
the wildcard may appear as ['foo', '*']
.
If either of the above described events were passed to the on
method, subsequent emits such
as the following would be observed...
emitter.emit(['foo.bazz']);
emitter.emit(['foo', 'bar']);
Adds a listener to the end of the listeners array for the specified event.
server.on('data', function(value1, value2, value3 /* accepts any number of expected values... */) {
console.log('The event was raised!');
});
server.on('data', function(value) {
console.log('This event will be listened to exactly four times.');
});
Adds a listener that will be fired when any event is emitted.
server.onAny(function(value) {
console.log('This event will be listened to exactly four times.');
});
Removes the listener that will be fired when any event is emitted.
server.offAny(function(value) {
console.log('This event will be listened to exactly four times.');
});
Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
server.once('get', function (value) {
console.log('Ah, we have our first value!');
});
Adds a listener that will execute n times for the event before being removed. The listener is invoked only the first time the event is fired, after which it is removed.
server.many('get', 4, function (value) {
console.log('Ah, we have our first value!');
});
Remove a listener from the listener array for the specified event. Caution: changes array indices in the listener array behind the listener.
var callback = function(value) {
console.log('someone connected!');
};
server.on('get', callback);
// ...
server.removeListener('get', callback);
Removes all listeners, or those of the specified event.
By default EventEmitters will print a warning if more than 10 listeners are added to it. This is a useful default which helps finding memory leaks. Obviously not all Emitters should be limited to 10. This function allows that to be increased. Set to zero for unlimited.
Returns an array of listeners for the specified event. This array can be manipulated, e.g. to remove listeners.
server.on('get', function(value) {
console.log('someone connected!');
});
console.log(console.log(server.listeners('get')); // [ [Function] ]
Returns an array of listeners that are listening for any event that is specified. This array can be manipulated, e.g. to remove listeners.
server.onAny(function(value) {
console.log('someone connected!');
});
console.log(console.log(server.listenersAny()[0]); // [ [Function] ] // someone connected!
Execute each of the listeners that may be listening for the specified event name in order with the list of arguments.
There is a test suite that tries to cover each use case, it can be found here.
(The MIT License)
Copyright (c) 2011 hij1nx http://www.twitter.com/hij1nx
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
A feature-rich Node.js event emitter implementation with namespaces, wildcards, TTL, async listeners and browser/worker support.
The npm package eventemitter2 receives a total of 9,697,743 weekly downloads. As such, eventemitter2 popularity was classified as popular.
We found that eventemitter2 demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.