esrol-logger
Write different type of messages, create daily log files and output colored messages to the console.
Part of Esrol
Installation
$ npm install --save esrol-logger
Node Version Compatibility
Node Version |
---|
>= 4.x |
Examples
'use strict';let Logger = ;let logger = 'your-namespace'; // The following will write messages into log file// You can use LOGGER_TYPES=* node dummy.js or LOGGER_TYPES=info,error node dummy.js// to output message into consolelogger;logger;logger;logger;logger;logger;logger;logger;logger;// The debug behave just like node debug module// and you should use the DEBUG variable// DEBUG=your-namespace node dummy.js or DEBUG=* node dummy.js// Note: the debug method does not write message into log filelogger;// Or you can combine all of them like:// DEBUG=* LOGGER_TYPES=* node dummy.js// ENJOY THE RAINBOW :D
Logger
Methods
- setLogDir(directory)
set logs directory
- alert(kind, message) ⇒
string
Alert message, yellow color
- critical(kind, message) ⇒
string
Critical message, red color
- error(kind, message) ⇒
string
Error message, red color
- warning(kind, message) ⇒
string
Warning message, yellow color
- notice(kind, message) ⇒
string
Notice message, cyan color
- info(kind, message) ⇒
string
Info message, cyan color
- success(kind, message) ⇒
string
Success message, green color
- unauthorized(kind, message) ⇒
string
Unauthorized message, yellow color
- badrequest(kind, message) ⇒
string
Badrequest message, white color
static method setLogDir(directory)
set logs directory
Param | Type | Description |
---|---|---|
directory | string |
abs path to the folder |
string
alert(kind, message) ⇒ Alert message, yellow color
Returns: string
- message - formatted message
Param | Type | Description |
---|---|---|
kind | string |
additional info about the operation |
message | mixed |
the message to be written |
string
critical(kind, message) ⇒ Critical message, red color
Returns: string
- message - formatted message
Param | Type | Description |
---|---|---|
kind | string |
additional info about the operation |
message | mixed |
the message to be written |
string
error(kind, message) ⇒ Error message, red color
Returns: string
- message - formatted message
Param | Type | Description |
---|---|---|
kind | string |
additional info about the operation |
message | mixed |
the message to be written |
string
warning(kind, message) ⇒ Warning message, yellow color
Returns: string
- message - formatted message
Param | Type | Description |
---|---|---|
kind | string |
additional info about the operation |
message | mixed |
the message to be written |
string
notice(kind, message) ⇒ Notice message, cyan color
Returns: string
- message - formatted message
Param | Type | Description |
---|---|---|
kind | string |
additional info about the operation |
message | mixed |
the message to be written |
string
info(kind, message) ⇒ Info message, cyan color
Returns: string
- message - formatted message
Param | Type | Description |
---|---|---|
kind | string |
additional info about the operation |
message | mixed |
the message to be written |
string
success(kind, message) ⇒ Success message, green color
Returns: string
- message - formatted message
Param | Type | Description |
---|---|---|
kind | string |
additional info about the operation |
message | mixed |
the message to be written |
string
unauthorized(kind, message) ⇒ Unauthorized message, yellow color
Returns: string
- message - formatted message
Param | Type | Description |
---|---|---|
kind | string |
additional info about the operation |
message | mixed |
the message to be written |
string
badrequest(kind, message) ⇒ Badrequest message, white color
Returns: string
- message - formatted message
Param | Type | Description |
---|---|---|
kind | string |
additional info about the operation |
message | mixed |
the message to be written |
Note
If NODE_ENV=production
the message will not be shown in the console
Tests
To run the test suite, first install the dependencies, then run npm test
:
$ npm install$ npm test