@plokkke/nest-health-registry
Version:
A NestJS module providing a health check registry using @nestjs/terminus
18 lines (17 loc) • 892 B
TypeScript
import { HealthCheckResult, HealthCheckService, HealthIndicatorFunction, HealthIndicatorService } from '@nestjs/terminus';
export type HealthCheck = () => boolean | Promise<boolean>;
export declare class HealthRegistryService {
private readonly health;
private readonly healthIndicatorService;
private readonly _livenessChecks;
private readonly _readinessChecks;
constructor(health: HealthCheckService, healthIndicatorService: HealthIndicatorService);
get livenessChecks(): HealthIndicatorFunction[];
get readinessChecks(): HealthIndicatorFunction[];
checkLiveness(): Promise<HealthCheckResult>;
checkReadiness(): Promise<HealthCheckResult>;
addLivenessCheck(key: string, check: HealthCheck): void;
addReadinessCheck(key: string, check: HealthCheck): void;
removeLivenessCheck(key: string): void;
removeReadinessCheck(key: string): void;
}