Skip to main content

Function: probe()

probe(path, port, timeoutMs?): Promise<boolean>

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

Asks a probe listener one question. Resolves true only for a 200. Connection refused, a timeout or any other status resolve false; this never rejects, because its caller is a container healthcheck that needs an exit code.

Parameters​

path​

"/health/live" | "/health/ready" | "/health/startup"

One of HEALTH_PATHS.

port​

number

The probe listener's port.

timeoutMs?​

number = 3000

Default 3000.

Returns​

Promise<boolean>