@alessiofrittoli/exception 2.0.0 → 2.1.0

package/README.md

@@ -1,6 +1,6 @@
 # Exception 🚦
 
-Version 2.0.0
+Version 2.1.0
 
 [![Coverage Status](https://coveralls.io/repos/github/alessiofrittoli/exception/badge.svg)](https://coveralls.io/github/alessiofrittoli/exception) [![Dependencies](https://img.shields.io/librariesio/release/npm/%40alessiofrittoli%2Fexception)](https://libraries.io/npm/%40alessiofrittoli%2Fexception)
 

package/dist/index.d.mts

@@ -1,18 +1,60 @@
 import { ErrorCode } from './code.mjs';
 
+/**
+ * Interface representing the options for an Exception.
+ *
+ * @template TCode - The type of the error code.
+ * @extends ErrorOptions
+ */
 interface ExceptionOptions<TCode = ErrorCode> extends ErrorOptions {
+    /** The error code associated with the Exception. */
     code: TCode;
+    /**  The name of the Exception. */
     name?: string;
+    /** The HTTP status code associated with the Exception. */
     status?: number;
 }
+/**
+ * Exception Class.
+ *
+ * @template TMessage	The type of the message property of the Exception. Defaults to `string`.
+ * @template TCode		The type of the code property of the Exception. Defaults to `ErrorCode`.
+ *
+ * @extends {Error}
+ * @implements {ExceptionOptions<TCode>}
+ */
 declare class Exception<TMessage = string, TCode = ErrorCode> extends Error implements ExceptionOptions<TCode> {
     message: TMessage;
     status: number | undefined;
     name: string;
     typename: 'Exception';
     code: TCode;
+    /**
+     * Constructs a new Exception instance.
+     *
+     * @param message The message describing the exception.
+     * @param options Additional options for the exception.
+     */
     constructor(message: TMessage, options: ExceptionOptions<TCode>);
+    /**
+     * Determines if the provided error is an instance of the Exception class.
+     *
+     * @template TMessage	The type of the message property of the Exception.
+     * @template TCode		The type of the code property of the Exception.
+     *
+     * @param	error The error to check.
+     * @returns	`true` if the error is an instance of Exception or has a `typename` property equal to 'Exception', `false` otherwise.
+     */
     static isException<TMessage = string, TCode = ErrorCode>(error: any): error is Exception<TMessage, TCode>;
+    /**
+     * Converts the instance to a JSON object.
+     *
+     * @returns A JSON representation of the instance, including the message property.
+     */
+    toJSON(): this & {
+        message: TMessage;
+        cause: unknown;
+    };
 }
 
 export { Exception, type ExceptionOptions };

package/dist/index.d.ts

@@ -1,18 +1,60 @@
 import { ErrorCode } from './code.js';
 
+/**
+ * Interface representing the options for an Exception.
+ *
+ * @template TCode - The type of the error code.
+ * @extends ErrorOptions
+ */
 interface ExceptionOptions<TCode = ErrorCode> extends ErrorOptions {
+    /** The error code associated with the Exception. */
     code: TCode;
+    /**  The name of the Exception. */
     name?: string;
+    /** The HTTP status code associated with the Exception. */
     status?: number;
 }
+/**
+ * Exception Class.
+ *
+ * @template TMessage	The type of the message property of the Exception. Defaults to `string`.
+ * @template TCode		The type of the code property of the Exception. Defaults to `ErrorCode`.
+ *
+ * @extends {Error}
+ * @implements {ExceptionOptions<TCode>}
+ */
 declare class Exception<TMessage = string, TCode = ErrorCode> extends Error implements ExceptionOptions<TCode> {
     message: TMessage;
     status: number | undefined;
     name: string;
     typename: 'Exception';
     code: TCode;
+    /**
+     * Constructs a new Exception instance.
+     *
+     * @param message The message describing the exception.
+     * @param options Additional options for the exception.
+     */
     constructor(message: TMessage, options: ExceptionOptions<TCode>);
+    /**
+     * Determines if the provided error is an instance of the Exception class.
+     *
+     * @template TMessage	The type of the message property of the Exception.
+     * @template TCode		The type of the code property of the Exception.
+     *
+     * @param	error The error to check.
+     * @returns	`true` if the error is an instance of Exception or has a `typename` property equal to 'Exception', `false` otherwise.
+     */
     static isException<TMessage = string, TCode = ErrorCode>(error: any): error is Exception<TMessage, TCode>;
+    /**
+     * Converts the instance to a JSON object.
+     *
+     * @returns A JSON representation of the instance, including the message property.
+     */
+    toJSON(): this & {
+        message: TMessage;
+        cause: unknown;
+    };
 }
 
 export { Exception, type ExceptionOptions };

package/dist/index.js

@@ -1 +1 @@
-'use strict';var s=class o extends Error{constructor(e,t){super("",t),this.typename="Exception",this.name=t.name||this.typename,this.message=e,this.code=t.code,this.status=t.status;}static isException(e){return e instanceof o||typeof e=="object"&&"typename"in e&&e.typename==="Exception"}};exports.Exception=s;
+'use strict';var t=class o extends Error{constructor(e,s){super("",s),this.typename="Exception",this.name=s.name||this.typename,this.message=e,this.code=s.code,this.status=s.status;}static isException(e){return e instanceof o||typeof e=="object"&&"typename"in e&&e.typename==="Exception"}toJSON(){return {...this,message:this.message,cause:this.cause}}};exports.Exception=t;

package/dist/index.mjs

@@ -1 +1 @@
-var s=class o extends Error{constructor(e,t){super("",t),this.typename="Exception",this.name=t.name||this.typename,this.message=e,this.code=t.code,this.status=t.status;}static isException(e){return e instanceof o||typeof e=="object"&&"typename"in e&&e.typename==="Exception"}};export{s as Exception};
+var t=class o extends Error{constructor(e,s){super("",s),this.typename="Exception",this.name=s.name||this.typename,this.message=e,this.code=s.code,this.status=s.status;}static isException(e){return e instanceof o||typeof e=="object"&&"typename"in e&&e.typename==="Exception"}toJSON(){return {...this,message:this.message,cause:this.cause}}};export{t as Exception};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@alessiofrittoli/exception",
-	"version": "2.0.0",
+	"version": "2.1.0",
 	"description": "Handle errors with ease",
 	"author": {
 		"name": "Alessio Frittoli",