bole-console/README.md

Console formatter for the bole logger

bole-console
============

#### Console formatter for the bole logger ####

[![npm][npm-image]][npm-url]

Plugin for the [bole][bole-url] logger. Formats and colorizes the JSON object and prints it to the stdout.

```javascript
var bole = require('bole');
var boleConsole = require('bole-console');

var boleConsoleStream = boleConsole({
  timestamp: true,
  requestDetails: true
});

bole.output([
  { level: 'info', stream: boleConsoleStream }
]);

var log = bole('my-module');
```

Some outputs:

- `log.warn ({ foo: 'bar' }, 'baz')`

  ![output1][output1]
- `log.error(new Error('foo'), 'bar')`

  ![output2][output2]
- `log.info(request, 'foo')`

  ![output3][output3]

___module_([options]) : Writable__  
Returns a new Writable stream instance.

Options:

- __timestamp__ - _Boolean_  
  Includes the ISO string of the current time. Default false.
- __hostname__ - _Boolean_  
  Includes the hostname of the current user. Default false.
- __pid__ - _Boolean_  
  Includes the pid of the current process. Default false.
- __indent__ - _Number_  
  Number of spaces for each level when objects are formatted. Default 2.
- __colors__ - _Boolean_  
  Prints the message with colors. Default true.
- __requestDetails__ - _Boolean_  
  Includes some details about the request such as headers and remote socket. Default false.

[npm-image]: http://img.shields.io/npm/v/bole-console.svg?style=flat
[npm-url]: https://npmjs.org/package/bole-console
[bole-url]: https://github.com/rvagg/bole
[output1]: https://github.com/gagle/node-bole-console/blob/master/images/output1.png
[output2]: https://github.com/gagle/node-bole-console/blob/master/images/output2.png
[output3]: https://github.com/gagle/node-bole-console/blob/master/images/output3.png