Members
COLORS :Object
A list of colors to beautify the log outputs.
Type:
- Object
- Source:
(constant) LOG_LEVELS :Object
The available log levels that can be passed as command-line arguments.
Type:
- Object
- Source:
(constant) LOG_TYPES :Object
The available log types.
Type:
- Object
- Source:
Methods
(static) abstractMethodExecution(source)
Create a log with log type ERROR that signals the execution of an
abstract method.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
source |
Object | null | The caller object. |
- Source:
(static) debug(message, source)
Create a log with log type DEBUG.
Debug logs provide a way for developers to gain insight into the internals
of the application during runtime. The log is printed to stderr if logging
is enabled and the application log level is set to ALL.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
message |
String | The message to log as DEBUG. | |
source |
Object | null | The caller object. |
- Source:
(static) disableLogging() → {Boolean}
Disable logging. Result logs are not affected.
- Source:
Returns:
If logging was previously enabled.
- Type
- Boolean
(static) enableLogging(enable)
Enable logging conditionally. Result logs are not affected.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
enable |
Boolean | true | If logging should be enabled. |
- Source:
(static) endTimed() → {Number}
End the timer if logging is enabled and return the elapsed time.
- Source:
Returns:
The elapsed time in milliseconds.
- Type
- Number
(static) error(message, source)
Create a log with log type ERROR.
Error logs indicate a faulty state of the system that, if not addressed
immediately, will lead to the termination of the application. The log is
printed to stderr if logging is enabled.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
message |
String | The message to log as ERROR | |
source |
Object | null | The caller object. |
- Source:
(static) info(message, source)
Create a log with log type INFO.
Info logs provide information about the state of an application and
represent expected behaviour. The log is printed to stdout if logging is
enabled and the application log level is set to ALL.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
message |
String | The message to log as INFO. | |
source |
Object | null | The caller object. |
- Source:
(static) result(message, source)
Publish a result to stdout without any additional information like log
level or caller class.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
message |
String | The result to log. | |
source |
Object | null | The caller object. |
- Source:
(static) section(title, source)
Log the beginning of a major section in the execution flow of a component
as an INFO log.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
title |
String | The title of the section. | |
source |
Object | null | The caller object. |
- Source:
(static) startTimed()
Start a timer if logging is enabled.
- Source:
(static) stat(message, source)
Create a log with log type STAT.
Statistical logs provide quantitative information and metrics about the
execution of a module. The log is printed to stdout if logging is enabled
and the application log level is set to ALL.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
message |
String | The message to log as STAT. | |
source |
Object | null | The caller object. |
- Source:
(static) warn(message, source)
Create a log with log type WARN.
Warning logs indicate a dangerous state or potentially unwanted behaviour
of the application. The log is printed to stdout if logging is enabled and
the application log level is at least set to WARN.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
message |
String | The message to log as WARN. | |
source |
Object | null | The caller object. |
- Source: