@globalleaderboards/sdk - v0.5.0
    Preparing search index...

    Interface DetailedHealthResponse

    Detailed health check response

    interface DetailedHealthResponse {
        status: "healthy" | "unhealthy";
        version: string;
        timestamp: string;
        services: {
            database: { status: "healthy" | "unhealthy"; latency?: number };
            cache: { status: "healthy" | "unhealthy"; latency?: number };
            storage: { status: "healthy" | "unhealthy"; latency?: number };
        };
        system: { memoryUsage: number; uptime: number; environment: string };
    }

    Hierarchy (View Summary)

    Index

    Properties

    status: "healthy" | "unhealthy"

    Health status

    version: string

    API version

    timestamp: string

    Current timestamp

    services: {
        database: { status: "healthy" | "unhealthy"; latency?: number };
        cache: { status: "healthy" | "unhealthy"; latency?: number };
        storage: { status: "healthy" | "unhealthy"; latency?: number };
    }

    Individual service statuses

    Type declaration

    • database: { status: "healthy" | "unhealthy"; latency?: number }

      Database health

    • cache: { status: "healthy" | "unhealthy"; latency?: number }

      Cache health

    • storage: { status: "healthy" | "unhealthy"; latency?: number }

      Storage health

    system: { memoryUsage: number; uptime: number; environment: string }

    System information

    Type declaration

    • memoryUsage: number

      Memory usage in MB

    • uptime: number

      Uptime in seconds

    • environment: string

      Environment