serialize-error
Advanced tools
Package description
The serialize-error npm package is used to serialize error objects into plain objects, retaining as much information as possible. It can be useful for logging errors or sending them over the network, as standard Error objects may not be properly serialized by default JSON.stringify.
Serialize an Error object
This feature allows you to serialize a standard Error object into a JSON-friendly format, including properties like name, message, and stack.
{"error": {"name": "Error", "message": "An error occurred!", "stack": "Error: An error occurred!\n at Object.<anonymous> (/path/to/file.js:2:15)\n at Module._compile (internal/modules/cjs/loader.js:1137:30)\n at Object.Module._extensions..js (internal/modules/cjs/loader.js:1157:10)\n at Module.load (internal/modules/cjs/loader.js:985:32)\n at Function.Module._load (internal/modules/cjs/loader.js:878:14)\n at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:71:12)\n at internal/main/run_main_module.js:17:47"}}Serialize custom error properties
This feature allows you to serialize Error objects that have custom properties beyond the standard Error properties.
{"error": {"name": "CustomError", "message": "Something custom happened!", "customProperty": "Custom value", "stack": "CustomError: Something custom happened!\n at Object.<anonymous> (/path/to/file.js:2:15)\n at Module._compile (internal/modules/cjs/loader.js:1137:30)\n at Object.Module._extensions..js (internal/modules/cjs/loader.js:1157:10)\n at Module.load (internal/modules/cjs/loader.js:985:32)\n at Function.Module._load (internal/modules/cjs/loader.js:878:14)\n at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:71:12)\n at internal/main/run_main_module.js:17:47"}}This package is similar to serialize-error in that it provides a way to serialize error objects to JSON. It may differ in the specific implementation or additional options provided for serialization.
While not exclusively for error objects, serialize-javascript allows for the serialization of JavaScript expressions, including errors. It can serialize functions, regexes, and dates, in addition to errors, which may make it more versatile in some scenarios compared to serialize-error.
Readme
Serialize an error into a plain object
Useful if you for example need to JSON.stringify() or process.send() the error.
$ npm install serialize-error
const serializeError = require('serialize-error');
const error = new Error('unicorn');
console.log(error);
//=> [Error: unicorn]
console.log(serializeError(error));
//=> {name: 'Error', message: 'unicorn', stack: 'Error: unicorn\n at Object.<anonymous> …'}
MIT © Sindre Sorhus
FAQs
Serialize/deserialize an error into a plain object
The npm package serialize-error receives a total of 5,071,072 weekly downloads. As such, serialize-error popularity was classified as popular.
We found that serialize-error demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.
Security News
The NVD is facing a significant backlog with over 12,500 CVEs awaiting analysis, and more than 50% of known exploited vulnerabilities (KEVs) left unenriched since mid-February.