@common.js/serialize-error 11.0.0 → 11.0.1

package/README.md

@@ -2,4 +2,4 @@
 
 The [serialize-error](https://www.npmjs.com/package/serialize-error) package exported as CommonJS modules.
 
-Exported from [serialize-error@11.0.0](https://www.npmjs.com/package/serialize-error/v/11.0.0) using https://github.com/etienne-martin/common.js.
+Exported from [serialize-error@11.0.1](https://www.npmjs.com/package/serialize-error/v/11.0.1) using https://github.com/etienne-martin/common.js.

package/index.js

@@ -298,11 +298,11 @@ var commonProperties = [
         enumerable: false
     }, 
 ];
-var toJsonWasCalled = Symbol(".toJSON was called");
+var toJsonWasCalled = new WeakSet();
 var toJSON = function(from) {
-    from[toJsonWasCalled] = true;
+    toJsonWasCalled.add(from);
     var json = from.toJSON();
-    delete from[toJsonWasCalled];
+    toJsonWasCalled.delete(from);
     return json;
 };
 var ref;
@@ -326,7 +326,7 @@ var destroyCircular = function(param) {
     if (depth >= maxDepth) {
         return to;
     }
-    if (useToJSON && typeof from.toJSON === "function" && from[toJsonWasCalled] !== true) {
+    if (useToJSON && typeof from.toJSON === "function" && !toJsonWasCalled.has(from)) {
         return toJSON(from);
     }
     var continueDestroyCircular = function(value) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@common.js/serialize-error",
-  "version": "11.0.0",
-  "description": "Serialize/deserialize an error into a plain object",
+  "version": "11.0.1",
+  "description": "serialize-error package exported as CommonJS modules",
   "license": "MIT",
   "repository": "etienne-martin/common.js",
   "funding": "https://github.com/sponsors/sindresorhus",
@@ -10,7 +10,8 @@
     "node": ">=14.16"
   },
   "scripts": {
-    "test": "xo && ava && tsd"
+    "//test": "xo && ava && tsd",
+    "test": "ava && tsd"
   },
   "files": [
     "index.js",

package/readme.md

@@ -1,198 +0,0 @@
-# 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
-
-```sh
-npm install serialize-error
-```
-
-## Usage
-
-```js
-import {serializeError, deserializeError} from '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: 🦄]
-```
-
-### Error constructors
-
-When a serialized error with a known `name` is encountered, it will be deserialized using the corresponding error constructor, while unknown error names will be deserialized as regular errors:
-
-```js
-import {deserializeError} from 'serialize-error';
-
-const known = deserializeError({
-	name: 'TypeError',
-	message: '🦄'
-});
-
-console.log(known);
-//=> [TypeError: 🦄] <-- Still a TypeError
-
-const unknown = deserializeError({
-	name: 'TooManyCooksError',
-	message: '🦄'
-});
-
-console.log(unknown);
-//=> [Error: 🦄] <-- Just a regular Error
-```
-
-The [list of known errors](./error-constructors.js) can be extended globally. This also works if `serialize-error` is a sub-dependency that's not used directly.
-
-```js
-import {errorConstructors} from 'serialize-error';
-import {MyCustomError} from './errors.js'
-
-errorConstructors.set('MyCustomError', MyCustomError)
-```
-
-**Warning:** Only simple and standard error constructors are supported, like `new MyCustomError(message)`. If your error constructor **requires** a second parameter or does not accept a string as first parameter, adding it to this map **will** break the deserialization.
-
-## API
-
-### serializeError(value, options?)
-
-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.
-
-### value
-
-Type: `Error | unknown`
-
-### toJSON implementation examples
-
-```js
-import {serializeError} from 'serialize-error';
-
-class ErrorWithDate extends Error {
-	constructor() {
-		super();
-		this.date = new Date();
-	}
-}
-
-const error = new ErrorWithDate();
-
-serializeError(error);
-// => {date: '1970-01-01T00:00:00.000Z', name, message, stack}
-```
-
-```js
-import {serializeError} from 'serialize-error';
-
-const error = new Error('Unicorn');
-
-error.horn = {
-	toJSON() {
-		return 'x';
-	}
-};
-
-serializeError(error);
-// => {horn: 'x', name, message, stack}
-```
-
-### deserializeError(value, options?)
-
-Deserialize a plain object or any value into an `Error` object.
-
-- `Error` objects are passed through.
-- Objects that have at least a `message` property are interpreted as errors.
-- All other values are wrapped in a `NonError` error.
-- Custom properties are preserved.
-- Non-enumerable properties are kept non-enumerable (name, message, stack, cause).
-- Enumerable properties are kept enumerable (all properties besides the non-enumerable ones).
-- Circular references are handled.
-- [Native error constructors](./error-constructors.js) are preserved (TypeError, DOMException, etc) and [more can be added.](#error-constructors)
-
-### value
-
-Type: `{message: string} | unknown`
-
-### options
-
-Type: `object`
-
-#### maxDepth
-
-Type: `number`\
-Default: `Number.POSITIVE_INFINITY`
-
-The maximum depth of properties to preserve when serializing/deserializing.
-
-```js
-import {serializeError} from 'serialize-error';
-
-const error = new Error('🦄');
-error.one = {two: {three: {}}};
-
-console.log(serializeError(error, {maxDepth: 1}));
-//=> {name: 'Error', message: '🦄', one: {}}
-
-console.log(serializeError(error, {maxDepth: 2}));
-//=> {name: 'Error', message: '🦄', one: { two: {}}}
-```
-
-#### useToJSON
-
-Type: `boolean`\
-Default: `true`
-
-Indicate whether to use a `.toJSON()` method if encountered in the object. This is useful when a custom error implements [its own serialization logic via `.toJSON()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#tojson_behavior) but you prefer to not use it.
-
-### isErrorLike(value)
-
-Predicate to determine whether a value looks like an error, even if it's not an instance of `Error`. It must have at least the `name`, `message`, and `stack` properties.
-
-```js
-import {isErrorLike} from 'serialize-error';
-
-const error = new Error('🦄');
-error.one = {two: {three: {}}};
-
-isErrorLike({
-	name: 'DOMException',
-	message: 'It happened',
-	stack: 'at foo (index.js:2:9)',
-});
-//=> true
-
-isErrorLike(new Error('🦄'));
-//=> true
-
-isErrorLike(serializeError(new Error('🦄'));
-//=> true
-
-isErrorLike({
-	name: 'Bluberricious pancakes',
-	stack: 12,
-	ingredients: 'Blueberry',
-});
-//=> false
-```