@visulima/health-check/dist/healthcheck.d.ts

A library built to provide support for defining service health for node services. It allows you to register async health checks for your dependencies and the service itself, provides a health endpoint that exposes their status, and health metrics.

import type { Checker, HealthCheck as HealthcheckInterface, HealthReport } from "./types.d.ts";
declare class Healthcheck implements HealthcheckInterface {
    /**
     * A copy of registered checkers
     */
    private healthCheckers;
    addChecker(service: string, checker: Checker): void;
    /**
     * Returns the health check reports. The health checks are performed when
     * this method is invoked.
     */
    getReport(): Promise<{
        healthy: boolean;
        report: HealthReport;
    }>;
    isLive(): Promise<boolean>;
    /**
     * Returns an array of registered services names
     */
    get servicesList(): string[];
    /**
     * Invokes a given checker to collect the report metrics.
     */
    private invokeChecker;
}
export default Healthcheck;