<h1 align="center">
<img height="150" src="https://cdn.rawgit.com/ziishaned/dumper.js/master/logo.svg" alt="Dumper.js - Dumps information about a variable" />
<br> Dumper.js
</h1>
<p align="center">
<a href="https://travis-ci.org/ziishaned/dumper.js" rel='nofollow' onclick='return false;'>
<img src="https://img.shields.io/travis/ziishaned/dumper.js/master.svg" alt="Build Status">
</a>
<a href="https://github.com/ziishaned/dumper.js" rel='nofollow' onclick='return false;'>
<img src="https://img.shields.io/badge/license-MIT-brightgreen.svg" alt="Software License">
</a>
</p>
<p align="center">
<a href="https://twitter.com/ziishaned" rel='nofollow' onclick='return false;'>
<img src="https://img.shields.io/twitter/follow/ziishaned.svg?style=social" />
</a>
<a href="https://github.com/ziishaned" rel='nofollow' onclick='return false;'>
<img src="https://img.shields.io/github/followers/ziishaned.svg?label=Follow%20%40ziishaned&style=social" />
</a>
</p>
<p align="center">
<a href="https://www.buymeacoffee.com/ziishaned" target="_blank" rel='nofollow' onclick='return false;'><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
</p>
<p align="center"><code>dumper.js</code> is a better and pretty variable inspector for your Node.js applications.</p>
## Installation
```bash
npm install --save-dev dumper.js
# or you may use yarn
yarn add dumper.js --dev
```
## Usage
### `dd()` Dump and Die
Calling `dd()` prints the output and kills the process
```js
const { dd } = require('dumper.js');
const users = [
{ user: 'barney', age: 36, active: true, createdAt: new Date(), getAge: () => this.age },
{ user: 'fred', age: 40, active: false, createdAt: new Date(), getAge: () => this.age },
{ user: 'pebbles', age: 1, active: true, createdAt: new Date(), getAge: () => this.age }
];
dd(users);
// Above variable will be printed
console.log('this will never be called');
```
Will output below result and kill the process. [Demo](https://runkit.com/ziishaned/5cc95de6c01d42001ae5eed5)

### `dump()` Dump and Continue
Calling `dump()` prints the output and continues with the processing
```js
const { dump } = require('dumper.js');
const users = [
{ user: 'barney', age: 36, active: true, createdAt: new Date(), getAge: () => this.age },
{ user: 'fred', age: 40, active: false, createdAt: new Date(), getAge: () => this.age },
{ user: 'pebbles', age: 1, active: true, createdAt: new Date(), getAge: () => this.age }
];
dump(users);
// Above variable will be printed and the process will continue
console.log('this will be called');
```
Will output below result and continue processing. [Demo](https://runkit.com/ziishaned/5cc95f368838bf001bb9a6b1)

## Contributions
Feel free to submit pull requests, create issues or spread the word.
## License
MIT © [Zeeshan Ahmad](https://twitter.com/ziishaned)