@ladjs/logger/README.md

Logger for Lad

# [**@ladjs/logger**](https://github.com/ladjs/logger)

[![build status](https://img.shields.io/travis/ladjs/logger.svg)](https://travis-ci.org/ladjs/logger)
[![code coverage](https://img.shields.io/codecov/c/github/ladjs/logger.svg)](https://codecov.io/gh/ladjs/logger)
[![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://github.com/lassjs/lass)
[![license](https://img.shields.io/github/license/ladjs/logger.svg)](<>)

> Logger for Lad


## Table of Contents

* [Install](#install)
* [Usage](#usage)
* [Hide timestamps from console output](#hide-timestamps-from-console-output)
* [Suppress logs](#suppress-logs)
* [Process name](#process-name)
* [Contributors](#contributors)
* [Trademark Notice](#trademark-notice)
* [License](#license)


## Install

[npm][]:

```sh
npm install @ladjs/logger
```

[yarn][]:

```sh
yarn add @ladjs/logger
```


## Usage

```js
const Logger = require('@ladjs/logger');

const logger = new Logger();

logger.info('hello world');
// info: hello world
```


## Hide timestamps from console output

```js
const Logger = require('@ladjs/logger');

const logger = new Logger({ timestamp: false });
```


## Suppress logs

This is useful when you want need logging turned on in certain circumstances.
For example when you're running tests you can set `logger.config.silent = true`.

```js
const Logger = require('@ladjs/logger');

const logger = new Logger({ silent: true });

logger.info('hello world');
```


## Process name

In case you need to run multiple node processes together we recommend passing a processName to the logger.

```js
const Logger = require('@ladjs/logger');

const logger = new Logger({ processName: 'web' });

logger.info('hello world');
// [web] info: hello world
```


## Contributors

| Name             | Website                   |
| ---------------- | ------------------------- |
| **Nick Baugh**   | <http://niftylettuce.com> |
| **Alexis Tyler** | <https://wvvw.me/>        |


## Trademark Notice

Lad, Lass, and their respective logos are trademarks of Niftylettuce LLC.
These trademarks may not be reproduced, distributed, transmitted, or otherwise used, except with the prior written permission of Niftylettuce LLC.
If you are seeking permission to use these trademarks, then please [contact us](mailto:niftylettuce@gmail.com).


## License

[MIT](LICENSE) © [Nick Baugh](http://niftylettuce.com)


## 

[npm]: https://www.npmjs.com/

[yarn]: https://yarnpkg.com/