@openmind/litelog

👀 Lite-Log 👀

Lite-Log is a lightweight (~700 byte gziped) logging library for web browsers written in JavaScript with no dependencies.
You will also be able to mute your logs, take a look at the examples below.

• Installation
• Usage
  • Basic usage
  • Static Method
  • Different log instances
  • Mute a logger
  • Mute a logger (more advanced usage)
  • Mute all loggers
  • Using aliases
• Available Methods

📦 Installation

Install using npm or yarn (still to be published)

$ npm install @openmind/litelog --save

$ yarn add @openmind/litelog

⚡️ Basic usage

import Log from '@openmind/litelog'

const Logger = new Log();

Logger.warn('Hey pay attention here!');
// => [~ ✋ Lite-log ~] Hey pay attention here!

⚡️ Static Method

Logger('Log this!');
// => [~ 👀 ~] Log this!

⚡️ Different log instances

Let's make an example. If you want to debug only a shopping cart component, you can initalize your log instance passing a string as first argument in your Log() instance:

import Log from '@openmind/litelog'

const ShoppingCartLogger = new Log('Shopping cart');

ShoppingCartLogger.log('Debug here!');
// => [~ 👀 Shopping cart ~] Debug here!

As you can see, you will have a reference of your instanced logger in your console.

⚡️ Mute a logger

You're also able to mute a logger. Take a look at the following example:

import Log from '@openmind/litelog'

const ShoppingCartLogger = new Log('Shopping cart');

ShoppingCartLogger.mute(true);

ShoppingCartLogger.log('Debug here!');
// => no output!

⚡️ Mute a logger (more advanced usage)

import Log from '@openmind/litelog'
import { env } from 'app.env'

const environment = env === "development";
// If env === development, environment variable will be TRUE

const ShoppingCartLogger = new Log('Shopping cart');

ShoppingCartLogger.mute(environment);

ShoppingCartLogger.log('Debug here!');
// => no output! In that case, environment variable results false!

⚡️ Mute all loggers

import Log from '@openmind/litelog'

Log.mute(true);

⚡️ Using aliases

Evey method has an alias. Check the example and the table below to learn more:

import Log from '@openmind/litelog'

const Logger = new Log();

Logger.l('Hey!');
// => [~ 👀 Lite-log ~] Hey!

Logger.w('What a bad error!');
// => [~ ✋ Lite-log ~] What a bad error!

🚀 Available methods

Method	Alias	Js Api	Output
log	l	console.log()	[~ 👀 Lite-log ~]
warn	w	console.warn()	[~ ✋ Lite-log ~]
error	e	console.error()	[~ ‼️ Lite-log ~]
info	i	console.info()	[~ ℹ️ Lite-log ~]
debug	d	console.debug()	[~ 🐛 Lite-log ~]