Class Logger

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

Hierarchy

Logger

Index

Constructors

constructor

Methods

br debug error hr info setOptions success warning

Constructors

constructor

new Logger(options?: string | {
    debug?: boolean;
    palette?: { primary?: { info?: string | undefined; success?: string | undefined; debug?: string | undefined; warning?: string | undefined; error?: string | undefined; } | undefined; secondary?: { ...; } | undefined; };
    scope?: null | string;
}): Logger
The constructor of the Logger class.
Parameters
- Optional options: string | {
      debug?: boolean;
      palette?: { primary?: { info?: string | undefined; success?: string | undefined; debug?: string | undefined; warning?: string | undefined; error?: string | undefined; } | undefined; secondary?: { ...; } | undefined; };
      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

Methods

br

br(n?: number): void
Logs one or more empty lines.
Parameters
- n: number = 1
  
  The number of empty lines. Default is 1.
Returns void

debug

debug(message: string, object?: any): 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.
- Optional object: any
  
  An optional object to log.
Returns void

error

error(message: string, error?: any): void
Logs an error message. The format is "[ERROR] |{SCOPE}| message |object|", where |word| is optional.
Parameters
- message: string
  
  The message to be logged.
- Optional error: any
Returns void

hr

hr(n?: number, color?: string, symbol?: string): 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

info

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

setOptions

setOptions(options?: string | {
    debug?: boolean;
    palette?: { primary?: { info?: string | undefined; success?: string | undefined; debug?: string | undefined; warning?: string | undefined; error?: string | undefined; } | undefined; secondary?: { ...; } | undefined; };
    scope?: null | string;
}): void
Sets the options of the logger.
Parameters
- Optional options: string | {
      debug?: boolean;
      palette?: { primary?: { info?: string | undefined; success?: string | undefined; debug?: string | undefined; warning?: string | undefined; error?: string | undefined; } | undefined; secondary?: { ...; } | undefined; };
      scope?: null | string;
  }
  
  The options for the logger.
Returns void

success

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

warning

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

Class Logger

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional options: string | { debug?: boolean; palette?: { primary?: { info?: string | undefined; success?: string | undefined; debug?: string | undefined; warning?: string | undefined; error?: string | undefined; } | undefined; secondary?: { ...; } | undefined; }; scope?: null | string; }

Returns Logger

Methods

br

Parameters

n: number = 1

Returns void

debug

Parameters

message: string

Optional object: any

Returns void

error

Parameters

message: string

Optional error: any

Returns void

hr

Parameters

n: number = 1

color: string = 'white'

symbol: string = '-'

Returns void

info

Parameters

message: string

Optional object: any

Returns void

setOptions

Parameters

Optional options: string | { debug?: boolean; palette?: { primary?: { info?: string | undefined; success?: string | undefined; debug?: string | undefined; warning?: string | undefined; error?: string | undefined; } | undefined; secondary?: { ...; } | undefined; }; scope?: null | string; }

Returns void

success

Parameters

message: string

Optional object: any

Returns void

warning

Parameters

message: string

Optional object: any

Returns void

Settings

Member Visibility

Theme

`Optional` options: string | {
debug?: boolean;
palette?: { primary?: { info?: string | undefined; success?: string | undefined; debug?: string | undefined; warning?: string | undefined; error?: string | undefined; } | undefined; secondary?: { ...; } | undefined; };
scope?: null | string;
}

`Optional` object: any

`Optional` error: any

`Optional` object: any

`Optional` options: string | {
debug?: boolean;
palette?: { primary?: { info?: string | undefined; success?: string | undefined; debug?: string | undefined; warning?: string | undefined; error?: string | undefined; } | undefined; secondary?: { ...; } | undefined; };
scope?: null | string;
}

`Optional` object: any

`Optional` object: any