Class Log

This class is a utility for logging messages to the console and/or a log file. It supports different log levels ('NONE', 'DEBUG', 'INFO', 'WARN', 'ERROR') for both console and file logging. It also supports color formatting for console messages. Different colors can be specified for each log level.

Hierarchy

Index

Constructors

constructor

new Log(options?): Log
Create a new instance.
Parameters
- options: ILogOptions = {}
  
  Options for creating a new instance.
Returns Log
- Defined in packages/util/src/log/Log.ts:99

Properties

`Protected` consoleLogLevel

consoleLogLevel: LogLevel

The log level for console output. Can be 'NONE', 'DEBUG', 'INFO', 'WARN', or 'ERROR'.

`Protected` debugToConsole

debugToConsole: boolean

Whether to debug info to console.

`Protected` debugToFile

debugToFile: boolean

Whether to log debug info to the logfile.

`Protected` errorToConsole

errorToConsole: boolean

Whether to log errors to console.

`Protected` errorToFile

errorToFile: boolean

Whether to log errors to the logfile.

`Protected` fileLogLevel

fileLogLevel: LogLevel

The log level for the logfile. Can be 'NONE', 'DEBUG', 'INFO', 'WARN', or 'ERROR'.

`Protected` infoToConsole

infoToConsole: boolean

Whether to log info to console.

`Protected` infoToFile

infoToFile: boolean

Whether to log info to the logfile.

`Protected` logDirpath

logDirpath: string

The directory path of the log file.

`Protected` timezone

timezone: number

A negative or positive integer representing the timezone offset from UTC, in hours.

`Protected` warnToConsole

warnToConsole: boolean

Whether to log warnings to console.

`Protected` warnToFile

warnToFile: boolean

Whether to log warnings to the logfile.

`Static` optionDefaults

optionDefaults: Required<ILogOptions> = ...

Default options for creating new instances.

Accessors

logFilepath

get logFilepath(): string
The filepath of the log file.

Returns string
- Defined in packages/util/src/log/Log.ts:131

Methods

dashline

dashline(numLines?, width?): void
Prints a given number of lines with dashes to the console.
Parameters
- numLines: number = 1
  
  The number of dash lines to print.
- width: number = 80
  
  The number of dashes per line.
Returns void

Remarks
This is not logged to the log file.
- Defined in packages/util/src/log/Log.ts:235

debug

debug<T>(data, depth?): T
Logs a debug message the console.
Type Parameters
- T
Parameters
- data: T
  
  The message to print to console.
- Optional depth: number
  
  The depth to which to print object properties.
Returns T
- Defined in packages/util/src/log/Log.ts:154

deleteLogFiles

deleteLogFiles(deleteFilesOlderThan?): void
Delete log files older than the specified number of days.
Parameters
- deleteFilesOlderThan: number = 0
  
  The maximum age of log files in days. If not specified, no files will be deleted.
Returns void
- Defined in packages/util/src/log/Log.ts:210

error

error<T>(error): Error | T
Logs a error message to the console.
Type Parameters
- T
Parameters
- error: Error | T
  
  The Error object or message to print to console.
Returns Error | T
- Defined in packages/util/src/log/Log.ts:197

getProperties

getProperties(): {
    consoleLogLevel: LogLevel;
    debugToConsole: boolean;
    debugToFile: boolean;
    errorToConsole: boolean;
    errorToFile: boolean;
    fileLogLevel: LogLevel;
    infoToConsole: boolean;
    infoToFile: boolean;
    logDirpath: string;
    logFilepath: string;
    timezone: number;
    warnToConsole: boolean;
    warnToFile: boolean;
}
Get the current instance's properties.

Returns {
    consoleLogLevel: LogLevel;
    debugToConsole: boolean;
    debugToFile: boolean;
    errorToConsole: boolean;
    errorToFile: boolean;
    fileLogLevel: LogLevel;
    infoToConsole: boolean;
    infoToFile: boolean;
    logDirpath: string;
    logFilepath: string;
    timezone: number;
    warnToConsole: boolean;
    warnToFile: boolean;
}
- consoleLogLevel: LogLevel
- debugToConsole: boolean
- debugToFile: boolean
- errorToConsole: boolean
- errorToFile: boolean
- fileLogLevel: LogLevel
- infoToConsole: boolean
- infoToFile: boolean
- logDirpath: string
- logFilepath: string
- timezone: number
- warnToConsole: boolean
- warnToFile: boolean
- Defined in packages/util/src/log/Log.ts:289

info

info<T>(data, depth?): T
Logs an info message the console.
Type Parameters
- T
Parameters
- data: T
  
  The message to print to console.
- Optional depth: number
  
  The depth to which to print object properties.
Returns T
- Defined in packages/util/src/log/Log.ts:169

initialize

initialize(options?): void
Re-initialize the current instance with the specified options.
Parameters
- options: ILogOptions = {}
Returns void
- Defined in packages/util/src/log/Log.ts:145

logEmitterEvents

logEmitterEvents(emitter, options?): void
This function is used to print the events emitted by an EventEmitter.
Parameters
- emitter: EventEmitter
  
  The EventEmitter that is emitting the events.
- options: ILogEmitterEventsOptions = {}
  
  Options for logging the events.
Returns void

Remarks
This function allows you to see what events are being emitted by an EventEmitter at runtime.
- Defined in packages/util/src/log/Log.ts:248

`Protected` logToFile

logToFile<T>(loglevel, data): void
Write log entry to logfile
Type Parameters
- T
Parameters
- loglevel: LogLevel
  
  The log level.
- data: Error | T
  
  The message to print to console.
Returns void
- Defined in packages/util/src/log/Log.ts:275

newline

newline(numLines?): void
Prints a given number of blank lines to the console.
Parameters
- numLines: number = 10
  
  The number of blank lines to print.
Returns void

Remarks
This is not logged to the log file.
- Defined in packages/util/src/log/Log.ts:225

warn

warn<T>(data, depth?): T
Logs a warning message to the console.
Type Parameters
- T
Parameters
- data: T
  
  The message to print to console.
- Optional depth: number
Returns T
- Defined in packages/util/src/log/Log.ts:183

Class Log

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: ILogOptions = {}

Returns Log

Properties

Protected consoleLogLevel

Protected debugToConsole

Protected debugToFile

Protected errorToConsole

Protected errorToFile

Protected fileLogLevel

Protected infoToConsole

Protected infoToFile

Protected logDirpath

Protected timezone

Protected warnToConsole

Protected warnToFile

Static optionDefaults

Accessors

logFilepath

Returns string

Methods

dashline

Parameters

numLines: number = 1

width: number = 80

Returns void

Remarks

debug

Type Parameters

T

Parameters

data: T

Optional depth: number

Returns T

deleteLogFiles

Parameters

deleteFilesOlderThan: number = 0

Returns void

error

Type Parameters

T

Parameters

error: Error | T

Returns Error | T

getProperties

consoleLogLevel: LogLevel

debugToConsole: boolean

debugToFile: boolean

errorToConsole: boolean

errorToFile: boolean

fileLogLevel: LogLevel

infoToConsole: boolean

infoToFile: boolean

logDirpath: string

logFilepath: string

timezone: number

warnToConsole: boolean

warnToFile: boolean

info

Type Parameters

T

Parameters

data: T

Optional depth: number

Returns T

initialize

Parameters

options: ILogOptions = {}

Returns void

logEmitterEvents

Parameters

`Protected` consoleLogLevel

`Protected` debugToConsole

`Protected` debugToFile

`Protected` errorToConsole

`Protected` errorToFile

`Protected` fileLogLevel

`Protected` infoToConsole

`Protected` infoToFile

`Protected` logDirpath

`Protected` timezone

`Protected` warnToConsole

`Protected` warnToFile

`Static` optionDefaults

`Optional` depth: number

`Optional` depth: number

`Protected` logToFile

`Optional` depth: number