Type Alias HealthCheckReport

Example

import { HealthChecks } from '@adonisjs/health'
import { DiskSpaceCheck, MemoryHeapCheck } from '@adonisjs/health/checks'

const healthChecks = new HealthChecks()
healthChecks.register([
  new DiskSpaceCheck().warnWhenExceeds(70).failWhenExceeds(85),
  new MemoryHeapCheck().warnWhenExceeds('200 mb')
])

const report: HealthCheckReport = await healthChecks.run()

console.log(report.isHealthy) // true or false
console.log(report.status) // 'ok' | 'warning' | 'error'
console.log(report.checks.length) // 2
console.log(report.debugInfo.pid) // Process ID

// Check individual results
report.checks.forEach(check => {
  console.log(`${check.name}: ${check.status}`)
  if (check.isCached) {
    console.log('Result was cached')
  }
})
Copy