Interface: HealthCheck

Defined in: packages/common/src/health.ts:12

One dependency a service needs to serve (database, broker).

Properties

check

readonly check: () => void | Promise<void>

Defined in: packages/common/src/health.ts:16

Resolves if healthy; rejects or throws if not. The error is never reported.

Returns

void | Promise<void>

---

name

readonly name: string

Defined in: packages/common/src/health.ts:14

Reported by name when it fails. Must not contain anything sensitive.