chiisai-event-emitter 1.0.2 → 2.1.0

package/README.md

@@ -22,17 +22,45 @@ npm install chiisai-event-emitter
 
 ## Usage
 
+### Subscribe to an Event
+
+Use `EventEmitter.subscribe(eventName, callback)` to subscribe to an event.
+
 ```ts
 import { EventEmitter } from 'chiisai-event-emitter';
 
 const eventEmitter = new EventEmitter();
 
-eventEmitter.subscribe('test-event', () => console.log('test-event handler called!'));
-eventEmitter.subscribe('test-event', () => console.log('another test-event handler called!'))
+eventEmitter.subscribe('event', () => console.log('event-handler called!'));
+
+eventEmitter.emit('event')
+// event-handler called!
+```
+
+### Unsubscibe
+
+`EventEmitter.subscribe(eventName, callback)` method returns a function which can be called to unsubscribe the callback from the event.
+
+```ts
+const unsubscibe = eventEmitter.subscribe('event', () => console.log('event-handler called!'));
+unsubscribe();
+
+eventEmitter.emit('event')
+// (nothing happened)
+```
+
+### Delete an Event
+
+`EventEmitter.clear(eventName)` method removes an event and all callbacks subscibed to this event.
+
+```ts
+eventEmitter.subscribe('event', () => console.log('event-handler called!'));
+eventEmitter.subscribe('event', () => console.log('another event-handler called!'));
+eventEmitter.clear('event')
+
+eventEmitter.emit('event')
+// (nothing happened)
 
-eventEmitter.emit('test-event')
-// test-event handler called!
-// another test-event handler called!
 ```
 
 [build-img]:https://github.com/bencelaszlo/chiisai-event-emitter/actions/workflows/release.yml/badge.svg

package/lib/EventEmitter.d.ts

@@ -1,11 +1,14 @@
-export declare type EventCallback<T = void> = (...args: Array<any>) => T;
-export declare type Subscriptions = Map<string, Array<{
+export type EventCallback<T = void> = (...args: Array<any>) => T;
+export declare class Subscriptions extends Map<string, Array<{
     id: symbol;
     callback: EventCallback;
-}>>;
-export declare type Unsubscribe = {
-    unsubscribe: () => void;
-};
+}>> {
+    get(key: string): {
+        id: symbol;
+        callback: EventCallback;
+    }[];
+}
+export type Unsubscribe = () => void;
 export declare class EventEmitter {
     subscriptions: Subscriptions;
     constructor();
@@ -18,6 +21,13 @@ export declare class EventEmitter {
     /**
      * @param {string} eventName
      * @param {Array<any>} args
+     * @returns void
      */
     emit(eventName: string, ...args: Array<any>): void;
+    /**
+     *
+     * @param eventName eventName to be deleted
+     * @returns void
+     */
+    clear(eventName: string): void;
 }

package/lib/EventEmitter.js

@@ -1,9 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventEmitter = void 0;
+exports.EventEmitter = exports.Subscriptions = void 0;
+class Subscriptions extends Map {
+    get(key) {
+        return super.get(key) || [];
+    }
+}
+exports.Subscriptions = Subscriptions;
 class EventEmitter {
     constructor() {
-        this.subscriptions = new Map();
+        this.subscriptions = new Subscriptions();
     }
     /**
      * @param {string} eventName
@@ -12,19 +18,31 @@ class EventEmitter {
      */
     subscribe(eventName, callback) {
         const id = Symbol(callback.toString());
-        this.subscriptions.set(eventName, this.subscriptions.has(eventName)
-            ? [...(this.subscriptions.get(eventName) || []), { id, callback }]
-            : [{ id, callback }]);
-        return {
-            unsubscribe: () => this.subscriptions.set(eventName, (this.subscriptions.get(eventName) || []).filter(({ id: subscriptionId }) => subscriptionId !== id)),
-        };
+        this.subscriptions.set(eventName, [
+            ...this.subscriptions.get(eventName),
+            { id, callback },
+        ]);
+        return () => this.subscriptions.set(eventName, this.subscriptions
+            .get(eventName)
+            .filter(({ id: subscriptionId }) => subscriptionId !== id));
     }
     /**
      * @param {string} eventName
      * @param {Array<any>} args
+     * @returns void
      */
     emit(eventName, ...args) {
-        (this.subscriptions.get(eventName) || []).forEach(({ callback }) => callback(...args));
+        this.subscriptions
+            .get(eventName)
+            .forEach(({ callback }) => callback(...args));
+    }
+    /**
+     *
+     * @param eventName eventName to be deleted
+     * @returns void
+     */
+    clear(eventName) {
+        this.subscriptions = new Subscriptions([...this.subscriptions].filter(([key]) => key !== eventName));
     }
 }
 exports.EventEmitter = EventEmitter;

package/lib/index.min.js

@@ -0,0 +1 @@
+var e=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var n=Object.getOwnPropertyDescriptor(t,r);n&&!("get"in n?!t.__esModule:n.writable||n.configurable)||(n={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,n)}:function(e,t,r,i){void 0===i&&(i=r),e[i]=t[r]}),t=this&&this.__exportStar||function(t,r){for(var i in t)"default"===i||Object.prototype.hasOwnProperty.call(r,i)||e(r,t,i)};Object.defineProperty(exports,"__esModule",{value:!0}),t(require("./EventEmitter"),exports);

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "chiisai-event-emitter",
-  "version": "1.0.2",
+  "version": "2.1.0",
   "description": "A minimal event emitter.",
   "main": "./lib/index.js",
   "files": [
     "lib/**/*"
   ],
   "scripts": {
-    "build": "tsc --project tsconfig.build.json",
+    "tsc": "tsc --project tsconfig.build.json",
+    "minify": "terser ./lib/index.js -o ./lib/index.min.js --compress --mangle --module",
+    "build": "npm run tsc && npm run minify",
     "clean": "rm -rf ./lib/",
     "cm": "cz",
     "lint": "eslint ./src/ --fix",
@@ -58,9 +60,10 @@
     "lint-staged": "^13.2.1",
     "prettier": "^2.2.1",
     "semantic-release": "^21.0.1",
+    "terser": "^5.34.1",
     "ts-jest": "^27.0.5",
     "ts-node": "^10.2.1",
-    "typescript": "^4.2.4"
+    "typescript": "^4.9.5"
   },
   "config": {
     "commitizen": {