Beignet API reference
    Preparing search index...

    Interface HealthConfig<Ports>

    Health check configuration.

    interface HealthConfig<Ports> {
        check?: (ports: Ports) => Promise<HealthCheckResult>;
        checks?: HealthChecks<Ports>;
        enabled?: boolean;
        suggestedPath?: string;
        timeoutMs?: number;
    }

    Type Parameters

    • Ports
    Index
    check? checks? enabled? suggestedPath? timeoutMs?
    check?: (ports: Ports) => Promise<HealthCheckResult>

    Custom health check function

    checks?: HealthChecks<Ports>

    Named dependency checks for an app-owned readiness endpoint

    enabled?: boolean

    Enable health endpoint (default: false)

    suggestedPath?: string

    Suggested path for the health endpoint (e.g., "/api/health"). NOTE: This field is for documentation/metadata only and does not control routing. You must manually wire the healthHandler to your desired route.

    timeoutMs?: number

    Per-check timeout for named dependency checks

    Settings
    Member Visibility

    On This Page
    Properties