conlg

A lightweight and customizable logger utility for JavaScript/TypeScript applications.

Table of Contents

• Installation
• Usage
• API
  • LoggerOptions
  • createLogger
  • clg
• Contributing
• License

Installation

Install the package using npm:

npm install conlg

Or using yarn:

yarn add conlg

Usage

Basic Usage

Import and use the logger in your project:

import { clg, createLogger } from 'conlg';

// Using the default logger
clg('This is a log message');

// Creating a custom logger
const customLogger = createLogger({ prefix: '[Custom Logger]', isDev: true });
customLogger('This is a custom log message');

Environment-based Logging

The default logger will only output logs if SHOW_LOG is set to 'true'.

process.env.SHOW_LOG = 'true';
clg('This message will be logged');

process.env.SHOW_LOG = 'false';
clg('This message will not be logged');

API

LoggerOptions

An interface defining the configuration options for the logger.

interface LoggerOptions {
  prefix?: string;
  isDev?: boolean;
}

• prefix (optional): A string to prefix each log message with.
• isDev (optional): A boolean to indicate if logging is enabled. Defaults to true if SHOW_LOG is 'true'.

createLogger

Creates a new logger function with the specified options.

const logger = createLogger(options?: LoggerOptions);

• options (optional): An object adhering to the LoggerOptions interface.

Example:

const customLogger = createLogger({ prefix: '[App]', isDev: true });
customLogger('This is a log message');

clg

A default logger instance created with the default options.

Example:

clg('This is a default log message');

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.