Not applicable to a browser context.
$ npm install @mdaemon/logfile --save
const LogFile = require("@mdaemon/logfile/dist/logfile.cjs");
import LogFile from "@mdaemon/logfile/dist/logfile.mjs";
/* default LogFileOptions
* logLevel: 0 (INFO)
* dir: "./logs"
* fileFormat: "log-%DATE%.log"
* logToConsole: false
* rollover: true
* useServerTime: true
* logStr: "%DATE% %TIME% | %LEVEL% | %MESSAGE%";
* startLog: "-----------------------------------------\n" +
* "------- Log Started: %DATETIME%\n" +
* "-----------------------------------------\n";
*
* endLog: "-----------------------------------------\n" +
* "------- Log Ended: %DATETIME%\n" +
* "-----------------------------------------\n";
*/
const { INFO, ERROR, WARN, CRITICAL, DEBUG } = LogFile;
const logFile = new LogFile({ logLevel: DEBUG });
logFile.start();
logFile.log("There was an error", 2);
logFile.stop();
/* file result
-----------------------------------------
------- Log Started: Fri, 08 Mar 2024 16:07:19 GMT
-----------------------------------------
2024-03-08 16:07:19 | ERROR | There was an error
-----------------------------------------
------- Log Ended: Fri, 08 Mar 2024 16:07:19 GMT
-----------------------------------------
*/
// set the log str
logFile.setLogStr("%DATE% %TIME% | %LEVEL% | %MESSAGE%");
// set the log dir
logFile.setLogDir("./logs");
// set the rollover boolean
logFile.setRollover(true);
// set the log level
logFile.setLogLevel(DEBUG);
// set the file name format
logFile.setFileFormat("log-%DATE%.log");
// set the log to console boolean
logFile.setLogToConsole(true);
// set the start log string
logFile.setStartLog("-----------------------------------------\n");
// set the end log string
logFile.setEndLog("-----------------------------------------\n");
// log help to the console
logFile.getHelp();
// log to info
logFile.info("This is an info log");
// log to warn
logFile.warn("This is a warn log");
// log to error
logFile.error("This is an error log");
// log to critical
logFile.critical("This is a critical log");
// log to debug
logFile.debug("This is a debug log");
-
setLogStr(format)
- Set the log entry format string -
setLogDir(path)
- Set the directory for log files -
setRollover(boolean)
- Enable/disable daily log file rollover -
setLogLevel(level)
- Set the minimum log level -
setFileFormat(format)
- Set the log filename format -
setLogToConsole(bool)
- Enable/disable console output -
setStartLog(string)
- Set the log file start string -
setEndLog(string)
- Set the log file end string -
setUseServerTime(bool)
- Enable/disable server time
-
info(message)
- Log an info message -
warn(message)
- Log a warning message -
error(message)
- Log an error message -
critical(message)
- Log a critical message -
debug(message)
- Log a debug message
-
getHelp()
- Display help information
Published under the LGPL-2.1 license.
Published by
MDaemon Technologies, Ltd.
Simple Secure Email
https://www.mdaemon.com