History

Gitea 3c54e41b29 Adding a Done msg at the end of the cmd		2019-12-27 17:07:43 +01:00
..
index.d.ts	Adding a Done msg at the end of the cmd	2019-12-27 17:07:43 +01:00
index.js	Adding a Done msg at the end of the cmd	2019-12-27 17:07:43 +01:00
license	Adding a Done msg at the end of the cmd	2019-12-27 17:07:43 +01:00
package.json	Adding a Done msg at the end of the cmd	2019-12-27 17:07:43 +01:00
readme.md	Adding a Done msg at the end of the cmd	2019-12-27 17:07:43 +01:00

readme.md

serialize-error

Serialize/deserialize an error into a plain object

Useful if you for example need to JSON.stringify() or process.send() the error.

Install

$ npm install serialize-error

Usage

const {serializeError, deserializeError} = require('serialize-error');

const error = new Error('🦄');

console.log(error);
//=> [Error: 🦄]

const serialized = serializeError(error)

console.log(serialized);
//=> {name: 'Error', message: '🦄', stack: 'Error: 🦄\n    at Object.<anonymous> …'}

const deserialized = deserializeError(serialized);
//=> [Error: 🦄]

API

serializeError(value)

Type: Error | unknown

Serialize an Error object into a plain object.

Non-error values are passed through. Custom properties are preserved. Circular references are handled.

deserializeError(value)

Type: {[key: string]: unknown} | unknown

Deserialize a plain object or any value into an Error object.

Error objects are passed through. Non-error values are wrapped in a NonError error. Custom properties are preserved. Circular references are handled.