crap

Dump a heap snapshot upon an uncaught exception. Inspired by hapijs poop.

Installation

$ npm install oh-crap

Usage

This module exports a single function that when called, should be passed the directory where the heap snapshot should be written and also an optional error handler that will be passed the uncaught error after the heap snapshot is written.

It is recommended that you pass the optional error handler so that your application can log, cleanup and exit correctly. Otherwise the default error handler will simply exit the process.

``js
var crap = require('oh-crap')(__dirname, onerror);

// message instance
var msg = new Message({
name: 'yo',
event: 'order complete',
properties:{
products: { '0': { sku: 'xxx' } }
}
});

// cause an error
setTimeout(function(){
msg.properties.products.forEach(console.log);
}, 250);

// handle the error
function onerror(err){
console.error(err.stack);
setTimeout(function(){
console.error('exiting');
process.exit(1);
}, 1000);
}

// constructors make debugging life easier
function Message(obj){
this.type = obj.type;
this.event = obj.event;
this.properties = obj.properties;
}
`

When running the example above, the uncaught exception TypeError: Object #