Norse Polytheistic Mythology

    @braintree/event-emitter
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.2 • Public • Published

    event-emitter

    A helper module for creating objects with event emitter capabilities.

    Installation

    npm

    npm install --save @braintree/event-emitter

    This module uses commonjs. You must use a build tool such as Browserify or Webpack to include it in your frontend project.

    Usage

    Creating an Object that Inherits from Event Emitter

    import EventEmitter from "@braintree/event-emitter";
    
    class MyClass extends EventEmitter() {
      // my class definition
    }
    
    const emitter = new MyClass();

    Listen for events

    emitter.on("event-name", function (data) {
      console.log("called with", data.payload, "!");
    });
    
    emitter.emit("event-name", { payload: "foo" }); // logs "called with foo!"

    Unsubscribe from events

    const cb = function () {};
    
    emitter.on("event-name", cb);
    emitter.off("event-name", cb);
    
    emitter.emit("event-name", { payload: "foo" }); // cb is not called

    Tests

    npm test

    Keywords

    none

    Install

    npm i @braintree/event-emitter

    DownloadsWeekly Downloads

    169,982

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    5.64 kB

    Total Files

    6

    Last publish

    Collaborators

    • braintree