Skip to content

LunaCrew/logger

Repository files navigation

Logger

This Logger package is a utility for logging messages in your application. It provides a simple and flexible way to record important events, errors, and debugging information.

License MIT Tests Status
NPM Version NPM Downloads NPM Type Definitions

npm install @lunacrew/logger

Usage

To use the Logger package in your project, follow these steps:

Installation

npm install @lunacrew/logger

Import the Log module into your code:

// CommonJS
const Log = require('@lunacrew/logger')

// ES6
import Log from '@lunacrew/logger'

Logging

/**
* @required {string} message - data to be logged.
* @optional {string} tag - use to help identify the source of the log message.
*/

Log.d(message: string, tag: string); // Debug log
Log.i(message: string, tag: string); // Info log
Log.w(message: string, tag: string); // Warning log
Log.e(message: string, tag: string); // Error log
Log.v(message: string, tag: string); // Verbose log  

Custom Log Format

/**
 * Logs a custom message with optional formatting options.
 * 
 * @param message - The message to log.
 * @param options - The formatting options for the log message.
 * @param options.tag - The tag to display before the message.
 * @param options.tagColor - The color of the tag.
 * @param options.tagIcon - The icon to display with the tag.
 * @param options.iconColor - The color of the tag icon.
 * @param options.messageColor - The color of the log message.
 */

Log.custom(message: string, options: {
  tag?: string,
  tagColor?: string,
  tagIcon?: string,
  iconColor?: string,
  messageColor?: string
});