Nexus API Reference

HealthCheck

in

• Application

Tags

psalm-api

One probe. Implementations return a HealthStatus describing whether the check passed and an optional structured detail body.

Keep checks fast — they are called synchronously on every /health request. For expensive backends (cold remote dependencies), wrap the check in an actor that polls in the background and caches the latest result.

Table of Contents

Methods

check()  : HealthStatus

name()  : string

Human-readable identifier surfaced in the /health response payload.