Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Cleaner

The class that handles the cleaning code, doing the bigger part of the job.

Hierarchy

  • Cleaner

Index

Constructors

Properties

Methods

Constructors

constructor

  • The constructor of the class.

    Parameters

    • uri: string

      The uri for the MongoDB database.

    • connectionOptions: MongoClientOptions

      The connection options to the MongoDB.

    • options: Required<MongoCleanerOptions>

      The options for the cleaner.

    Returns Cleaner

Properties

Private connection

connection: MongoClient

The MongoDB connection.

Private Readonly connectionOptions

connectionOptions: MongoClientOptions

The connection options to the MongoDB.

Private Readonly logger

logger: Logger

The instance of the logger.

Private Readonly options

options: Required<MongoCleanerOptions>

The options for the cleaner.

Private Readonly uri

uri: string

The uri for the MongoDB database.

Methods

clean

  • clean(): Promise<void>

  • Does the whole process of cleaning the databases, based on the options given to the class constructor.

    throws

    MongoCleanerCleanError

    Returns Promise<void>

Private cleanCollection

  • cleanCollection(database: string, collection: string, attempts: number): Promise<void>

  • Cleans a collection, by removing it.

    throws

    MongoCleanerCleanError

    Parameters

    • database: string

      The database of the collection.

    • collection: string

      The collection to empty.

    • attempts: number

      The number of remaining attempts to clean the collection, after which an error could be thrown.

    Returns Promise<void>

Private cleanDatabase

  • cleanDatabase(database: string, attempts: number): Promise<void>

  • Cleans a database, by removing it.

    throws

    MongoCleanerCleanError

    Parameters

    • database: string

      The database to clean.

    • attempts: number

      The number of remaining attempts to clean the database, after which an error could be thrown.

    Returns Promise<void>

Private cleanDatabases

  • cleanDatabases(databases: string[]): Promise<void>

  • Cleans an array of databases.

    Parameters

    • databases: string[]

      The database to be cleaned.

    Returns Promise<void>

Private connect

  • connect(): Promise<void>

  • The method for connecting to the database.

    throws

    MongoCleanerConnectionError

    Returns Promise<void>

Private disconnect

  • disconnect(): Promise<void>

  • The method for disconnecting to the database.

    throws

    MongoCleanerDisconnectionError

    Returns Promise<void>

Private emptyCollection

  • emptyCollection(database: string, collection: string, attempts: number): Promise<void>

  • Empties a collection, by removing all its documents.

    throws

    MongoCleanerCleanError

    Parameters

    • database: string

      The database of the collection.

    • collection: string

      The collection to empty.

    • attempts: number

      The number of remaining attempts to empty the collection, after which an error could be thrown.

    Returns Promise<void>

Private emptyDatabase

  • emptyDatabase(database: string): Promise<void>

  • Empties a database, by removing all its collections.

    Parameters

    • database: string

      The database to empty.

    Returns Promise<void>

Private filterDatabase

  • filterDatabase(database: string): boolean

  • A method that passed a database name, based on the instance options, reurns true if the database is to be cleaned or false otherwise.

    Parameters

    • database: string

      The database name.

    Returns boolean

    If the database is to be cleaned.

Private getCollections

  • getCollections(database: string): Promise<string[]>

  • Fetches from MongoDB all the collections of a database and returns the ones that are to be cleaned.

    throws

    MongoCleanerListCollectionsError

    Parameters

    • database: string

      The database whose collections will be fetched.

    Returns Promise<string[]>

    The collections of the database that are to be cleaned.

Private getDatabases

  • getDatabases(): Promise<string[]>

  • Fetches from MongoDB all the databases and returns the ones that are to be cleaned.

    throws

    MongoCleanerListDatabasesError

    Returns Promise<string[]>

    The databases that are to be cleaned.

Private sleep

  • sleep(millisecond: number): Promise<void>

  • A method returning a promise that waits the passed number of milliseconds.

    Parameters

    • millisecond: number

      The number of milliseconds.

    Returns Promise<void>

Generated using TypeDoc