-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Add Usage and API documentation
- Loading branch information
Showing
1 changed file
with
90 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,92 @@ | ||
glogg | ||
===== | ||
# 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 |