hookified 0.5.1 → 0.7.0

package/LICENSE

@@ -1,6 +1,4 @@
-MIT License
-
-Copyright (c) Jared Wray
+MIT License & © Jared Wray
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,6 +1,6 @@
 <img src="site/logo.svg" alt="Hookified" height="400" align="center">
 
-# Event and Middleware Hooks for Your Libraries
+# Async Event and Middleware Hooks
 
 [![tests](https://github.com/jaredwray/hookified/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/hookified/actions/workflows/tests.yaml)
 [![GitHub license](https://img.shields.io/github/license/jaredwray/hookified)](https://github.com/jaredwray/hookified/blob/master/LICENSE)
@@ -10,10 +10,12 @@
 
 ## Features
 - Emit Events via [Emittery](https://npmjs.com/package/emittery)
-- Middleware Hooks with data passing
+- Async Middleware Hooks for Your Methods
 - ESM and Nodejs 20+
 - Maintained on a regular basis!
 
+Special thanks to [@sindresorhus](https://github.com/sindresorhus) for the [Emittery](https://npmjs.com/package/emittery) library. 🍻
+
 ## Installation
 ```bash
 npm install hookified --save
@@ -31,7 +33,7 @@ class MyClass extends Hookified {
   }
 
   async myMethodEmittingEvent() {
-    await this.emit('message', 'Hello World');
+    await this.emit('message', 'Hello World'); //using Emittery
   }
 
   //with hooks you can pass data in and if they are subscribed via onHook they can modify the data
@@ -43,5 +45,71 @@ class MyClass extends Hookified {
     return data;
   }
 }
+```
+
+You can even pass in multiple arguments to the hooks:
+
+```javascript
+import { Hookified } from 'hookified';
+
+class MyClass extends Hookified {
+  constructor() {
+    super();
+  }
+
+  async myMethodWithHooks() Promise<any> {
+    let data = { some: 'data' };
+    let data2 = { some: 'data2' };
+    // do something
+    await this.hook('before:myMethod2', data, data2);
+
+    return data;
+  }
+}
+```
+
+## API
+
+Please see the [Emittery](https://npmjs.com/package/emittery) documentation for more information on the event emitter.
+
+### .onHook(eventName, handler)
+
+Subscribe to a hook event.
+
+### .removeHook(eventName)
+
+Unsubscribe from a hook event.
+
+### .hook(eventName, ...args)
+
+Run a hook event.
+
+### .hooks
+
+Get all hooks.
+
+### .getHooks(eventName)
+
+Get all hooks for an event.
+
+### .clearHooks(eventName)
+
+## Development and Testing
+
+Hookified is written in TypeScript and tests are written in `vitest`. To run the tests, use the following command:
+
+To setup the environment and run the tests:
+
+```bash
+npm i && npm test
+```
+
+To contribute follow the [Contributing Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+[MIT & © Jared Wray](LICENSE)
+
+
 
 

package/dist/index.d.ts

@@ -1,11 +1,12 @@
 import Emittery from 'emittery';
-type HookHandler = (...arguments_: any[]) => Promise<void> | void;
+export type Hook = (...arguments_: any[]) => Promise<void> | void;
 export declare class Hookified extends Emittery {
-    _hookHandlers: Map<string, HookHandler[]>;
+    _hooks: Map<string, Hook[]>;
     constructor();
-    onHook(event: string, handler: HookHandler): Promise<void>;
-    removeHook(event: string, handler: HookHandler): Promise<void>;
-    hook(event: string, data: any): Promise<void>;
-    get hookHandlers(): Map<string, HookHandler[]>;
+    onHook(event: string, handler: Hook): void;
+    removeHook(event: string, handler: Hook): void;
+    hook(event: string, ...data: any[]): Promise<void>;
+    get hooks(): Map<string, Hook[]>;
+    getHooks(event: string): Hook[] | undefined;
+    clearHooks(): void;
 }
-export {};

package/dist/index.js

@@ -1,23 +1,23 @@
 import Emittery from 'emittery';
 export class Hookified extends Emittery {
-    _hookHandlers;
+    _hooks;
     constructor() {
         super();
-        this._hookHandlers = new Map();
+        this._hooks = new Map();
     }
     // Adds a handler function for a specific event
-    async onHook(event, handler) {
-        const eventHandlers = this._hookHandlers.get(event);
+    onHook(event, handler) {
+        const eventHandlers = this._hooks.get(event);
         if (eventHandlers) {
             eventHandlers.push(handler);
         }
         else {
-            this._hookHandlers.set(event, [handler]);
+            this._hooks.set(event, [handler]);
         }
     }
     // Removes a specific handler function for a specific event
-    async removeHook(event, handler) {
-        const eventHandlers = this._hookHandlers.get(event);
+    removeHook(event, handler) {
+        const eventHandlers = this._hooks.get(event);
         if (eventHandlers) {
             const index = eventHandlers.indexOf(handler);
             if (index !== -1) {
@@ -26,13 +26,13 @@ export class Hookified extends Emittery {
         }
     }
     // Triggers all handlers for a specific event with provided data
-    async hook(event, data) {
-        const eventHandlers = this._hookHandlers.get(event);
+    async hook(event, ...data) {
+        const eventHandlers = this._hooks.get(event);
         if (eventHandlers) {
             for (const handler of eventHandlers) {
                 try {
-                    // eslint-disable-next-line no-await-in-loop
-                    await handler(data);
+                    // eslint-disable-next-line no-await-in-loop, @typescript-eslint/no-unsafe-argument
+                    await handler(...data);
                 }
                 catch (error) {
                     // eslint-disable-next-line no-await-in-loop
@@ -42,9 +42,15 @@ export class Hookified extends Emittery {
         }
     }
     // Provides read-only access to the current handlers
-    get hookHandlers() {
+    get hooks() {
         // Creating a new map to prevent external modifications to the original map
-        return new Map(this._hookHandlers);
+        return this._hooks;
+    }
+    getHooks(event) {
+        return this._hooks.get(event);
+    }
+    clearHooks() {
+        this._hooks.clear();
     }
 }
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAIhC,MAAM,OAAO,SAAU,SAAQ,QAAQ;IACtC,aAAa,CAA6B;IAE1C;QACC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;IAChC,CAAC;IAED,+CAA+C;IAC/C,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,OAAoB;QAC/C,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpD,IAAI,aAAa,EAAE,CAAC;YACnB,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1C,CAAC;IACF,CAAC;IAED,2DAA2D;IAC3D,KAAK,CAAC,UAAU,CAAC,KAAa,EAAE,OAAoB;QACnD,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpD,IAAI,aAAa,EAAE,CAAC;YACnB,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC7C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBAClB,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAChC,CAAC;QACF,CAAC;IACF,CAAC;IAED,gEAAgE;IAChE,KAAK,CAAC,IAAI,CAAC,KAAa,EAAE,IAAS;QAClC,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpD,IAAI,aAAa,EAAE,CAAC;YACnB,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;gBACrC,IAAI,CAAC;oBACJ,4CAA4C;oBAC5C,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;gBACrB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBAChB,4CAA4C;oBAC5C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,KAAK,CAAC,oCAAoC,KAAK,MAAO,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBAChH,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAED,oDAAoD;IACpD,IAAI,YAAY;QACf,2EAA2E;QAC3E,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACpC,CAAC;CACD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAIhC,MAAM,OAAO,SAAU,SAAQ,QAAQ;IACtC,MAAM,CAAsB;IAE5B;QACC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;IACzB,CAAC;IAED,+CAA+C;IAC/C,MAAM,CAAC,KAAa,EAAE,OAAa;QAClC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,aAAa,EAAE,CAAC;YACnB,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QACnC,CAAC;IACF,CAAC;IAED,2DAA2D;IAC3D,UAAU,CAAC,KAAa,EAAE,OAAa;QACtC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,aAAa,EAAE,CAAC;YACnB,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC7C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBAClB,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAChC,CAAC;QACF,CAAC;IACF,CAAC;IAED,gEAAgE;IAChE,KAAK,CAAC,IAAI,CAAC,KAAa,EAAE,GAAG,IAAW;QACvC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,aAAa,EAAE,CAAC;YACnB,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;gBACrC,IAAI,CAAC;oBACJ,mFAAmF;oBACnF,MAAM,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;gBACxB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBAChB,4CAA4C;oBAC5C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,KAAK,CAAC,oCAAoC,KAAK,MAAO,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBAChH,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAED,oDAAoD;IACpD,IAAI,KAAK;QACR,2EAA2E;QAC3E,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;IAED,QAAQ,CAAC,KAAa;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,UAAU;QACT,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;CACD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hookified",
-  "version": "0.5.1",
+  "version": "0.7.0",
   "description": "Event and Middleware Hooks",
   "type": "module",
   "main": "./dist/index.js",