@armscye/hooks 0.4.1 → 0.6.0

package/README.md

@@ -1,6 +1,6 @@
 # @armscye/hooks
 
-> A collection of shared standard TypeScript definitions.
+> A collection of shared standard TypeScript definitions (@hooks).
 
 ## Installation
 
@@ -15,3 +15,81 @@ or using yarn:
 ```sh
 yarn add @armscye/hooks --dev
 ```
+
+## Reference
+
+### ShutdownHook `Interface`
+
+Interface defining methods to respond to system signals (when application gets shutdown by, e.g., `SIGTERM`).
+
+```ts
+interface ShutdownHook {
+  onShutdown(signal?: string): any;
+}
+```
+
+The `onShutdown` method is called when an application receives a system signal indicating it's time to gracefully shutdown. Common signals include `SIGTERM` (termination request) and `SIGINT` (interrupt).
+
+The optional `signal` parameter might be provided, revealing the specific signal received.
+
+**Usage notes**
+
+Here's a basic example demonstrating how to use `ShutdownHook` to close a database connection:
+
+```ts
+class MyShutdownHook implements ShutdownHook {
+  onShutdown(signal?: string) {
+    // Access and close database connection
+    const db = /* get database connection */;
+    db.close()
+      .then(() => console.log("Database connection closed"))
+      .catch(error => console.error("Error closing database:", error));
+  }
+}
+
+// Register the shutdown hook with the application
+app.registerHook(new MyShutdownHook())
+```
+
+### StartupHook `Interface`
+
+Interface defining method called during the application startup.
+
+```ts
+interface StartupHook {
+  onStartup(): any;
+}
+```
+
+The `onStartup` method is called before the application begins listening for incoming connections.
+
+**Usage notes**
+
+Here's a basic example demonstrating how to use a `StartupHook` to connect to a database:
+
+```ts
+class MyStartupHook implements StartupHook {
+  onStartup() {
+    // Connect to the database
+    database.connect();
+    console.log('Database connection established.');
+  }
+}
+
+// Register the startup hook with the application
+app.registerHook(new MyStartupHook());
+```
+
+### HookProvider `Type`
+
+Describes how hooks should be provided.
+
+```ts
+type HookProvider<T = any> = string | symbol | object | Type<T> | Function;
+```
+
+## License
+
+This project is licensed under the **MIT license**.
+
+See [LICENSE](LICENSE) for more information.

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export * from './hook-provider.interface';
-export * from './shutdown-hook.interface';
-export * from './startup-hook.interface';
+export * from './hook-provider';
+export * from './shutdown-hook';
+export * from './startup-hook';

package/dist/{shutdown-hook.interface.d.ts → shutdown-hook.d.ts}

@@ -1,14 +1,8 @@
 /**
  * Interface defining methods to respond to system signals (when application gets
- * shutdown by, e.g., SIGTERM)
+ * shutdown by, e.g., `SIGTERM`).
  */
 export interface ShutdownHook {
-    /**
-     * Called before connections close.
-     *
-     * @param signal the system signal
-     */
-    beforeShutdown(signal?: string): any;
     /**
      * Called after connections close.
      *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@armscye/hooks",
-  "version": "0.4.1",
-  "description": "A collection of shared standard TypeScript definitions",
+  "version": "0.6.0",
+  "description": "A collection of shared standard TypeScript definitions (@hooks)",
   "author": "Augustus Kamau",
   "license": "MIT",
   "types": "./dist/index.d.ts",
@@ -11,10 +11,11 @@
   "keywords": [
     "armscye",
     "typescript",
-    "types"
+    "types",
+    "hooks"
   ],
   "dependencies": {
-    "@armscye/core": "^0.2.0"
+    "@armscye/core": "^0.3.0"
   },
   "homepage": "https://github.com/armscye/armscye#readme",
   "repository": {
@@ -27,5 +28,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f2c94ab8ecb4161f6f8c82820a8bbad758d83209"
+  "gitHead": "a26e3829ccbd43eae0ab1a1dd165af7ae7b355c1"
 }

package/dist/hook.interface.d.ts

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