@armscye/hooks 0.6.0 → 0.7.4

package/README.md

@@ -20,7 +20,7 @@ yarn add @armscye/hooks --dev
 
 ### ShutdownHook `Interface`
 
-Interface defining methods to respond to system signals (when application gets shutdown by, e.g., `SIGTERM`).
+Interface defining method to respond to system signals (when application gets shutdown by, e.g., `SIGTERM`).
 
 ```ts
 interface ShutdownHook {
@@ -46,9 +46,6 @@ class MyShutdownHook implements ShutdownHook {
       .catch(error => console.error("Error closing database:", error));
   }
 }
-
-// Register the shutdown hook with the application
-app.registerHook(new MyShutdownHook())
 ```
 
 ### StartupHook `Interface`
@@ -75,17 +72,14 @@ class MyStartupHook implements StartupHook {
     console.log('Database connection established.');
   }
 }
-
-// Register the startup hook with the application
-app.registerHook(new MyStartupHook());
 ```
 
 ### HookProvider `Type`
 
-Describes how hooks should be provided.
+Describes type structure for hooks.
 
 ```ts
-type HookProvider<T = any> = string | symbol | object | Type<T> | Function;
+type HookProvider = string | symbol | object | Type<any> | Function;
 ```
 
 ## License

package/dist/hook-provider.d.ts

@@ -1,2 +1,2 @@
 import { Type } from '@armscye/core';
-export type HookProvider<T = any> = string | symbol | object | Type<T> | Function;
+export type HookProvider = string | symbol | object | Type<any> | Function;

package/dist/shutdown-hook.d.ts

@@ -1,12 +1,11 @@
 /**
- * Interface defining methods to respond to system signals (when application gets
- * shutdown by, e.g., `SIGTERM`).
+ * Defines a hook that runs when the application is shutting down.
  */
 export interface ShutdownHook {
     /**
-     * Called after connections close.
+     * Called during application shutdown.
      *
-     * @param signal the system signal
+     * @param signal The system signal that triggered the shutdown, if available.
      */
     onShutdown(signal?: string): any;
 }

package/dist/startup-hook.d.ts

@@ -1,9 +1,9 @@
 /**
- * Interface defining method called during the application startup.
+ * Defines a hook that runs during application startup.
  */
 export interface StartupHook {
     /**
-     * Called before listening for connections.
+     * Called when the application is starting.
      */
     onStartup(): any;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@armscye/hooks",
-  "version": "0.6.0",
+  "version": "0.7.4",
   "description": "A collection of shared standard TypeScript definitions (@hooks)",
   "author": "Augustus Kamau",
   "license": "MIT",
@@ -15,7 +15,7 @@
     "hooks"
   ],
   "dependencies": {
-    "@armscye/core": "^0.3.0"
+    "@armscye/core": "^0.4.3"
   },
   "homepage": "https://github.com/armscye/armscye#readme",
   "repository": {
@@ -28,5 +28,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a26e3829ccbd43eae0ab1a1dd165af7ae7b355c1"
+  "gitHead": "e9a42ae673466c9a255f4ebec8750f580e9f70a6"
 }