Simple-log-helper NPM

simple-log-helper

A lightweight logging utility to manage logs for different environments (development and production). Easily switch logging on or off based on your needs.

Installation

To install the package, use:

npm install simple-log-helper

Usage

Importing the Library

import { LogHelper } from "simple-log-helper";

const logHelper = new LogHelper();
logHelper.developmentLog("This is a development log.");
logHelper.productionLog("This is a production log.");

Class: `LogHelper`

new LogHelper(enableProductionMode: boolean = false)

Parameters:
- enableProductionMode (optional): A boolean value to toggle production mode. Defaults to false (production mode Off).
notations:
- #P : Production mode
- #D : Development mode
- $P : starting of function
- P$ : End of function

Methods

developmentLog(message: string): void
- Logs messages for development when enableProductionMode is set to false.
productionLog(message: string): void
- Logs messages for production when enableProductionMode is set to true.

Example

Development mode: on

All logs will get printed in this mode

const logHelper = new LogHelper(); // Development mode on by default
logHelper.developmentLog("This is a development log"); // #D 1/23/2025, 4:51:45 PM - This is a development log
logHelper.productionLog("This is a production log"); // #P 1/23/2025, 4:51:45 PM - This is a production log

Production mode: on

Only development logs will not get printed in this mode

const logHelper = new LogHelper(true); // enable production mode
logHelper.developmentLog("This is a development log"); // Logs will not get printed.
logHelper.productionLog("This is a production log"); // #P 1/23/2025, 4:51:45 PM - This is a production log
logHelper.fnInitLog('Function execution started'); // $P 1/23/2025, 4:51:45 PM - Function execution started
logHelper.fnEndLog('Function execution completed'); // P$ 1/23/2025, 4:51:45 PM - Function execution completed