@supercat1337/event-emitter 1.0.3 → 1.0.5

package/README.md

@@ -0,0 +1,69 @@
+# event-emitter
+
+## Environment agnostic event emitter
+
+Installation
+```
+$ npm install @supercat1337/event-emitter
+```
+
+Usage
+
+Basic example
+```js
+import { EventEmitter } from "@supercat1337/event-emitter/src/EventEmitter.js";
+
+var ev = new EventEmitter();
+ev.on("foo", () => {
+    console.log("Hello!");
+});
+
+ev.emit("bar");
+ev.emit("foo");
+```
+
+Example of unsubscribing from an event
+```js
+import { EventEmitter } from "@supercat1337/event-emitter/src/EventEmitter.js";
+
+var ev = new EventEmitter;
+var foo = 0
+var action = () => {
+    foo++;
+};
+
+var unsubscriber = ev.on("foo", action);
+
+ev.emit("foo");
+unsubscriber();
+
+ev.emit("foo");
+
+if (foo == 1) {
+    console.log("Success!");
+} else {
+    console.log("Fail!");
+}
+```
+
+Example of using the Once method
+```js
+import { EventEmitter } from "@supercat1337/event-emitter/src/EventEmitter.js";
+
+var ev = new EventEmitter;
+var foo = 0
+ev.once("foo", () => {
+    foo++;
+});
+
+ev.emit("foo");
+ev.emit("foo");
+ev.emit("foo");
+
+if (foo == 1) {
+    console.log("Success!");
+} else {
+    console.log("Fail!");
+}
+```
+

package/dist/{event-emitter.1.0.3.esm.js → event-emitter.1.0.5.esm.js}

@@ -1,10 +1,11 @@
-// version 1.0.3
+// version 1.0.5
 
 // src/EventEmitter.js
 var EventEmitter = class {
   /** @type {Object.<string, Function[]>} */
   events = {};
   /**
+   * on is used to add a callback function that's going to be executed when the event is triggered
    * @param {string} event
    * @param {Function} listener
    * @returns {()=>void}
@@ -21,6 +22,7 @@ var EventEmitter = class {
     return unsubscriber;
   }
   /**
+   * Remove an event listener from an event
    * @param {string} event
    * @param {Function} listener
    */
@@ -34,6 +36,7 @@ var EventEmitter = class {
     }
   }
   /**
+   * emit is used to trigger an event
    * @param {string} event
    */
   emit(event) {
@@ -52,6 +55,7 @@ var EventEmitter = class {
     }
   }
   /**
+   * Add a one-time listener
    * @param {string} event
    * @param {Function} listener
    * @returns {()=>void}

package/dist/{event-emitter.1.0.3.min.esm.js → event-emitter.1.0.5.min.esm.js}

@@ -1,2 +1,2 @@
-// version 1.0.3
+// version 1.0.5
 var i=class{events={};on(e,s){typeof this.events[e]!="object"&&(this.events[e]=[]),this.events[e].push(s);let t=this;return function(){t.removeListener(e,s)}}removeListener(e,s){var t;typeof this.events[e]=="object"&&(t=this.events[e].indexOf(s),t>-1&&this.events[e].splice(t,1))}emit(e){if(typeof this.events[e]=="object"){var s,t,r,o=[].slice.call(arguments,1);for(t=this.events[e].slice(),r=t.length,s=0;s<r;s++)try{t[s].apply(this,o)}catch(n){console.error(e,o),console.error(n)}}}once(e,s){return this.on(e,function t(){this.removeListener(e,t),s.apply(this,arguments)})}};export{i as EventEmitter};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supercat1337/event-emitter",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Event Emitter",
   "main": "index.js",
   "scripts": {

package/src/EventEmitter.js

@@ -1,10 +1,12 @@
 // @ts-check
+/** @module EventEmitter */
 
 class EventEmitter {
     /** @type {Object.<string, Function[]>} */
     events = {};
 
     /**
+     * on is used to add a callback function that's going to be executed when the event is triggered
      * @param {string} event
      * @param {Function} listener
      * @returns {()=>void}
@@ -26,6 +28,7 @@ class EventEmitter {
         return unsubscriber;
     }
     /**
+     * Remove an event listener from an event
      * @param {string} event
      * @param {Function} listener
      */
@@ -42,6 +45,7 @@ class EventEmitter {
 
     }
     /**
+     * emit is used to trigger an event
      * @param {string} event
      */
     emit(event) {
@@ -66,6 +70,7 @@ class EventEmitter {
     }
 
     /**
+     * Add a one-time listener
      * @param {string} event
      * @param {Function} listener
      * @returns {()=>void}