serialize-error

v8.0.0

Serialize/deserialize an error into a plain object

NPM

README

GitHub

Website

MIT

Latest version published 8 days ago

    npm install serialize-error

We couldn't find any similar packages Browse all packages

Package Health Score

79 / 100

Popularity
Influential project
Maintenance
Healthy
Security
No known security issues
Community
Sustainable

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Influential project

Weekly Downloads (2,481,310)

Dependents: 593
GitHub Stars: 255
Forks: 25
Contributors: 10

The npm package serialize-error receives a total of 2,481,310 downloads a week. As such, we scored serialize-error popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package serialize-error, we found that it has been starred 255 times, and that 593 other projects on the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

4.1.0

5.0.0

6.0.0

7.0.1

8.0.0

Indirect Vulnerabilities

4.1.0

5.0.0

6.0.0

7.0.1

8.0.0

License Risks

4.1.0

5.0.0

6.0.0

7.0.1

8.0.0

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security Policy: No

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like serialize-error is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test serialize-error

Fix it in your project with Snyk!

Maintenance

Healthy

Commit Frequency

Open Issues: 2
Merged PR: 15
Open PR: 0
Last Commit: 8 days ago

Further analysis of the maintenance status of serialize-error based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that serialize-error demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme.md: No
Contributing.md: No
Code of Conduct: No
Contributors: 10
Funding: Yes
License: MIT

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like serialize-error is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: >=10

Age: 5 years
Dependencies: 1 Direct / 1 Total
Versions: 13
Install Size: 8.87 kB
Dist-tags: 1
# of Files: 5
Maintainers: 1
TS Typings: No

We detected a total of 1 direct & transitive dependencies for serialize-error. See the full dependency tree of serialize-error

serialize-error has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

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);

console.log(deserialized);
//=> [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). Buffer properties are replaced with [object Buffer]. Circular references are handled. If the input object has a .toJSON() method, then it's called instead of serializing the object's properties. It's up to .toJSON() implementation to handle circular references and enumerability of the properties.

.toJSON example:

class ErrorWithDate extends Error {
    constructor() {
        super();
        this.date = new Date();
    }
}
const error = new ErrorWithDate();
serializeError(date);
// => {date: '1970-01-01T00:00:00.000Z', name, message, stack}

class ErrorWithToJSON extends Error {
    constructor() {
        super('🦄');
        this.date = new Date();
    }

    toJSON() {
        return serializeError(this);
    }
}
const error = new ErrorWithToJSON();
console.log(serializeError(error));
// => {date: '1970-01-01T00:00:00.000Z', message: '🦄', name, stack}

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.

serialize-error versions

Dist-Tags for serialize-error

latest

Version	Published	Tag	Node.js Compatability	Licenses	Dependencies	Direct Vulnerabilities	Publisher
8.0.0	08 January 2021	latest	>=10	MIT	1	0 H 0 M 0 L	sindresorhus
7.0.1	12 May 2020		>=10	MIT	1	0 H 0 M 0 L	sindresorhus
6.0.0	11 March 2020		>=10	MIT	1	0 H 0 M 0 L	sindresorhus
All Versions

Last updated on 14 January-2021, at 04:15 (UTC).

serialize-error

Serialize/deserialize an error into a plain object

Package Health Score

Popularity

Security

Security and license risk for significant versions

Version

Release Date

Direct Vulnerabilities

Indirect Vulnerabilities

License Risks

Maintenance

Community

Embed Package Health Score Badge

Package

serialize-error

Install

Usage

API

serializeError(value)

deserializeError(value)

serialize-error versions

serialize-error dependencies