feat: add Exception.toJSON() method (#13)

__tests__/exception.test.ts

@@ -1,3 +1,4 @@
+import { ErrorCode } from '@/code'
 import { Exception } from '@/index'
 
 describe( 'Exception', () => {
@@ -61,4 +62,31 @@ describe( 'Exception.isException()', () => {
 			.toBe( true )
 	} )
 
+} )
+
+
+describe( 'Exception.toJSON()', () => {
+
+	it( 'returns a JSON representation of the Exception Class', () => {
+		const exception = (
+			new Exception(
+				'Error message', {
+					code	: ErrorCode.ABORT,
+					status	: 400,
+					name	: 'AbortError',
+					cause	: 'User aborted the request.',
+				}
+			)
+		)
+
+		const parsedException = JSON.parse( JSON.stringify( exception ) ) as Exception
+
+		expect( Exception.isException( parsedException ) ).toBe( true )
+		expect( parsedException.message ).toBe( exception.message )
+		expect( parsedException.code ).toBe( exception.code )
+		expect( parsedException.name ).toBe( exception.name )
+		expect( parsedException.cause ).toBe( exception.cause )		
+
+	} )
+
 } )

src/index.ts

@@ -1,4 +1,4 @@
-import type { ErrorCode } from './code'
+import { ErrorCode } from './code'
 
 /**
  * Interface representing the options for an Exception.
@@ -72,4 +72,19 @@ export class Exception<TMessage = string, TCode = ErrorCode> extends Error imple
 			( typeof error === 'object' && 'typename' in error && error.typename === 'Exception' )
 		)
 	}
+
+
+	/**
+	 * Converts the instance to a JSON object.
+	 *
+	 * @returns A JSON representation of the instance, including the message property.
+	 */
+	toJSON()
+	{
+		return {
+			...this,
+			message: this.message,
+			cause: this.cause,
+		}
+	}
 }