Type alias HealthCheckResult

HealthCheckResult: {
    data?: {
        [key: string]: any;
    };
    description?: string;
    exception?: unknown;
    status: HealthStatus;
}

Represents the result of a health check.

Optional data?: {
[key: string]: any;
}

Additional key-value pairs describing the health of the component.
- [key: string]: any
Optional description?: string

A human-readable description of the status of the component that was checked.
Optional exception?: unknown

An Exception(JS Error) representing the exception that was thrown when checking for status (if any).
status: HealthStatus

A value indicating the status of the component that was checked.