Global logging utility
var getLogger = require('glogg');
var logger = getLogger('my-namespace');
// logs strings
logger.debug('The MOST verbose!');
logger.info('Some important info');
logger.warn('All the warnings to you');
logger.error('OH NO! SOMETHING HAPPENED!');
// supports util.format!
logger.info('%s style!', 'printf');
// log anything
logger.debug({ my: 'obj' });
logger.info([1, 2, 3]);
// somewhere else
logger.on('info', function(msg){
// do something with msg
});
// must be handled to avoid crashing process
logger.on('error', function(msg){
// now it won't crash
});
Note: This module makes no assumptions about the log levels and they will always be emitted. If you are looking to filter some out, your listeners will need to have extra logic.
Create a new logger at the given namespace (or the default if no namespace is provided).
Returns an augmented sparkles
EventEmitter object
with 4 methods: debug()
, info()
, warn()
and error()
. When called, these methods emit
an event with the same name. If the first argument is a string, the arguments
are passed through node's util.format()
before being emitted. Other parts
of a node program can get the logger by namespace and listen for the events to
be emitted.
Emits a debug
event with the given msg
.
If the first argument is a string, all arguments are passed to node's
util.format()
before being emitted.
Emits a info
event with the given msg
.
If the first argument is a string, all arguments are passed to node's
util.format()
before being emitted.
Emits a warn
event with the given msg
.
If the first argument is a string, all arguments are passed to node's
util.format()
before being emitted.
Emits a error
event with the given msg
.
If the first argument is a string, all arguments are passed to node's
util.format()
before being emitted.
Note: You must handle this event in some way or the node process will crash
when an error
event is emitted.
Standard API from node's EventEmitter
. Use this to listen for events from
the logger methods.
MIT
# glogg [![Travis Build Status](https://img.shields.io/travis/undertakerjs/glogg/master.svg?label=travis&style=flat-square)](https://travis-ci.org/undertakerjs/glogg) Global logging utility ## Usage ```js var getLogger = require('glogg'); var logger = getLogger('my-namespace'); // logs strings logger.debug('The MOST verbose!'); logger.info('Some important info'); logger.warn('All the warnings to you'); logger.error('OH NO! SOMETHING HAPPENED!'); // supports util.format! logger.info('%s style!', 'printf'); // log anything logger.debug({ my: 'obj' }); logger.info([1, 2, 3]); // somewhere else logger.on('info', function(msg){ // do something with msg }); // must be handled to avoid crashing process logger.on('error', function(msg){ // now it won't crash }); ``` ## API __Note: This module makes no assumptions about the log levels and they will always be emitted. If you are looking to filter some out, your listeners will need to have extra logic.__ ### getLogger([namespace]) Create a new logger at the given namespace (or the default if no namespace is provided). Returns an augmented [`sparkles`](https://github.com/phated/sparkles) EventEmitter object with 4 methods: `debug()`, `info()`, `warn()` and `error()`. When called, these methods emit an event with the same name. If the first argument is a string, the arguments are passed through node's `util.format()` before being emitted. Other parts of a node program can get the logger by namespace and listen for the events to be emitted. #### logger.debug(msg) Emits a `debug` event with the given `msg`. If the first argument is a string, all arguments are passed to node's `util.format()` before being emitted. #### logger.info(msg) Emits a `info` event with the given `msg`. If the first argument is a string, all arguments are passed to node's `util.format()` before being emitted. #### logger.warn(msg) Emits a `warn` event with the given `msg`. If the first argument is a string, all arguments are passed to node's `util.format()` before being emitted. #### logger.error(msg) Emits a `error` event with the given `msg`. If the first argument is a string, all arguments are passed to node's `util.format()` before being emitted. __Note: You must handle this event in some way or the node process will crash when an `error` event is emitted.__ #### logger.on(event, fn) Standard API from node's `EventEmitter`. Use this to listen for events from the logger methods. ## License MIT
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 19553 | swellard | Move and rename clients | ||
//guest/perforce_software/helix-web-services/main/source/clients/2016.1.0/javascript/node_modules/glogg/README.md | |||||
#1 | 18810 | tjuricek |
First-pass at JavaScript client SDK. JavaScript requires Node with Gulp to "browserfy" the library. It's the easiest way I found to use the swagger-js project; bundle up a wrapping method. There is no JavaScript reference guide. The swagger-js doesn't really document what they do very well, actually. Overall I'm not particularly impressed by swagger-js, it was hard to even figure out what the right method syntax was. We may want to invest time in doing it better. This required setting CORS response headers, which are currently defaulted to a fairly insecure setting. |