@atic_c/multi-logger-js
v1.0.4
Published
A simple logger which is able to write in logfile
Downloads
4
Readme
logger-js
Free to use logger. It's a simple library that use console to print data and save it in files.
How to use
As any other logger, you can use :
log, info, debug, error
To use it in your project you can use it like:
const Logger = require('@atic_c/multi-logger-js');
const logger = new Logger("onStdout"); // will write on your console
const loggerWith = new Logger("WithLogfile", "./log"); // will write on your console and save in a logfile
const loggerWith = new Logger("WithLogfile", "./log", true); // will write on your console and save in a logfile (truncate it if it already exists)
The first argument is the name given to the process, the logfile will be called WithLogfile-standard.log
in that case.
Second parameter is the path to your log directory, if it's not given, the Logger will just write on stdout. If the path given is invalid, logfile will not be created and the Logger will just log on stdout. Moreover you will be alerted that the directory has not been found. (No error will be generated by the logger, as it's supposed to help you and not break your program).
Furthermore, if an error occurred it will be logged in the standard logfile but also in a error logfile, in our example WithLogfile-error.log
.
Finally, the last parameter is a boolean to let Logger knows if you want to overwrite logfile or not. By default logs will be append to the file.
Once you have initialize your logger, you can use it :
const txt = "a simple log";
const arr = [1,2,3,4,5];
const obj = { name: "toto", age: 19, city: "Toulouse" };
logger.log(txt);
logger.info("a simple info");
logger.debug("a simple debug);
logger.error("a simple error");
logger.log(arr);
logger.log(obj);
Logging
Each method take a string or a variable as argument.
If it's an object, it will be stringify before output to make it readable in a logfile. This is to avoid [Object Object]
in the middle of your file. (WARNING : in JS a = [1,2,3]
has an Object type : typeof a
will give object)
[LOG][2021-05-14 . 18:51] a simple log
[INF][2021-05-14 . 18:51] a simple info
[DEB][2021-05-14 . 18:51] a simple debug
[ERR][2021-05-14 . 18:51] a simple error
[LOG][2021-05-14 . 18:51] [1,2,3,4,5]
[LOG][2021-05-14 . 18:51] {"name":"toto","age":19,"city":"Toulouse"}
COMMENTS / ISSUES / PR
Feel free to fork it and make your custom version
LICENSE
MIT, see the source.