Class MongooseManager

constructor

• new MongooseManager(settings: MongooseManagerArg): MongooseManager

  Parameters

  • settings: MongooseManagerArg

  Returns MongooseManager

Static Readonlytype

closeConnection

• closeConnection(): Promise<void>

  Close the connection gracefully

  Returns Promise<void>

  Promise that resolves when connection is closed, or void for synchronous close

connect

• connect(): Promise<Connection>

  Returns Promise<Connection>

getConnection

• getConnection(): Connection

  Get the underlying connection/client instance

  Returns Connection

  The connection object (database client, pool, etc.)

getModel

• getModel<
      T = {},
      TModel extends
          Model<
              T,
              {},
              {},
              {},
              IfAny<
                  T,
                  any,
                  Document<unknown, {}, T, {}, DefaultSchemaOptions> & Require_id<T> & {
                      __v: number;
                  } & AddDefaultId<T, {}, DefaultSchemaOptions>,
              >,
              any,
              T,
          > = Model<
          T,
          {},
          {},
          {},
          IfAny<
              T,
              any,
              Document<unknown, {}, T, {}, DefaultSchemaOptions> & Require_id<T> & {
                  __v: number;
              } & AddDefaultId<T, {}, DefaultSchemaOptions>,
          >,
          any,
          T,
      >,
      TQueryHelpers = unknown,
  >(
      name: string,
  ): TModel & WithAggregationMethod

  Get a model by name (optional)

  Type Parameters

  • T = {}
  • TModel extends Model<
        T,
        {},
        {},
        {},
        IfAny<
            T,
            any,
            Document<unknown, {}, T, {}, DefaultSchemaOptions> & Require_id<T> & {
                __v: number;
            } & AddDefaultId<T, {}, DefaultSchemaOptions>,
        >,
        any,
        T,
    > = Model<
        T,
        {},
        {},
        {},
        IfAny<
            T,
            any,
            Document<unknown, {}, T, {}, DefaultSchemaOptions> & Require_id<T> & {
                __v: number;
            } & AddDefaultId<T, {}, DefaultSchemaOptions>,
        >,
        any,
        T,
    >
  • TQueryHelpers = unknown

  Parameters

  • name: string

    The name of the model to retrieve

  Returns TModel & WithAggregationMethod

  The model instance or undefined if not found

healthCheck

• healthCheck(): Promise<MongooseHealthCheckResult>

  Check if the connection is healthy and responsive (optional)

  Returns Promise<MongooseHealthCheckResult>

  Health check result with status and optional details

isConnected

• isConnected(): Promise<boolean>

  Check if the connection is currently connected/active (optional)

  Returns Promise<boolean>

  true if connected, false otherwise

toObjectId

• toObjectId(
      value?: string | ObjectId | Uint8Array<ArrayBufferLike> | ObjectIdLike,
  ): ObjectId | undefined

  Parameters

  • Optionalvalue: string | ObjectId | Uint8Array<ArrayBufferLike> | ObjectIdLike

  Returns ObjectId | undefined