@storehouse/redis-om - v1.0.0
    Preparing search index...

    Interface RedisOMHealthCheckResult

    Extended health check result specific to Redis-OM managers. Includes Redis connection status, ping response, and registered models.

    interface RedisOMHealthCheckResult {
        details: {
            error?: string;
            isOpen: boolean;
            isReady: boolean;
            latency?: string;
            models?: string[];
            name: string;
            pingResponse?: string | Buffer<ArrayBufferLike>;
            [key: string]: unknown;
        };
        healthy: boolean;
        latency?: number;
        message?: string;
        timestamp: number;
    }

    Hierarchy

    • HealthCheckResult
      • RedisOMHealthCheckResult
    Index

    Properties

    details healthy latency? message? timestamp

    Properties

    details: {
        error?: string;
        isOpen: boolean;
        isReady: boolean;
        latency?: string;
        models?: string[];
        name: string;
        pingResponse?: string | Buffer<ArrayBufferLike>;
        [key: string]: unknown;
    }

    Detailed information about the Redis connection health.

    Type Declaration

    • [key: string]: unknown

      Additional custom properties

    • Optionalerror?: string

      Error message if the health check failed

    • isOpen: boolean

      Whether the Redis connection is currently open

    • isReady: boolean

      Whether the Redis connection is ready to accept commands

    • Optionallatency?: string

      Time taken to perform the health check in milliseconds

    • Optionalmodels?: string[]

      List of registered model (schema) names

    • name: string

      The name of the manager

    • OptionalpingResponse?: string | Buffer<ArrayBufferLike>

      The response from the Redis PING command

    healthy: boolean

    Whether the connection is healthy

    latency?: number

    Response time in milliseconds

    message?: string

    Human-readable status message

    timestamp: number

    Unix timestamp when the check was performed

    Settings

    Member Visibility

    On This Page

    Properties