Skip to content

Function: probeHealth()

Makaio Framework


Makaio Framework / utils/health-probe / probeHealth

probeHealth(url, timeoutMs?): Promise<HealthResult | null>

Defined in: ../../../packages/utils/src/health-probe.ts:20

Probe a running Makaio instance at the given URL.

string

Full URL of the /health endpoint (e.g. http://127.0.0.1:6252/health).

number = DEFAULT_PROBE_TIMEOUT_MS

Abort timeout in milliseconds (default 2000).

Promise<HealthResult | null>

Health result if the instance is alive and responding, null otherwise.