Collection of logging related functions
Methods
(static) create(logname, filename, optionsopt)
Creates a new log file
Parameters:
| Name | Type | Attributes | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
logname |
string | A log descriptor name. |
||||||||||||||||
filename |
string | A log filename. |
||||||||||||||||
options |
object |
<optional> |
Properties
|
(static) debug(lognameopt, message, …args)
Adds a log message with DEBUG prefix.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
logname |
string |
<optional> |
A log descriptor name. Uses a default log descriptor if not supplied. |
message |
any | A message to log. |
|
args |
* |
<repeatable> |
Arguments for the message that contains sprintf formats. |
(static) error(lognameopt, message, …args)
Adds a log message with ERROR prefix.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
logname |
string |
<optional> |
A log descriptor name. Uses a default log descriptor if not supplied. |
message |
any | A message to log. |
|
args |
* |
<repeatable> |
Arguments for the message that contains sprintf formats. |
(static) getDefaultDescriptor() → {logger.LogDescriptor}
Returns the default log descriptor.
Returns:
- Type
- logger.LogDescriptor
(static) getLogDescriptors() → {Array.<logger.LogDescriptor>}
Returns all log descriptors.
Returns:
- Type
- Array.<logger.LogDescriptor>
(static) info(lognameopt, message, …args)
Adds a log message with INFO prefix.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
logname |
string |
<optional> |
A log descriptor name. Uses a default log descriptor if not supplied. |
message |
any | A message to log. |
|
args |
* |
<repeatable> |
Arguments for the message that contains sprintf formats. |
(static) log(lognameopt, message, …args)
Add a log message to a specifiled log file.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
logname |
string |
<optional> |
A log descriptor name. Uses a default log descriptor if not supplied. |
message |
any | A message to log. |
|
args |
* |
<repeatable> |
Arguments for the message that contains sprintf formats. |
(static) setLogDuplication(filters)
Duplicates messages sent to specified log descriptors in the default log as well.
Example
logger.create('perf', 'perf.log')
logger.setDefaulterFilter(['perf'])
logger.info('perf', 'hello world')
// 'hello world' will be printed in 'perf.log' as well as the default log file.Parameters:
| Name | Type | Description |
|---|---|---|
filters |
Array.<string> | A list of log descriptor names. |
(static) sprintf(message, …args) → {string}
Creates a string using string formats based on sprintf.
Example
const formatted = sprintf('progress: %d%%', 90)
// formmated contains 'progress: 90%'.Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
string | A message to log. |
|
args |
* |
<repeatable> |
Arguments for the message that contains sprintf formats. |
Returns:
- Type
- string
(static) warn(lognameopt, message, …args)
Adds a log message with WARN prefix.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
logname |
string |
<optional> |
A log descriptor name. Uses a default log descriptor if not supplied. |
message |
any | A message to log. |
|
args |
* |
<repeatable> |
Arguments for the message that contains sprintf formats. |
Type Definitions
LogDescriptor
Properties:
| Name | Type | Description |
|---|---|---|
logname |
String | A log descriptor name. |
filename |
String | A log file name. |
useTimestamp |
Boolean | Shows timestamp in each log message if enabled. |
Type:
- object