README.hbs

# node-trailer

[![npm](https://img.shields.io/npm/v/node-trailer.svg)](https://npmjs.org/package/node-trailer)

> A logger built with middleware, based on [trough](https://github.com/wooorm/trough).

* Create a logger without middlewares will use the default theme;
* Create a customize logger with middlewares.
  * There are 3 types middleware:
    * `Filter` decide what can be handle by next middleware;
    * `Appender` render different part of message as a log;
    * `Output` use appenders generating the log and send it to different place.

![Preview](./images/preview.png)

## Installation

Install using [npm](https://www.npmjs.org/):

```sh
npm i -P node-trailer
```

## Usage

Basic usage:

```javascript
import createLogger from "node-trailer"

const logger = createLogger({ level: 'info' })
logger.log('log message.') // No output
logger.info('info message.') //=> info message.
```

Customize:

```javascript
const pipeline = trough()
  // Filter
  .use(filter(({ options, level }: LoggerContext) =>
    levelWeight[options.level] <= levelWeight[level]
  ))
  // Appender
  .use(level(levelColor))
  .use(message())
  .use(error())
  // Output
  .use(colorConsole())

const logger = createLogger({}, pipeline)
```

## API Reference

- node-trailer
  {{#module name="node-trailer"}}
  - inner
    {{#functions scope="inner"}}
    - [{{name}}()](./docs/modules.md#{{name}})
    {{/functions}}
    {{/module}}
    - :Middleware
      {{#functions category="middleware"}}
      - [{{name}}()](./docs/modules.md#{{name}})
      {{/functions}}
      - :Appender
        {{#functions category="middleware:appender"}}
        - [{{name}}()](./docs/modules.md#{{name}})
        {{/functions}}
      - :Output
        {{#functions category="middleware:output"}}
        - [{{name}}()](./docs/modules.md#{{name}})
        {{/functions}}

## Tests

Run tests using `npm test`.

## Contributing

Please submit all issues and pull requests to the [plylrnsdy/node-trailer](http://github.com/plylrnsdy/node-trailer) repository!

## Support

If you have any problem or suggestion please open an issue [here](https://github.com/plylrnsdy/node-trailer/issues).