Beignet API reference
    Preparing search index...

    Interface HealthConfig<Ports>

    Health check configuration.

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

    Type Parameters

    • Ports
    Index

    Properties

    check? enabled? suggestedPath?

    Properties

    check?: (ports: Ports) => Promise<HealthCheckResult>

    Custom health check function

    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.

    Settings

    Member Visibility

    On This Page

    Properties