An event-driven design forms the foundation of the Node.js API. Among its features is the events module, which allows for the creation and management of unique events. The EventEmitter class is found in the event module. Named events that invoke the listener functions are released by the EventEmitter object. An essential component of the Node.js ecosystem are the EventEmitters. A net is one of the many items in Node that emit events. Every time a peer connects to it or a connection is closed, the server object sends out an event. When the file is opened, closed, or a read/write action is carried out, the fs.readStream object generates an event. An instance of an event is any object that emits events. EventEmitter.
Since the EventEmitter class is defined in the events module, it must be included in the code with the require statement.
var events = require('events');To emit an event, an object of the EventEmitter class should be declared.
var eventEmitter = new events.EventEmitter();An ‘error’ event is emitted by an EventEmitter instance when it detects an error. The ‘newListener’ event is triggered upon adding a new listener, and the’removeListener’ event is triggered upon removing a listener.
Events
- newListener(event, listener)
event: String – The event namelistener: Function – The event handler function- This event is emitted any time a listener is added. When triggered, the listener may not yet be added to the array of listeners for the event.
- removeListener(event, listener)
event: String – The event namelistener: Function – The event handler function- This event is emitted any time a listener is removed. When triggered, the listener may not yet be removed from the array of listeners for the event.
Instance Methods
- addListener(event, listener)
Adds a listener at the end of the listeners array for the specified event. Returns emitter, so calls can be chained. - on(event, listener)
Adds a listener at the end of the listeners array for the specified event. Same as addListener. - once(event, listener)
Adds a one-time listener to the event. This listener is invoked only the next time the event is fired, after which it is removed. - removeListener(event, listener)
Removes a listener from the listener array for the specified event. If any single listener has been added multiple times, removeListener must be called multiple times to remove each instance. - removeAllListeners([event])
Removes all listeners, or those of the specified event. - setMaxListeners(n)
By default, EventEmitters print a warning if more than 10 listeners are added for an event. Set to zero for unlimited. - listeners(event)
Returns an array of listeners for the specified event. - emit(event, [arg1], [arg2], […])
Executes each of the listeners in order with the supplied arguments. Returns true if the event had listeners, false otherwise. - off(event, listener)
Alias for removeListener.
Example
var events = require('events');
var eventEmitter = new events.EventEmitter();
// Listener #1
var listener1 = function listener1() {
console.log('listener1 executed.');
}
// Listener #2
var listener2 = function listener2() {
console.log('listener2 executed.');
}
// Bind the connection event with the listener1 function
eventEmitter.addListener('connection', listener1);
// Bind the connection event with the listener2 function
eventEmitter.on('connection', listener2);
// Fire the connection event
eventEmitter.emit('connection');When the connection event is fired, the console shows:
listener1 executed.
listener2 executed.Now, removing listener1 from the connection event and firing the event again:
// Remove listener1 function
eventEmitter.removeListener('connection', listener1);
console.log("Listener1 will not listen now.");
// Fire the connection event again
eventEmitter.emit('connection');Console output:
listener1 executed.
listener2 executed.
Listener1 will not listen now.
listener2 executed.Counting Listeners
The EventEmitter class also has a listenerCount() method that returns the number of listeners for a given event.
const events = require('events');
const myEmitter = new events.EventEmitter();
// Listener #1
var listener1 = function listener1() {
console.log('listener1 executed.');
}
// Listener #2
var listener2 = function listener2() {
console.log('listener2 executed.');
}
// Bind listeners to the connection event
myEmitter.addListener('connection', listener1);
myEmitter.on('connection', listener2);
// Fire the connection event
myEmitter.emit('connection');
console.log("Number of Listeners:" + myEmitter.listenerCount('connection'));Output:
listener1 executed.
listener2 executed.
Number of Listeners:2It might be helpful:
Getting Started with Node.js: Your First Application
Best Practices for API Design in Full-Stack Development
WhatsApp us