@mh.js/health-monitor 1.0.0 → 1.0.2

package/dist/monitor.d.ts

@@ -1,14 +1,50 @@
 import type { HealthIndicator, HealthStatus, MonitorConfig } from './types';
+/**
+ * HealthMonitor class for monitoring system health and event loop lag.
+ *
+ * @example
+ * ```typescript
+ * const monitor = new HealthMonitor({ interval: 3000 });
+ * monitor.register({
+ *   name: 'db',
+ *   check: async () => await db.ping()
+ * }).start();
+ * ```
+ */
 export declare class HealthMonitor {
     private indicators;
     private intervalId;
     private isCheckInProgress;
     private config;
     private latestStatus;
+    /**
+     * Creates a new HealthMonitor instance.
+     * @param config - Configuration options for the monitor.
+     */
     constructor(config?: MonitorConfig);
+    /**
+     * Registers a new health indicator to be monitored.
+     * @param indicator - The health indicator configuration.
+     * @returns The HealthMonitor instance for method chaining.
+     */
     register(indicator: HealthIndicator): this;
+    /**
+     * Starts the periodic health check loop.
+     * If the monitor is already running, this method does nothing.
+     */
     start(): void;
+    /**
+     * Stops the health check loop.
+     */
     stop(): void;
+    /**
+     * Retrieves the current health status of the system.
+     *
+     * If the health check loop is stalled (not updated for > 3x interval),
+     * it returns a 'down' status with a system error.
+     *
+     * @returns The current HealthStatus object.
+     */
     getStatus(): HealthStatus;
     private checkEventLoopLag;
     private check;

package/dist/monitor.js

@@ -2,7 +2,23 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HealthMonitor = void 0;
 const perf_hooks_1 = require("perf_hooks");
+/**
+ * HealthMonitor class for monitoring system health and event loop lag.
+ *
+ * @example
+ * ```typescript
+ * const monitor = new HealthMonitor({ interval: 3000 });
+ * monitor.register({
+ *   name: 'db',
+ *   check: async () => await db.ping()
+ * }).start();
+ * ```
+ */
 class HealthMonitor {
+    /**
+     * Creates a new HealthMonitor instance.
+     * @param config - Configuration options for the monitor.
+     */
     constructor(config) {
         var _a, _b;
         this.indicators = [];
@@ -19,10 +35,19 @@ class HealthMonitor {
             timeout: (_b = config === null || config === void 0 ? void 0 : config.timeout) !== null && _b !== void 0 ? _b : 1000,
         };
     }
+    /**
+     * Registers a new health indicator to be monitored.
+     * @param indicator - The health indicator configuration.
+     * @returns The HealthMonitor instance for method chaining.
+     */
     register(indicator) {
         this.indicators.push(indicator);
         return this;
     }
+    /**
+     * Starts the periodic health check loop.
+     * If the monitor is already running, this method does nothing.
+     */
     start() {
         if (this.intervalId)
             return;
@@ -30,12 +55,23 @@ class HealthMonitor {
         this.intervalId = setInterval(() => this.check(), this.config.interval);
         this.intervalId.unref();
     }
+    /**
+     * Stops the health check loop.
+     */
     stop() {
         if (this.intervalId) {
             clearInterval(this.intervalId);
             this.intervalId = null;
         }
     }
+    /**
+     * Retrieves the current health status of the system.
+     *
+     * If the health check loop is stalled (not updated for > 3x interval),
+     * it returns a 'down' status with a system error.
+     *
+     * @returns The current HealthStatus object.
+     */
     getStatus() {
         const now = Date.now();
         const isStale = (now - this.latestStatus.timestamp) > (this.config.interval * 3);

package/dist/types.d.ts

@@ -1,20 +1,73 @@
+/**
+ * Interface representing a health check indicator.
+ */
 export interface HealthIndicator {
+    /**
+     * The name of the component being monitored (e.g., 'database', 'redis').
+     */
     name: string;
+    /**
+     * A function that performs the health check.
+     * Should return a Promise that resolves if healthy, and rejects if unhealthy.
+     */
     check: () => Promise<any>;
+    /**
+     * Optional timeout for this specific indicator in milliseconds.
+     * If not provided, the global monitor timeout will be used.
+     */
     timeout?: number;
 }
+/**
+ * Interface representing the status details of a specific component.
+ */
 export interface ComponentDetail {
+    /**
+     * The status of the component ('up' or 'down').
+     */
     status: 'up' | 'down';
+    /**
+     * The latency of the health check in milliseconds.
+     */
     latency?: number;
+    /**
+     * The error message if the status is 'down'.
+     */
     error?: string;
 }
+/**
+ * Interface representing the overall health status of the system.
+ */
 export interface HealthStatus {
+    /**
+     * The overall status of the system ('ok' if all indicators are up, 'down' otherwise).
+     */
     status: 'ok' | 'down';
+    /**
+     * The event loop lag in milliseconds.
+     * High lag indicates the system is under heavy load.
+     */
     lag: number;
+    /**
+     * Detailed status of each registered component.
+     */
     details: Record<string, ComponentDetail>;
+    /**
+     * The timestamp when this status was generated.
+     */
     timestamp: number;
 }
+/**
+ * Configuration options for the HealthMonitor.
+ */
 export interface MonitorConfig {
+    /**
+     * The interval between health checks in milliseconds.
+     * @default 3000
+     */
     interval?: number;
+    /**
+     * The default timeout for health checks in milliseconds.
+     * @default 1000
+     */
     timeout?: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mh.js/health-monitor",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Lightweight health check and event loop monitoring detection library for Node.js. Supports custom indicators and TypeScript.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -33,5 +33,13 @@
   "devDependencies": {
     "@types/node": "^25.0.9",
     "typescript": "^5.9.3"
-  }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/iu7726/health-monitor.git"
+  },
+  "bugs": {
+    "url": "https://github.com/iu7726/health-monitor/issues"
+  },
+  "homepage": "https://github.com/iu7726/health-monitor#readme"
 }