Class Logger

The logger class.

Hierarchy

Logger

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Logger(options: Required<MongoCleanerOptions>): Logger

- Defined in source/lib/utils/logger.ts:22
The constructor of the logger class.

Parameters
- options: Required<MongoCleanerOptions>
  
  The options of the logger.
Returns Logger

Properties

Private Readonly log

log: boolean

If the logger is activated.

Private spinner

spinner: Ora

The instance of a spinner made by the ora module.

Methods

printDatabase

printDatabase(database: string): void

- Defined in source/lib/utils/logger.ts:60
Prints a database.

Parameters
- database: string
  
  The database to print.
Returns void

startDropCollection

startDropCollection(collection: string): void

- Defined in source/lib/utils/logger.ts:86
Starts the log for dropping a collection, by showing a spinner.

Parameters
- collection: string
  
  The collection that is going to be dropped.
Returns void

startDropDatabase

startDropDatabase(database: string): void

- Defined in source/lib/utils/logger.ts:70
Starts the log for dropping a database, by showing a spinner.

Parameters
- database: string
  
  The database that is going to be dropped.
Returns void

startEmptyCollection

startEmptyCollection(collection: string): void

- Defined in source/lib/utils/logger.ts:102
Starts the log for emptying a collection, by showing a spinner.

Parameters
- collection: string
  
  The collection that is going to be emptied.
Returns void

Private startSpinner

startSpinner(message: string): void

- Defined in source/lib/utils/logger.ts:30
Helper method for starting the spinner.

Parameters
- message: string
  
  The message to log.
Returns void

stopAndClear

stopAndClear(): void

- Defined in source/lib/utils/logger.ts:117
Stops the current spinner, deleting its last output.

Returns void

stopDropCollection

stopDropCollection(succeded: boolean, fallback?: boolean): void

- Defined in source/lib/utils/logger.ts:94
Stops the log for dropping a collection, by stopping the current spinner.

Parameters
- succeded: boolean
  
  If the operation succeded.
- Optional fallback: boolean
  
  If there is a fallback in case the operation did not succed.
Returns void

stopDropDatabase

stopDropDatabase(succeded: boolean, fallback?: boolean): void

- Defined in source/lib/utils/logger.ts:78
Stops the log for dropping a database, by stopping the current spinner.

Parameters
- succeded: boolean
  
  If the operation succeded.
- Optional fallback: boolean
  
  If there is a fallback in case the operation did not succed.
Returns void

stopEmptyCollection

stopEmptyCollection(succeded: boolean): void

- Defined in source/lib/utils/logger.ts:110
Stops the log for emptying a collection, by stopping the current spinner.

Parameters
- succeded: boolean
  
  If the operation succeded.
Returns void

Private stopSpinner

stopSpinner(succeded: boolean, fallback?: boolean): void

- Defined in source/lib/utils/logger.ts:44
Helper method for stopping the spinner.

Parameters
- succeded: boolean
  
  If the outcome were positive.
- Optional fallback: boolean
  
  If the outcome were negative, use a fallback.
Returns void

Generated using TypeDoc