0.1.0 • Published 9 years ago

tidy-log v0.1.0

Weekly downloads
3
License
MIT
Repository
github
Last release
9 years ago

#Tidy Log

Warning: I use this to test everything related to github so that you should never use this.

Helper to manage your console.log() in your browsers.

build status code climate

##Features

  • Small file and low overhead
  • Provide extra information for debug
  • Log manager

##Tasks

  • Extra log style
  • Browsers compatility

##Usage

Download the tidy_log.js or tidy_log.min.js and include the file in you page.

var logger = tidyLog.create();

var xhr = logger.group('xhr');

xhr.log('start log');

##Api

####tidyLog.config(options)

Config the default options.

tidyLog.config({
  showTimeLabel:false
});

var logger = tidyLog.create();

logger.log('Log without time label');

options

  • showTimeLabel(default by true)
  • showPath(default by true)
  • display(default by true)
  • disable(default by false)
  • recordLog(default by false)

####tidyLog.create(options)

Initialize a new Logger with given options.

####Group.log()

Create a new log in this group.

####Group.getLogs()

Get logs that created in this group.

####Group.logHistory()

Recall console.log in all logs created by this group.

Note: You have to set recordLog as true if you want to use logHistory().

var logger = tidyLog.create({
  recordLog:true
});

logger.log('first log');//log '[21:16:54] first log'
logger.log('second log');//log '[21:16:54] second log'

logger.logHistory();
//log '[21:16:54] first log' and '[21:16:54] second log'

####Group.getGroups()

Get an array of child groups in this groups.

####Group.group(name)

Create a child group so that you can manage this kind of logs later.

var appLogger = tidyLog.create();

var xhrLogger = appLogger.group('xhr');

xhrLogger.log('start sending request...');

//...

xhrLogger.log('success');

##Test

Command karma run.

##License

MIT