Skip to main content
zerotal

Documentation


Documentation / @zerotal/core / health

health

Health checks and their configuration (the @zerotal/core/health subpath). Health is a registry of named probes behind the framework's /health endpoint; critical checks drive overall readiness and the HTTP 503 response, while non-critical failures degrade the report without failing readiness.

Example

import { Health } from "@zerotal/core/health";

Health.register("database", async () => {
  await DB.raw("select 1");
}, { critical: true });

Interfaces

Type Aliases

Variables