Scribd Logo
Upload

Welcome to Scribd!

  • 16 views

    Event Emitter

    Uploaded by

    zahed
    This document provides a cheat sheet on Node.js event emitters. It describes the EventEmitter class and some of its core methods like on(), emit(), once(), removeListener(), and removeAllListeners(). These methods allow creating and handling custom events in Node.js applications using the events module. Common modules that use EventEmitters include HTTP and streams.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd

    Event Emitter

    Uploaded by

    zahed
    16 views1 page
    This document provides a cheat sheet on Node.js event emitters. It describes the EventEmitter class and some of its core methods like on(), emit(), once(), removeListener(), and removeAllListeners(). These methods allow creating and handling custom events in Node.js applications using the events module. Common modules that use EventEmitters include HTTP and streams.

    Original Title

    event-emitter

    Copyright

    © © All Rights Reserved

    Available Formats

    PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    This document provides a cheat sheet on Node.js event emitters. It describes the EventEmitter class and some of its core methods like on(), emit(), once(), removeListener(), and removeAllListeners(). These methods allow creating and handling custom events in Node.js applications using the events module. Common modules that use EventEmitters include HTTP and streams.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Download as pdf or txt
    16 views1 page

    Event Emitter

    Uploaded by

    zahed
    This document provides a cheat sheet on Node.js event emitters. It describes the EventEmitter class and some of its core methods like on(), emit(), once(), removeListener(), and removeAllListeners(). These methods allow creating and handling custom events in Node.js applications using the events module. Common modules that use EventEmitters include HTTP and streams.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Download as pdf or txt
    of 1

    CHEAT SHEET

    developers.redhat.com | @RHDevelopers

    Node.js Event Emitter Cheat Sheet

    This cheat sheet covers the basic principles around Node.js event emitters.

    EVENT EMITTER
    Node.js allows us to create and handle custom events easily by using the events
    module. The Event module includes the EventEmitter class which can be used to
    raise and handle custom events.
    Some modules using the EventEmitter class:
    myEmitter.removeAllListeners(['eventOne']); // receives an array of events
    Http

    Streams
    EventEmitter.prototype.setMaxListeners()

    Event Emitter Class Sets the maximum allowed listeners for a speci c event. Node.js will print a warning
    if more than 10 listeners are added for a speci c event. setMaxListeners allows you
    You can get the EventEmitter class from the Node.js built in events module. to modify this limit.
    const { EventEmitter } = require('events'); myEmitter.setMaxListeners(25);

    const myEmitter = new EventEmitter();


    EventEmitter.prototype.listeners()

    EventEmitter.prototype.emit() Returns all the listeners subscribed to the speci ed event.


    myEmitter.on('eventOne', (data) => console.log(data.msg));
    Emits an event to all subscribed listeners with some data.
    const myEmitter = new EventEmitter(); myEmitter.listeners('eventOne'); // returns a list of functions

    myEmitter.emit('eventOne', { msg: 'This is a message...' });


    EventEmitter.prototype.getMaxListeners()

    EventEmitter.prototype.on() Returns the current max listener value for the EventEmitter instance.
    myEmitter = new EventEmitter();
    Listens to a speci c event and its data.
    myEmitter.on('eventOne', (data) => console.log(data.msg)); myEmitter.getMaxListeners() // defaults to 10

    EventEmitter.prototype.addListener() EventEmitter.listenerCount()

    Same as the myEmitter.on() method. Returns the number of listeners for a given event.
    myEmitter.addListener('eventOne', (data) => console.log(data.msg)); const myEmitter = new EventEmitter();

    myEmitter.on('eventOne', (data) => console.log(data));


    EventEmitter.prototype.once()
    EventEmitter.listenerCount(myEmitter, 'eventOne'); // output: 1
    Sometimes you want your application to respond to an event (or type of event)
    only one time (i.e., the rst time the event occurs).
    myEmitter.once('eventOne', () => console.log('This callback triggers only once!')); Events.defaultMaxListeners()

    Sets the default max listens for all EventEmitter instances. However, calling
    EventEmitter.prototype.removeListener() emitter.setMaxListeners(n) still has precedence over events.defaultMaxListeners.
    const { defaultMaxListeners } = require('events');
    Remove a listener from the listener array for the speci ed event.
    defaultMaxListeners(25);
    const callback = () => {
    console.log('someone connected!');
    };

    myEmitter.on('connection', callback);

    myEmitter.removeListener('connection', callback);

    EventEmitter.prototype.removeAllListeners()

    Removes all listeners, or those of the speci ed event.

    You might also like