@common.js/serialize-error 11.0.0

package/README.md

@@ -0,0 +1,5 @@
+# @common.js/serialize-error
+
+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.

package/error-constructors.d.ts

@@ -0,0 +1,8 @@
+/**
+Map of error constructors to recreate from the serialize `name` property. If the name is not found in this map, the errors will be deserialized as simple `Error` instances.
+
+Warning: Only simple and standard error constructors are supported, like `new MyCustomError(name)`. 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.
+*/
+declare const errorConstructors: Map<string, ErrorConstructor>;
+
+export default errorConstructors;

package/error-constructors.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+var list = [
+    // Native ES errors https://262.ecma-international.org/12.0/#sec-well-known-intrinsic-objects
+    EvalError,
+    RangeError,
+    ReferenceError,
+    SyntaxError,
+    TypeError,
+    URIError,
+    // Built-in errors
+    globalThis.DOMException,
+    // Node-specific errors
+    // https://nodejs.org/api/errors.html
+    globalThis.AssertionError,
+    globalThis.SystemError, 
+]// Non-native Errors are used with `globalThis` because they might be missing. This filter drops them when undefined.
+.filter(Boolean).map(function(constructor) {
+    return [
+        constructor.name,
+        constructor
+    ];
+});
+var errorConstructors = new Map(list);
+var _default = errorConstructors;

package/index.d.ts

@@ -0,0 +1,171 @@
+import {Primitive, JsonObject} from 'type-fest';
+
+export {default as errorConstructors} from './error-constructors.js';
+
+export type ErrorObject = {
+	name?: string;
+	message?: string;
+	stack?: string;
+	cause?: unknown;
+	code?: string;
+} & JsonObject;
+
+export type ErrorLike = {
+	[key: string]: unknown;
+	name: string;
+	message: string;
+	stack: string;
+	cause?: unknown;
+	code?: string;
+};
+
+export interface Options {
+	/**
+	The maximum depth of properties to preserve when serializing/deserializing.
+
+	@default Number.POSITIVE_INFINITY
+
+	@example
+	```
+	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: {}}}
+	```
+	*/
+	readonly maxDepth?: number;
+
+	/**
+	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()` but you prefer to not use it.
+
+	@default true
+	*/
+	readonly useToJSON?: boolean;
+}
+
+/**
+Serialize an `Error` object into a plain object.
+
+- Non-error values are passed through.
+- Custom properties are preserved.
+- 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.
+
+@example
+```
+import {serializeError} from 'serialize-error';
+
+const error = new Error('🦄');
+
+console.log(error);
+//=> [Error: 🦄]
+
+console.log(serializeError(error));
+//=> {name: 'Error', message: '🦄', stack: 'Error: 🦄\n    at Object.<anonymous> …'}
+```
+
+@example
+```
+import {serializeError} from 'serialize-error';
+
+class ErrorWithDate extends Error {
+	constructor() {
+		super();
+		this.date = new Date();
+	}
+}
+
+const error = new ErrorWithDate();
+
+console.log(serializeError(error));
+//=> {date: '1970-01-01T00:00:00.000Z', name, message, stack}
+```
+
+@example
+```
+import {serializeError} from 'serialize-error';
+
+const error = new Error('Unicorn');
+
+error.horn = {
+	toJSON() {
+		return 'x';
+	}
+};
+
+serializeError(error);
+// => {horn: 'x', name, message, stack}
+```
+*/
+export function serializeError<ErrorType>(error: ErrorType, options?: Options): ErrorType extends Primitive
+	? ErrorType
+	: ErrorObject;
+
+/**
+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 are preserved (TypeError, DOMException, etc) and more can be added.
+
+@example
+```
+import {deserializeError} from 'serialize-error';
+
+const error = deserializeError({
+	message: 'aaa',
+	stack: 'at <anonymous>:1:13'
+});
+
+console.log(error);
+// Error: aaa
+// at <anonymous>:1:13
+```
+*/
+export function deserializeError(errorObject: ErrorObject | unknown, options?: Options): Error;
+
+/**
+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.
+
+@example
+```
+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
+```
+*/
+export function isErrorLike(value: unknown): value is ErrorLike;

package/index.js

@@ -0,0 +1,460 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    NonError: function() {
+        return NonError;
+    },
+    serializeError: function() {
+        return serializeError;
+    },
+    deserializeError: function() {
+        return deserializeError;
+    },
+    isErrorLike: function() {
+        return isErrorLike;
+    },
+    errorConstructors: function() {
+        return _errorConstructorsJs.default;
+    }
+});
+var _errorConstructorsJs = /*#__PURE__*/ _interopRequireDefault(require("./error-constructors.js"));
+function _arrayLikeToArray(arr, len) {
+    if (len == null || len > arr.length) len = arr.length;
+    for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
+    return arr2;
+}
+function _arrayWithHoles(arr) {
+    if (Array.isArray(arr)) return arr;
+}
+function _arrayWithoutHoles(arr) {
+    if (Array.isArray(arr)) return _arrayLikeToArray(arr);
+}
+function _assertThisInitialized(self) {
+    if (self === void 0) {
+        throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
+    }
+    return self;
+}
+function _classCallCheck(instance, Constructor) {
+    if (!(instance instanceof Constructor)) {
+        throw new TypeError("Cannot call a class as a function");
+    }
+}
+function isNativeReflectConstruct() {
+    if (typeof Reflect === "undefined" || !Reflect.construct) return false;
+    if (Reflect.construct.sham) return false;
+    if (typeof Proxy === "function") return true;
+    try {
+        Date.prototype.toString.call(Reflect.construct(Date, [], function() {}));
+        return true;
+    } catch (e) {
+        return false;
+    }
+}
+function _construct(Parent, args, Class) {
+    if (isNativeReflectConstruct()) {
+        _construct = Reflect.construct;
+    } else {
+        _construct = function _construct(Parent, args, Class) {
+            var a = [
+                null
+            ];
+            a.push.apply(a, args);
+            var Constructor = Function.bind.apply(Parent, a);
+            var instance = new Constructor();
+            if (Class) _setPrototypeOf(instance, Class.prototype);
+            return instance;
+        };
+    }
+    return _construct.apply(null, arguments);
+}
+function _defineProperties(target, props) {
+    for(var i = 0; i < props.length; i++){
+        var descriptor = props[i];
+        descriptor.enumerable = descriptor.enumerable || false;
+        descriptor.configurable = true;
+        if ("value" in descriptor) descriptor.writable = true;
+        Object.defineProperty(target, descriptor.key, descriptor);
+    }
+}
+function _createClass(Constructor, protoProps, staticProps) {
+    if (protoProps) _defineProperties(Constructor.prototype, protoProps);
+    if (staticProps) _defineProperties(Constructor, staticProps);
+    return Constructor;
+}
+function _defineProperty(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _getPrototypeOf(o) {
+    _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) {
+        return o.__proto__ || Object.getPrototypeOf(o);
+    };
+    return _getPrototypeOf(o);
+}
+function _inherits(subClass, superClass) {
+    if (typeof superClass !== "function" && superClass !== null) {
+        throw new TypeError("Super expression must either be null or a function");
+    }
+    subClass.prototype = Object.create(superClass && superClass.prototype, {
+        constructor: {
+            value: subClass,
+            writable: true,
+            configurable: true
+        }
+    });
+    if (superClass) _setPrototypeOf(subClass, superClass);
+}
+function _instanceof(left, right) {
+    if (right != null && typeof Symbol !== "undefined" && right[Symbol.hasInstance]) {
+        return !!right[Symbol.hasInstance](left);
+    } else {
+        return left instanceof right;
+    }
+}
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function _isNativeFunction(fn) {
+    return Function.toString.call(fn).indexOf("[native code]") !== -1;
+}
+function _iterableToArray(iter) {
+    if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
+}
+function _iterableToArrayLimit(arr, i) {
+    var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
+    if (_i == null) return;
+    var _arr = [];
+    var _n = true;
+    var _d = false;
+    var _s, _e;
+    try {
+        for(_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true){
+            _arr.push(_s.value);
+            if (i && _arr.length === i) break;
+        }
+    } catch (err) {
+        _d = true;
+        _e = err;
+    } finally{
+        try {
+            if (!_n && _i["return"] != null) _i["return"]();
+        } finally{
+            if (_d) throw _e;
+        }
+    }
+    return _arr;
+}
+function _nonIterableRest() {
+    throw new TypeError("Invalid attempt to destructure non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+function _nonIterableSpread() {
+    throw new TypeError("Invalid attempt to spread non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+function _possibleConstructorReturn(self, call) {
+    if (call && (_typeof(call) === "object" || typeof call === "function")) {
+        return call;
+    }
+    return _assertThisInitialized(self);
+}
+function _setPrototypeOf(o, p) {
+    _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) {
+        o.__proto__ = p;
+        return o;
+    };
+    return _setPrototypeOf(o, p);
+}
+function _slicedToArray(arr, i) {
+    return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
+}
+function _toConsumableArray(arr) {
+    return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread();
+}
+var _typeof = function(obj) {
+    "@swc/helpers - typeof";
+    return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj;
+};
+function _unsupportedIterableToArray(o, minLen) {
+    if (!o) return;
+    if (typeof o === "string") return _arrayLikeToArray(o, minLen);
+    var n = Object.prototype.toString.call(o).slice(8, -1);
+    if (n === "Object" && o.constructor) n = o.constructor.name;
+    if (n === "Map" || n === "Set") return Array.from(n);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
+}
+function _wrapNativeSuper(Class) {
+    var _cache = typeof Map === "function" ? new Map() : undefined;
+    _wrapNativeSuper = function _wrapNativeSuper(Class) {
+        if (Class === null || !_isNativeFunction(Class)) return Class;
+        if (typeof Class !== "function") {
+            throw new TypeError("Super expression must either be null or a function");
+        }
+        if (typeof _cache !== "undefined") {
+            if (_cache.has(Class)) return _cache.get(Class);
+            _cache.set(Class, Wrapper);
+        }
+        function Wrapper() {
+            return _construct(Class, arguments, _getPrototypeOf(this).constructor);
+        }
+        Wrapper.prototype = Object.create(Class.prototype, {
+            constructor: {
+                value: Wrapper,
+                enumerable: false,
+                writable: true,
+                configurable: true
+            }
+        });
+        return _setPrototypeOf(Wrapper, Class);
+    };
+    return _wrapNativeSuper(Class);
+}
+function _isNativeReflectConstruct() {
+    if (typeof Reflect === "undefined" || !Reflect.construct) return false;
+    if (Reflect.construct.sham) return false;
+    if (typeof Proxy === "function") return true;
+    try {
+        Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function() {}));
+        return true;
+    } catch (e) {
+        return false;
+    }
+}
+function _createSuper(Derived) {
+    var hasNativeReflectConstruct = _isNativeReflectConstruct();
+    return function _createSuperInternal() {
+        var Super = _getPrototypeOf(Derived), result;
+        if (hasNativeReflectConstruct) {
+            var NewTarget = _getPrototypeOf(this).constructor;
+            result = Reflect.construct(Super, arguments, NewTarget);
+        } else {
+            result = Super.apply(this, arguments);
+        }
+        return _possibleConstructorReturn(this, result);
+    };
+}
+var NonError = /*#__PURE__*/ function(Error1) {
+    "use strict";
+    _inherits(NonError, Error1);
+    var _super = _createSuper(NonError);
+    function NonError(message) {
+        _classCallCheck(this, NonError);
+        var _this;
+        _this = _super.call(this, NonError._prepareSuperMessage(message));
+        _defineProperty(_assertThisInitialized(_this), "name", "NonError");
+        return _this;
+    }
+    _createClass(NonError, null, [
+        {
+            key: "_prepareSuperMessage",
+            value: function _prepareSuperMessage(message) {
+                try {
+                    return JSON.stringify(message);
+                } catch (e) {
+                    return String(message);
+                }
+            }
+        }
+    ]);
+    return NonError;
+}(_wrapNativeSuper(Error));
+var commonProperties = [
+    {
+        property: "name",
+        enumerable: false
+    },
+    {
+        property: "message",
+        enumerable: false
+    },
+    {
+        property: "stack",
+        enumerable: false
+    },
+    {
+        property: "code",
+        enumerable: true
+    },
+    {
+        property: "cause",
+        enumerable: false
+    }, 
+];
+var toJsonWasCalled = Symbol(".toJSON was called");
+var toJSON = function(from) {
+    from[toJsonWasCalled] = true;
+    var json = from.toJSON();
+    delete from[toJsonWasCalled];
+    return json;
+};
+var ref;
+var getErrorConstructor = function(name) {
+    return (ref = _errorConstructorsJs.default.get(name)) !== null && ref !== void 0 ? ref : Error;
+};
+// eslint-disable-next-line complexity
+var destroyCircular = function(param) {
+    var from = param.from, seen = param.seen, to = param.to, forceEnumerable = param.forceEnumerable, maxDepth = param.maxDepth, depth = param.depth, useToJSON = param.useToJSON, serialize = param.serialize;
+    if (!to) {
+        if (Array.isArray(from)) {
+            to = [];
+        } else if (!serialize && isErrorLike(from)) {
+            var _$Error = getErrorConstructor(from.name);
+            to = new _$Error();
+        } else {
+            to = {};
+        }
+    }
+    seen.push(from);
+    if (depth >= maxDepth) {
+        return to;
+    }
+    if (useToJSON && typeof from.toJSON === "function" && from[toJsonWasCalled] !== true) {
+        return toJSON(from);
+    }
+    var continueDestroyCircular = function(value) {
+        return destroyCircular({
+            from: value,
+            seen: _toConsumableArray(seen),
+            forceEnumerable: forceEnumerable,
+            maxDepth: maxDepth,
+            depth: depth,
+            useToJSON: useToJSON,
+            serialize: serialize
+        });
+    };
+    var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+    try {
+        for(var _iterator = Object.entries(from)[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+            var _value = _slicedToArray(_step.value, 2), key = _value[0], value = _value[1];
+            // eslint-disable-next-line node/prefer-global/buffer
+            if (typeof Buffer === "function" && Buffer.isBuffer(value)) {
+                to[key] = "[object Buffer]";
+                continue;
+            }
+            // TODO: Use `stream.isReadable()` when targeting Node.js 18.
+            if (value !== null && typeof value === "object" && typeof value.pipe === "function") {
+                to[key] = "[object Stream]";
+                continue;
+            }
+            if (typeof value === "function") {
+                continue;
+            }
+            if (!value || typeof value !== "object") {
+                to[key] = value;
+                continue;
+            }
+            if (!seen.includes(from[key])) {
+                depth++;
+                to[key] = continueDestroyCircular(from[key]);
+                continue;
+            }
+            to[key] = "[Circular]";
+        }
+    } catch (err) {
+        _didIteratorError = true;
+        _iteratorError = err;
+    } finally{
+        try {
+            if (!_iteratorNormalCompletion && _iterator.return != null) {
+                _iterator.return();
+            }
+        } finally{
+            if (_didIteratorError) {
+                throw _iteratorError;
+            }
+        }
+    }
+    var _iteratorNormalCompletion1 = true, _didIteratorError1 = false, _iteratorError1 = undefined;
+    try {
+        for(var _iterator1 = commonProperties[Symbol.iterator](), _step1; !(_iteratorNormalCompletion1 = (_step1 = _iterator1.next()).done); _iteratorNormalCompletion1 = true){
+            var _value1 = _step1.value, property = _value1.property, enumerable = _value1.enumerable;
+            if (typeof from[property] !== "undefined" && from[property] !== null) {
+                Object.defineProperty(to, property, {
+                    value: isErrorLike(from[property]) ? continueDestroyCircular(from[property]) : from[property],
+                    enumerable: forceEnumerable ? true : enumerable,
+                    configurable: true,
+                    writable: true
+                });
+            }
+        }
+    } catch (err) {
+        _didIteratorError1 = true;
+        _iteratorError1 = err;
+    } finally{
+        try {
+            if (!_iteratorNormalCompletion1 && _iterator1.return != null) {
+                _iterator1.return();
+            }
+        } finally{
+            if (_didIteratorError1) {
+                throw _iteratorError1;
+            }
+        }
+    }
+    return to;
+};
+function serializeError(value) {
+    var options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
+    var _maxDepth = options.maxDepth, maxDepth = _maxDepth === void 0 ? Number.POSITIVE_INFINITY : _maxDepth, _useToJSON = options.useToJSON, useToJSON = _useToJSON === void 0 ? true : _useToJSON;
+    if (typeof value === "object" && value !== null) {
+        return destroyCircular({
+            from: value,
+            seen: [],
+            forceEnumerable: true,
+            maxDepth: maxDepth,
+            depth: 0,
+            useToJSON: useToJSON,
+            serialize: true
+        });
+    }
+    // People sometimes throw things besides Error objects…
+    if (typeof value === "function") {
+        var _name;
+        // `JSON.stringify()` discards functions. We do too, unless a function is thrown directly.
+        return "[Function: ".concat((_name = value.name) !== null && _name !== void 0 ? _name : "anonymous", "]");
+    }
+    return value;
+}
+function deserializeError(value) {
+    var options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
+    var _maxDepth = options.maxDepth, maxDepth = _maxDepth === void 0 ? Number.POSITIVE_INFINITY : _maxDepth;
+    if (_instanceof(value, Error)) {
+        return value;
+    }
+    if (isMinimumViableSerializedError(value)) {
+        var _$Error = getErrorConstructor(value.name);
+        return destroyCircular({
+            from: value,
+            seen: [],
+            to: new _$Error(),
+            maxDepth: maxDepth,
+            depth: 0,
+            serialize: false
+        });
+    }
+    return new NonError(value);
+}
+function isErrorLike(value) {
+    return Boolean(value) && typeof value === "object" && "name" in value && "message" in value && "stack" in value;
+}
+function isMinimumViableSerializedError(value) {
+    return Boolean(value) && typeof value === "object" && "message" in value && !Array.isArray(value);
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@common.js/serialize-error",
+  "version": "11.0.0",
+  "description": "Serialize/deserialize an error into a plain object",
+  "license": "MIT",
+  "repository": "etienne-martin/common.js",
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=14.16"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "error-constructors.js",
+    "error-constructors.d.ts"
+  ],
+  "dependencies": {
+    "type-fest": "^2.12.2"
+  },
+  "devDependencies": {
+    "ava": "^4.2.0",
+    "tsd": "^0.20.0",
+    "xo": "^0.48.0"
+  },
+  "homepage": "https://github.com/etienne-martin/common.js#readme",
+  "main": "./index.js"
+}

package/readme.md

@@ -0,0 +1,198 @@
+# 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
+```