website·Indexed 30 days ago
https://hack4impact.github.io/logger/A lightweight and easy-to-use logging library. It features a Logger class for managing log messages and output files, an Output class for synchronous flushing of outputs, and a comprehensive set of type aliases including Log, LogOptions, and ConsoleLevel.
Hack4Impact's Logger is a lightweight, dependency-free logging utility designed for fast installation and minimal overhead. Key characteristics include:
Output class allows developers to store a series of messages or nested output instances in an array and flush them all at once synchronously.const output = new Output();
output.log("Hello World");
output.flush();@hack4impact/logger package using npm or yarn.# Using npm
npm install @hack4impact/logger
# Using yarn
yarn add @hack4impact/loggerLogger class. You can optionally provide a configuration object to specify the output file path.const logger = new Logger({ logsPath: __dirname + "/logs.json" });line method logs an empty line to the console to improve output readability.Logger.line();log method prints a message to the console. It supports substitution strings (e.g., %s) via optional parameters.Logger.log("hi");
Logger.log("hi %s", "Bill");The Output class provides several methods to manipulate the log buffer before flushing:
log(value): Adds a message to the output array.line(): Adds a line break to the output array.nested(): Creates and adds a nested Output instance to the current array.flush(): Logs all accumulated messages in the output array.output (accessor): Gets or sets the array of messages/nested outputs.const mainOutput = new Output();
mainOutput.log("Main log");
const nested = mainOutput.nested();
nested.log("Nested log 1");
nested.log("Nested log 2");
mainOutput.line();
mainOutput.log("Back to main");
mainOutput.flush();error() method logs error messages to the console. By default, it writes the log to the configured output file. Use logOptions to disable file writing or provide extra metadata.// Basic usage: logs to console and writes to file
await logger.error("Hello");
// Log to console ONLY (do not write to file)
await logger.error("Hello", { writeToFile: false });
// Explicitly log to console and write to file
await logger.error("Hello", { writeToFile: true });info() method logs messages to the console. By default, it also writes the log to the configured output file. You can override this behavior using logOptions.// Basic usage: logs to console and writes to file
await logger.info("Hello");
await logger.info(2);
await logger.info(["hi!", 4, ["nested string"]]);
// Log to console ONLY (do not write to file)
await logger.info("Hello", { writeToFile: false });
// Explicitly log to console and write to file
await logger.info("Hello", { writeToFile: true });writeLogs instance method writes all logs currently stored in the this.logs array to the configured output file. It returns a Promise that resolves when the write operation is complete.await logger.writeLogs();Logger class provides accessors to retrieve all logs generated by the instance and to get or set the destination file path for logs.// Get all logs output by this instance
const logs = logger.logs;
// Get the current output file path
const logsPath = logger.logsPath;
// Set a new output file path
logger.logsPath = __dirname + "/logs.json";coloredLog method adds a message to the output array with a specified ANSI color. It also supports an optional afterColored string that is appended to the same line without the color formatting.const output = new Output();
// Simple colored log
output.coloredLog("BgBlue", "hi");
// Colored log with trailing plain text
output.coloredLog("FgYellow", "hi", " this string will not be colored");