Class Logger

A logger function which only logs only is the level of the message is greater than or equal to the log level specificd in the config. Strings support Chalk template literals.

Hierarchy

Logger

Index

Constructors

constructor

Properties

config

Methods

Constructors

constructor

new Logger(config: Config): Logger

- Defined in classes/higher-order/Logger.ts:15
Creates an instance of Logger to manage all kinds of logging.

Parameters
- config: Config
  
  Creates an instance of Logger.
Returns Logger

Properties

Private config

config: Config

The Config object provided to this instance.

Methods

Private chalk

chalk(level: LogLevels): Function

- Defined in classes/higher-order/Logger.ts:55
Parameters
- level: LogLevels
Returns Function

debug

debug(...messages: any | Array<any>): void

- Defined in classes/higher-order/Logger.ts:115
Logs all messages useful while debugging specially. Useful for providing more context to advanced users.

argument

{any|any[]} messages

Parameters
- Rest ...messages: any | Array<any>
Returns void

error

error(...messages: any | Array<any>): void

- Defined in classes/higher-order/Logger.ts:91
Logs a critical message. Does not exit the process.

argument

{any|any[]} messages

Parameters
- Rest ...messages: any | Array<any>
Returns void

fatal

fatal(error: any | Array<any>): void

- Defined in classes/higher-order/Logger.ts:79
Log a critical message. This exits the process.

argument

{any} error - Any valid error instance.

Parameters
- error: any | Array<any>
Returns void

info

info(...messages: any | Array<any>): void

- Defined in classes/higher-order/Logger.ts:107
Logs an informative message. Useful for general logging purposes.

argument

{any|any[]} messages

Parameters
- Rest ...messages: any | Array<any>
Returns void

Private print

print(message: any | Array<any>, level: LogLevels, prefix: string): void

- Defined in classes/higher-order/Logger.ts:39
The is the internal print function used by the logger to check the logLevel and print messages to the terminal.

Parameters
- message: any | Array<any>
  
  An item to be printed to the terminal.
- level: LogLevels
  
  The level of the log.
- prefix: string
  
  The string to prefix the log message with.
Returns void

warn

warn(...messages: any | Array<any>): void

- Defined in classes/higher-order/Logger.ts:99
Logs a warning. Used to highlight cause of problems.

argument

{any|any[]} messages

Parameters
- Rest ...messages: any | Array<any>
Returns void

Generated using TypeDoc