Class Logger

The logger class, its instances will be the euber loggers.

Index

Constructors

Methods

br debug error hr info setOptions success warning

Constructors

constructor

new Logger(options?): Logger
The constructor of the Logger class.
Parameters
- Optionaloptions: string | {
      debug?: boolean;
      palette?: {
          primary?: {
              debug?: string;
              error?: string;
              info?: string;
              success?: string;
              warning?: string;
          };
          secondary?: {
              debug?: string;
              error?: string;
              info?: string;
              success?: string;
              warning?: string;
          };
      };
      scope?: null | string;
  }
  The options of the logger. If you want to change only the scope you can pass it as a string.
Returns Logger
- Defined in utils/logger.ts:39

Methods

br

br(n?): void
Logs one or more empty lines.
Parameters
- n: number = 1
  The number of empty lines. Default is 1.
Returns void
- Defined in utils/logger.ts:121

debug

debug(message, object?): void
Logs a debug message. The format is "[DEBUG] |{SCOPE}| message |object|", where |word| is optional. If specified in the options, nothing will be logged.
Parameters
- message: string
  The message to be logged.
- Optionalobject: any
  An optional object to log.
Returns void
- Defined in utils/logger.ts:93

error

error(message, error?): void
Logs an error message. The format is "[ERROR] |{SCOPE}| message |object|", where |word| is optional.
Parameters
- message: string
  The message to be logged.
- Optionalerror: any
Returns void
- Defined in utils/logger.ts:113

hr

hr(n?, color?, symbol?): void
Logs one or more hr lines.
Parameters
- n: number = 1
  The number of hr lines to print. Default is 1.
- color: string = 'white'
  The colour of the font. Default is 'white'.
- symbol: string = '-'
  The symbol that constitutes the hr. Default is '-'.
Returns void
- Defined in utils/logger.ts:133

info

info(message, object?): void
Logs an info message. The format is "[INFO] |{SCOPE}| message |object|", where |word| is optional.
Parameters
- message: string
  The message to be logged.
- Optionalobject: any
  An optional object to log.
Returns void
- Defined in utils/logger.ts:75

setOptions

setOptions(options?): void
Sets the options of the logger.
Parameters
- Optionaloptions: string | {
      debug?: boolean;
      palette?: {
          primary?: {
              debug?: string;
              error?: string;
              info?: string;
              success?: string;
              warning?: string;
          };
          secondary?: {
              debug?: string;
              error?: string;
              info?: string;
              success?: string;
              warning?: string;
          };
      };
      scope?: null | string;
  }
  The options for the logger.
Returns void
- Defined in utils/logger.ts:66

success

success(message, object?): void
Logs a success message. The format is "[SUCCESS] |{SCOPE}| message |object|", where |word| is optional.
Parameters
- message: string
  The message to be logged.
- Optionalobject: any
  An optional object to log.
Returns void
- Defined in utils/logger.ts:84

warning

warning(message, object?): void
Logs a warning message. The format is "[WARNING] |{SCOPE}| message |object|", where |word| is optional.
Parameters
- message: string
  The message to be logged.
- Optionalobject: any
  An optional object to log.
Returns void
- Defined in utils/logger.ts:104