megaorm-logger

MegaORM Logger

MegaORM Logger is a simple, yet powerful utility for managing log files, with support for logging messages, retrieving entries, filtering by date, and more.

Features

• Retrieve all logs as objects or plain messages.
• Filter logs by a specific date.
• Clear log file content.
• Simple and intuitive API.

Installation

Install the package using npm or yarn:

npm install megaorm-logger

Usage

Import the Logger

const { Logger } = require('megaorm-logger');

Create a Logger Instance

Create an instance of the Logger class by specifying the path to your log file:

const logger = new Logger('./app.log');

Log a Message

Log a message to your log file:

await logger.log('This is a log message');

Retrieve Logs

Get All Logs

Retrieve all log entries as an array of objects:

const logs = await logger.get.logs();
console.log(logs);
// Output: [{ date: '2024-10-12 12:34:56', message: 'This is a log message' }, ...]

Get All Messages

Retrieve all log messages as plain strings:

const messages = await logger.get.messages();
console.log(messages);
// Output: ['This is a log message', ...]

Get Logs from a Specific Date

Retrieve log messages starting from a specific date:

const messagesFromDate = await logger.get.from('2024-10-12 00:00:00');
console.log(messagesFromDate);
// Output: ['Log message from 2024-10-12', ...]

Clear Logs

Clear all log entries in the log file:

await logger.clear();

API Reference

Constructor

new Logger(path: string)

• path: The file path where logs are stored. Must be a valid string.

Methods

• log(message: string): Promise

  • Logs a message with a UTC timestamp.
  • message: The message to log. Must be a string.
  • Throws: LoggerError if the message is invalid.

• clear(): Promise

  • Clears all log entries in the file.
  • Throws: LoggerError if an error occurs.

Getters

• get.path(): string

  • Returns the file path of the log file.

• get.logs(): Promise

  • Retrieves all log entries as an array of objects with date and message properties.

• get.messages(): Promise<string[]>

  • Retrieves all log messages as plain strings.

• get.from(date: string): Promise<string[]>

  • Retrieves log messages from a specific date onward.
  • date: A string in the format YYYY-MM-DD HH:MM:SS.
  • Throws: LoggerError if the date is invalid.

Notes

• Logs are stored in the format: [YYYY-MM-DD HH:MM:SS] message.
• The log file is created automatically if it does not exist.
• All dates and times are in UTC.