Api References NestJS

HealthCheckResult

interface

The result of a health check


interface HealthCheckResult {
  status: HealthCheckStatus
  info?: HealthIndicatorResult
  error?: HealthIndicatorResult
  details: HealthIndicatorResult
}

Properties

Property	Description
`status: HealthCheckStatus`	The overall status of the Health Check
`info?: HealthIndicatorResult`	The info object contains information of each health indicator which is of status "up"
`error?: HealthIndicatorResult`	The error object contains information of each health indicator which is of status "down"
`details: HealthIndicatorResult`	The details object contains information of every health indicator.