@loopback/health
Version:
An extension exposes health check related endpoints with LoopBack 4
24 lines (23 loc) • 547 B
TypeScript
/**
* Options for health component
*/
export type HealthOptions = {
disabled?: boolean;
healthPath: string;
readyPath: string;
livePath: string;
openApiSpec?: boolean;
};
/**
* Configuration for health component with optional properties
*/
export type HealthConfig = Partial<HealthOptions>;
export declare const DEFAULT_HEALTH_OPTIONS: HealthOptions;
/**
* Functions for liveness check
*/
export type LiveCheck = () => Promise<void>;
/**
* Functions for readiness check
*/
export type ReadyCheck = () => Promise<void>;