puckey / serialised-error

Serialises error object to normal object

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Serialised Error

This module attempts to convert an error object into a regular JavaScript object. This is useful if an error object has to be stored and operated upon.

Usage

var SerialisedError = require('serialised-error');

// assuming you have an error
var someError = new Error("This is a test error");

// convert the error to object (new operator is optional)
var serialisedError = new SerialisedError(someError);

// convert the serialised error to JSON
console.log(JSON.parse(serialisedError));

// this outputs:
// {"name": "Error", "message": "This is a test error", "stack": "Error\n   at ..."}

Adding additional meta information to error

Passing a second argument as true to the SerialisedError constructor adds the following keys to the serialised object.

Property Description
checksum a SHA1 checksum of the error that is constant for same name, message and stack
id a random UUID (v4) of the error
timestamp the time when the error was serialised
timestampISO the time (in ISO format) when the error was serialised
stacktrace a prettified array of stack traces

Installation

npm install serialised-error;

About

Serialises error object to normal object

License:Apache License 2.0


Languages

Language:JavaScript 100.0%