Connectum API Reference / @connectum/healthcheck / HealthcheckOptions

Interface: HealthcheckOptions

Defined in: types.ts:27

Healthcheck protocol options

Properties

httpEnabled?

optional httpEnabled: boolean

Defined in: types.ts:32

Enable HTTP health endpoints

Default

false

---

httpPaths?

optional httpPaths: string[]

Defined in: types.ts:38

HTTP health endpoint paths that all respond with health status.

Default

["/healthz", "/health", "/readyz"]

---

manager?

optional manager: HealthcheckManager

Defined in: types.ts:51

Custom HealthcheckManager instance. Useful for testing or running multiple servers in one process. When not provided, uses the default module-level singleton.

---

watchInterval?

optional watchInterval: number

Defined in: types.ts:44

Watch interval in milliseconds for streaming health updates

Default

500