dump-die/README.md

Dump an object and kill the process in node.js

# dump-die

[![Latest Version on NPM](https://img.shields.io/npm/v/dump-die.svg?style=flat-square)](https://npmjs.com/package/dump-die)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
[![Build Status](https://img.shields.io/travis/spatie/dump-die.svg?style=flat-square)](https://travis-ci.org/spatie/dump-die)
[![Code Climate](https://img.shields.io/codeclimate/github/spatie/dump-die.svg?style=flat-square)](https://img.shields.io/codeclimate/github/spatie/dump-die.svg)

Dump an object and kill the process in node.js for quick debugging. Based on Laravel's [`dd()` function](http://laravel.com/docs/master/helpers#method-dd).

## Installation

```bash
npm install dump-die
```

## Usage

Calling `dd` will print the object in your terminal and kill the process.

```es6
const dd = require('dump-die')

let myObject = {
    foo: 'bar',
    baz: function() {
        return 'Hi'
    }
}

```

Outputs:

```
{ foo: 'bar',
  baz:
   { [Function]
     [length]: 0,
     [name]: '',
     [prototype]: { [constructor]: [Circular] } } }
```

You can dump any amount of objects.

```es6
let foo = 'bar', hodor = { hodor: 'hodor' }
dd(foo, baz, hodor)
```

Outputs:

```
'bar'
{ hodor: 'hodor' }
```

If you don't want to kill the process, you can require the inspect function (which is a simple wrapper around node.js' `util.inspect`)

```es6
const inspect = require('dump-die/lib/inspect')

inspect({ foo: 'bar' }) // => '{ foo: \u001b[32m\'bar\'\u001b[39m }'
```

## Testing

You can run the tests (ESLint & Mocha) with:

```bash
npm run test
```

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security

If you discover any security related issues, please email [freek@spatie.be](mailto:freek@spatie.be) instead of using the issue tracker.

## Credits

- [Sebastian De Deyne](https://github.com/sebastiandedeyne)
- [All Contributors](../../contributors)

## About Spatie

Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.