modlog

0.3.3 • Public • Published

modlog

a sane module specific logging solution

'use strict'
var log = require('modlog')('database')
 
log.info('db is doing good. just fyi.')
// [21:28:30][database] db is doing good. just fyi.

logs are only useful when you actually know who is saying what. it is easy to get your application to a point where logs are pouring in your console. this can help with all the noise and give seperate parts of your app there own name in your logs.

api

the module consists of a single function that initializes a logger.

modlog_factory(module_name[, options])

the first argument is the modules name and the second argument is an object that only has two properties.

option default description
logger global.console a way to replace the internal logging mechanism with something like winston.
format "H:i:s" allows for the customization of the timestamp. formatting is almost exactly like PHP's date function.
colors true should colors be enabled on the console

todo

  • timestamp formatting option
  • write unit tests for timestamp formatting
  • console colors
  • web inspector colors
  • log focusing (only letting one module through)
  • write some benchmarks

The MIT License (MIT)

Copyright © 2016 Nick Comer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Readme

Keywords

Package Sidebar

Install

npm i modlog

Weekly Downloads

12

Version

0.3.3

License

MIT

Last publish

Collaborators

  • nkcmr