A named health indicator contributing to /health, /live, and /ready.
/health
/live
/ready
const dbIndicator: IHealthIndicator = { name: 'database', async check() { const healthy = await db.ping(); return { status: healthy ? 'up' : 'down' }; },}; Copy
const dbIndicator: IHealthIndicator = { name: 'database', async check() { const healthy = await db.ping(); return { status: healthy ? 'up' : 'down' }; },};
0.1.0
Readonly
Indicator name, unique per application.
Optional
Whether the indicator counts toward readiness. Defaults to true.
0.11.0
Performs the health check.
The health check result
A named health indicator contributing to
/health,/live, and/ready.Example
Since
0.1.0