function runHealthCheck
runHealthCheck(
name: string,
): Promise<HealthCheckResult>

Runs a single health check and returns the result.

Examples

Example 1

const result = await runHealthCheck("database", async () => {
  const connected = await db.ping();
  return Result.ok(connected);
});

if (result.status === "ok") {
  console.log(`Database check passed in ${result.latencyMs}ms`);
}

Parameters

name: string

Name to identify this health check

The health check function to run

Return Type

A HealthCheckResult with status, latency, and optional error

Usage

import { runHealthCheck } from "trellis/index.ts";