blob: d27f004f310cbb7b7dbb859b95d10f4111306e4e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
# serialize-error [](https://travis-ci.org/sindresorhus/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
```js
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.
Non-enumerable properties are kept non-enumerable (name, message, stack).
Enumerable properties are kept enumerable (all properties besides the non-enumerable ones).
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.
|
