diff options
author | LinuxWizard42 <computerwizard@linuxmail.org> | 2022-10-12 22:54:37 +0300 |
---|---|---|
committer | LinuxWizard42 <computerwizard@linuxmail.org> | 2022-10-12 22:54:37 +0300 |
commit | 703e03aba33f234712206769f57717ba7d92d23d (patch) | |
tree | 0041f04ccb75bd5379c764e9fe42249fffe75fc3 /node_modules/serialize-error/readme.md | |
parent | ab6e257e6e9d9a483d7e86f220d8b209a2cd7753 (diff) | |
download | FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.gz FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.zst |
Added export_allowed file to make repository visible in cgit
Diffstat (limited to 'node_modules/serialize-error/readme.md')
-rw-r--r-- | node_modules/serialize-error/readme.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/node_modules/serialize-error/readme.md b/node_modules/serialize-error/readme.md new file mode 100644 index 0000000..d27f004 --- /dev/null +++ b/node_modules/serialize-error/readme.md @@ -0,0 +1,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. |