Type Alias HealthCheckResult

Example

import { Result } from '@adonisjs/health'

// Success result
const result: HealthCheckResult = {
  message: 'Database connection is healthy',
  status: 'ok',
  finishedAt: new Date(),
  meta: { responseTime: 120 }
}

// Or using Result class
const result2 = Result.ok('Service is running')
  .setMetaData({ uptime: 86400 })
  .toJSON()
Copy