# Installation

Use npm command in order to install bh-logger module:

```bash
npm install [--save] bh-logger
```

# Log in a file

The bh-logger class allows to log anything in a file:

  - constructor(settings) : default constructor.

  Settings format:

  ```json
  {
    "folder" : "/var/log",
    "name" : "test.log"
  }
  ```

  - open()                : open the log file. Throw an exception if it failed, otherwise return true.
  - getLevels()           : return the different available lof levels.
  - addLevel(label)       : add a new log level. Throw an exception if the level already exists.
  - log(level, message)   : log a "message" with an importance described by "level". Throw an exception if it is impossible to write in the log file.
  - getStats()            : return the stat for the different log levels.
  - close()               : close the log file.

# Usage example

```js
var assert = require('assert');

var LoggerClass = require('bh-logger');
var SectionClass = require('bh-section');


var logger = new LoggerClass(new SectionClass({
  'folder' : '/var/log',
  'name' : 'test.log'
}));

logger.open();
logger.addLevel('demo');
logger.log('demo', 'hello');
assert.equal(logger.getStats().demo, 1);
logger.close();
```