3.0.4 âĸ Published 6 years ago
@openmind/litelog v3.0.4
đ 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
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 ~ |
3.0.4
6 years ago