Interface HealthCheckResult

Result of a health check.

{
  status: HealthStatus.UP,
  message: 'Database connection healthy',
  details: {
    latency: '5ms',
    connections: 10
  }
}

interface HealthCheckResult {
    status: HealthStatus;
    message?: string;
    details?: Record<string, unknown>;
}

Properties

The health status.

message?: string

Optional message describing the health status.

details?: Record<string, unknown>

Optional details about the health check.