Skip to content

Healthcheck Core examples

import {
createHealthManager,
httpCheck,
startupCheck,
stringifyHealthJson,
} from "@nexload-sdk/healthcheck";
const health = createHealthManager({
service: { name: "worker" },
checks: [
startupCheck({ isStarted: () => queue.connected }),
httpCheck("upstream", "https://api.example.com/status", {
scopes: ["readiness"],
}),
],
});
const report = await health.run("readiness", {
profile: "standard",
});
const body = stringifyHealthJson(report, {
includeDetails: false,
redact: true,
});

The package test suite is the source-owned executable contract: core.test.mjs.

The documentation example is type-checked in CI: healthcheck.ts.