anshluu / quiklogs

Quiklogs - The simplest way to log.

Intro

Logging data to consoles and terminals is an important part of communication with your user or debugger. Standard console.log is effective, yet messy and confusing. Quiklogs allows to to create colored Info, Warning, Error, and Success logs that stand boldly out and are easy to use. Our built in loading animations add a bit of style. What makes this different from all the other logging packages out there? How simple it is! Just define the package and start using logger.success()

Examples / Quick Start

Looking for the docs? Whoops, wrong spot. Just scroll a bit more or click here!

IMPORTANT: Woah! Wait, before you can start, install the package with npm install -g quiklogs

// Run this demo script!

const log =  require('quiklogs/logs');
const loader =  require("quiklogs/load");

// put your script name below
const logger =  new  log('your script name here')

  

logger.error('Uh oh! heres an error!')
logger.success('Everything is all good!')
logger.warning('Warning! something might happen...')
logger.info('Heres some info!')
logger.logtime('Heres some info!')

// Dot Loading Animation
loader.load('Dot Loading Animation...',  '3000') // the 10000 is the time in milliseconds you want it to last for

Docs

Section 1: Imports To import the logging module, use const log = require('quiklogs/logs'); To use the loading module, use const loader = require("quiklogs/load"); Section 2: Functions There are different sub functions based on what you want to log to the console. If we define the module as const log = require(...) and do const logger = new log('testing-script') than we can use the following sub functions:

Sub Function	What it does
logger.error(text)	Logs a red error badge along with your choice of text to the console.
logger.success(text)	Logs a green success badge along with your choice of text to the console.
logger.warning(text)	Logs a yellow warning badge along with your choice of text to the console.
logger.info(text)	Logs a badge along with your choice of text to the console.
logger.logtime(text)	Logs the current timestamp and text of your choice to the console.

The arguments here is text which can be filled with the text that you want to use with your log. Example: logger.success('They payment was successful!') would return