Connectum API Reference / @connectum/healthcheck / HealthcheckManager
Class: HealthcheckManager
Defined in: HealthcheckManager.ts:26
Healthcheck manager
Manages health status for all registered services. Module-level singleton. Import healthcheckManager from the package.
Example
import { healthcheckManager, ServingStatus } from '@connectum/healthcheck';
// After server.start():
healthcheckManager.update(ServingStatus.SERVING);Constructors
Constructor
new HealthcheckManager():
HealthcheckManager
Returns
HealthcheckManager
Methods
areAllHealthy()
areAllHealthy():
boolean
Defined in: HealthcheckManager.ts:80
Check if all services are healthy (SERVING)
Returns
boolean
True if all services are SERVING
clear()
clear():
void
Defined in: HealthcheckManager.ts:108
Clear all services
Returns
void
getAllStatuses()
getAllStatuses():
Map<string,ServiceStatus>
Defined in: HealthcheckManager.ts:71
Get all services health status
Returns
Map<string, ServiceStatus>
Map of service name to health status
getStatus()
getStatus(
service):ServiceStatus|undefined
Defined in: HealthcheckManager.ts:62
Get service health status
Parameters
service
string
Service name
Returns
ServiceStatus | undefined
Service status or undefined if not found
initialize()
initialize(
serviceNames):void
Defined in: HealthcheckManager.ts:96
Initialize services map
Merges new service names with existing state. Services that were already registered retain their current status. New services start with UNKNOWN status.
Parameters
serviceNames
string[]
Array of service names to track
Returns
void
update()
update(
status,service?):void
Defined in: HealthcheckManager.ts:39
Update service health status
When called without a service name, updates ALL registered services. When called with an unknown service name, throws an error.
Parameters
status
HealthCheckResponse_ServingStatus
New serving status
service?
string
Service name (if not provided, updates all services)
Returns
void
Throws
Error if service name is provided but not registered