Fix .toJSON() example

Fixes #67
sindresorhus · Apr 3, 2022 · adc780d · adc780d
1 parent 7e8be51
commit adc780d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 22 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -74,21 +74,16 @@ console.log(serializeError(error));
 ```
 import {serializeError} from 'serialize-error';
 
-class ErrorWithToJSON extends Error {
-	constructor() {
-		super('🦄');
-		this.date = new Date();
-	}
+const error = new Error('Unicorn');
 
+error.horn = {
 	toJSON() {
-		return serializeError(this);
+		return 'x';
 	}
-}
-
-const error = new ErrorWithToJSON();
+};
 
-console.log(serializeError(error));
-// => {date: '1970-01-01T00:00:00.000Z', message: '🦄', name, stack}
+serializeError(error);
+// => {horn: 'x', name, message, stack}
 ```
 */
 export function serializeError<ErrorType>(error: ErrorType, options?: Options): ErrorType extends Primitive

diff --git a/readme.md b/readme.md
@@ -69,21 +69,16 @@ serializeError(error);
 ```js
 import {serializeError} from 'serialize-error';
 
-class ErrorWithToJSON extends Error {
-	constructor() {
-		super('🦄');
-		this.date = new Date();
-	}
+const error = new Error('Unicorn');
 
+error.horn = {
 	toJSON() {
-		return serializeError(this);
+		return 'x';
 	}
-}
-
-const error = new ErrorWithToJSON();
+};
 
-console.log(serializeError(error));
-// => {date: '1970-01-01T00:00:00.000Z', message: '🦄', name, stack}
+serializeError(error);
+// => {horn: 'x', name, message, stack}
 ```
 
 ### deserializeError(value, options?)