- Source:
Methods
function
LoggingSeverity() → {LoggingSeverity}
Get LoggingSeverity enum.
- Source:
Returns:
Return LoggingSeverity enum.
Type
LoggingSeverity
function
debug(message) → {bool}
Log a message with the DEBUG severity.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
string | message to be logged. |
- Source:
Returns:
Return true if the message has been logged.
Type
bool
function
destroy() → {undefined}
Destroy the logger and remove it from the parent logger if it is a child logger.
- Source:
Returns:
Type
undefined
function
error(message) → {bool}
Log a message with the ERROR severity.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
string | message to be logged. |
- Source:
Returns:
Return true if the message has been logged.
Type
bool
function
fatal(message) → {bool}
Log a message with the FATAL severity.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
string | message to be logged. |
- Source:
Returns:
Return true if the message has been logged.
Type
bool
function
getChild(name) → {Logging}
Create a child logger.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | name of the child logger. |
- Source:
Returns:
Return the child logger object.
Type
Logging
function
info(message) → {bool}
Log a message with the INFO severity.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
string | message to be logged. |
- Source:
Returns:
Return true if the message has been logged.
Type
bool
function
loggerEffectiveLevel() → {LoggingSeverity}
Get the logging severity level.
- Source:
Returns:
- The severity level of the logger.
Type
LoggingSeverity
function
name() → {string}
Get name of the logger.
- Source:
Returns:
logger's name.
Type
string
function
setLoggerLevel(level) → {undefined}
Set the logging severity level.
Parameters:
| Name | Type | Description |
|---|---|---|
level |
LoggingSeverity | The logging severity level. |
- Source:
Returns:
Type
undefined
function
warn(message) → {bool}
Log a message with the WARN severity.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
string | message to be logged. |
- Source:
Returns:
Return true if the message has been logged.
Type
bool
function
(static) configure(context) → {undefined}
Configure the logging system with the given context.
Parameters:
| Name | Type | Description |
|---|---|---|
context |
Context | The context to configure logging for. |
- Source:
Returns:
Type
undefined
function
(static) getLogger(name) → {Logging}
Create a logger by name.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | name of the logger. |
- Source:
Returns:
Return the logger object.
Type
Logging
function
(static) getLoggingDirectory() → {string}
Get the logging directory.
- Source:
Returns:
- The logging directory.
Type
string
function
(static) shutdown() → {undefined}
Shutdown the logging system.
- Source:
Returns:
Type
undefined