@darthcav/ts-http-server
    Preparing search index...

    Type Alias HealthCheckResult

    Result of a single dependency health check, mapped into the checks object of the /health response per the IETF Health Check Response Format.

    The time field is populated automatically by the /health handler; any value supplied here is overwritten.

    type HealthCheckResult = {
        componentId?: string;
        componentType?: string;
        observedUnit?: string;
        observedValue?: unknown;
        output?: string;
        status: HealthStatus;
        time?: string;
    }
    Index

    Properties

    componentId? componentType? observedUnit? observedValue? output? status time?

    Properties

    componentId?: string

    Unique identifier of the checked component instance.

    componentType?: string

    Type of component, e.g. datastore, system, component.

    observedUnit?: string

    Unit of observedValue, e.g. ms, s, %.

    observedValue?: unknown

    Observed value of the measurement (e.g. a latency or count).

    output?: string

    Free-form output, typically an error message when status is fail.

    status: HealthStatus

    Status of the checked component.

    time?: string

    ISO 8601 time the check was evaluated; set automatically.

    Settings

    Member Visibility

    On This Page

    Properties