📌 Podday Logger Documentation

The Podday Logger is a robust logging utility for Node.js applications. It provides colorized console outputs, file logging, Discord webhook integration, custom log levels, and timer functionality.
Github: https://mr-julus.is-a.dev/podday/github

Installation

npm install chalk axios fs path typescript ts-node

npm install podday-logger

Static Methods

• init(options): Initializes the logger.
• addCustomLevel(level, color, bg (optional), supl (optional)): Adds a custom log level.
• Custom(level, message): Logs a custom level message.
• send(message): Logs a raw message.
• info(message): Logs an info message.
• success(message): Logs a success message.
• debug(message): Logs a debug message.
• warn(message): Logs a warn message.
• error(message, error?): Logs an error message with optional error stack.
• startTimer(label): Starts a performance timer.
• stopTimer(label, message): Stops a timer and logs the elapsed time.
• colorize(color, text): Returns colorized text.
• getStats(): Returns log statistics.
• getStatsDetails(); Returns statistics in detail on how many times each level was logged.
• updateOptions(); Update a value in the init config.

Configuration Options

• discordWebhookUrl, (type: string) Discord webhook URL to send logs to a Discord channel. (Optional)
• discordMessageType ('embed' or 'simple'): Type of Discord message. (Optional)
• discordFilterLevels (type: array) Array of log levels to not be sent to Discord. (Optional)
• filterLevels (type: array) Array of log levels to not be show in the console. (Optional)
• colors Custom colors for log levels. (Optional)
• timestampFormat (type: string): Custom timestamp format. (Optional)
• silent (type: boolean): If true, disables console output. (Optional)
• logFilePath (type: string): Path to log file. (Optional)
• prefix (type: string): Prefix for all log messages. (Optional)

Colors Structure

• color, (type: string) The primary text color (e.g., 'blue', 'red', 'green') (Optional)
• bg (type: string): Background color (optional, e.g., 'bgBlue', 'bgRed', 'bgGreen'). (Optional)
• supl (type: string) Additional text styling (optional, e.g., 'bold', 'italic', 'underline'). (Optional)

LogViewer

• Constructor(filePath, filterLevel (optional)): Initializes LogViewer with an optional level filter.
• viewLog(): Reads and prints the log file.

Example Usage

import { Logger } from './src/logger';
import { LogViewer } from './src/logViewer';
            
Logger.init({
    discordWebhookUrl: 'https://discord.com/api/webhooks/.../...',
    discordMessageType: 'embed',
    discordFilterLevels: ['error', 'warn'],
    filterLevels: ['debug'],
    logFilePath: 'logs/app.log',
    prefix: '[App] ',
    colors: {
        info: { color: 'blue' },
        debug: { color: 'gray' },
        success: { color: 'green' },
        warn: { color: 'yellow' },
        error: { color: 'red' }
    },
    timestampFormat: 'YYYY-MM-DD HH:mm:ss',
    silent: false
});
            
Logger.addCustomLevel('customLevel', 'magenta', 'black', 'bold');
Logger.Custom('customLevel', 'Message with custom level.');
            
Logger.send('Message sent via send method.');
Logger.info('This is an info message.');
Logger.success('Operation successful!');
Logger.debug('This is a debug message.');
Logger.warn('Warning: Something might be wrong.');
Logger.error('An error occurred.', new Error('Test Error'));
            
Logger.startTimer('testTimer');
setTimeout(() => {
    Logger.stopTimer('testTimer', 'Timer testTimer duration');
}, 1000);
            
Logger.getStats();
Logger.colorize('cyan', 'Text in cyan.');
Logger.updateOptions({ silent: true });
Logger.getStatsDetails()
            
const viewer = new LogViewer('logs/app.log');
viewer.viewLog();