@storehouse/mongodb - v3.0.0
    Preparing search index...

    Interface MongoDbHealthCheckResult

    Extended health check result specific to MongoDB managers. Includes MongoDB connection status and ping response.

    interface MongoDbHealthCheckResult {
        details: {
            databaseName?: string;
            error?: string;
            isOpen: boolean;
            isReady: boolean;
            latency?: string;
            name: string;
            pingResponse?: Document;
            [key: string]: unknown;
        };
        healthy: boolean;
        latency?: number;
        message?: string;
        timestamp: number;
    }

    Hierarchy

    • HealthCheckResult
      • MongoDbHealthCheckResult
    Index

    Properties

    details healthy latency? message? timestamp

    Properties

    details: {
        databaseName?: string;
        error?: string;
        isOpen: boolean;
        isReady: boolean;
        latency?: string;
        name: string;
        pingResponse?: Document;
        [key: string]: unknown;
    }

    Detailed information about the MongoDB connection health.

    Type Declaration

    • [key: string]: unknown

      Additional custom properties

    • OptionaldatabaseName?: string

      The name of the database

    • Optionalerror?: string

      Error message if the health check failed

    • isOpen: boolean

      Whether the MongoDB connection is currently open

    • isReady: boolean

      Whether the MongoDB connection is ready to accept commands

    • Optionallatency?: string

      Time taken to perform the health check in milliseconds

    • name: string

      The name of the manager

    • OptionalpingResponse?: Document

      The response from the MongoDB 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