@alessiofrittoli/exception 1.2.0 → 2.1.0

package/README.md

@@ -1,6 +1,8 @@
 # Exception 🚦
 
-Version 1.2.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)
 
 ## Handle errors with ease
 
@@ -76,7 +78,7 @@ The constructor initializes an `Exception` instance with a custom message and op
 ###### Example
 
 ```ts
-import Exception from '@alessiofrittoli/exception'
+import { Exception } from '@alessiofrittoli/exception'
 
 try {
 	throw new Exception( 'Resource not found', {
@@ -178,7 +180,7 @@ To fill this gap, you can "extend" the `ErrorCode` enum by doing so:
 
 ```ts
 // myproject/src/error-code.ts
-import ExceptionCode from '@alessiofrittoli/exception/code'
+import { ExceptionCode } from '@alessiofrittoli/exception/code'
 
 /** Your project custom `ErrorCode`. */
 export enum MyProjectErrorCode
@@ -205,8 +207,8 @@ export default ErrorCode
 #### Using the default `ErrorCode` to throw a new `Exception`
 
 ```ts
-import Exception from '@alessiofrittoli/exception'
-import ErrorCode from '@alessiofrittoli/exception/code'
+import { Exception } from '@alessiofrittoli/exception'
+import { ErrorCode } from '@alessiofrittoli/exception/code'
 
 throw new Exception( 'Password is a required field to log you in.', {
 	code	: ErrorCode.EMPTY_VALUE,
@@ -217,8 +219,8 @@ throw new Exception( 'Password is a required field to log you in.', {
 #### Using custom `ErrorCode` to throw a new `Exception`
 
 ```ts
-import Exception from '@alessiofrittoli/exception'
-import ErrorCode from '@/error-code' // previously created in `myproject/src/error-code.ts`
+import { Exception } from '@alessiofrittoli/exception'
+import { ErrorCode } from '@/error-code' // previously created in `myproject/src/error-code.ts`
 
 throw new Exception( 'Invalid signature.', {
 	code	: ErrorCode.MyProjectErrorCode.INVALID_SIGN,
@@ -229,7 +231,7 @@ throw new Exception( 'Invalid signature.', {
 #### Using `ErrorCode` to handle errors
 
 ```ts
-import ErrorCode from '@/error-code' // previously created in `myproject/src/error-code.ts`
+import { ErrorCode } from '@/error-code' // previously created in `myproject/src/error-code.ts`
 
 try {
 	...

package/dist/code.d.mts

@@ -11,4 +11,4 @@ declare enum ErrorCode {
     TOO_EARLY = "ERR:TOOEARLY"
 }
 
-export { ErrorCode as default };
+export { ErrorCode };

package/dist/code.d.ts

@@ -11,4 +11,4 @@ declare enum ErrorCode {
     TOO_EARLY = "ERR:TOOEARLY"
 }
 
-export { ErrorCode as default };
+export { ErrorCode };

package/dist/code.js

@@ -1 +1 @@
-'use strict';var E=(R=>(R.UNKNOWN="ERR:UNKNOWN",R.ABORT="ERR:ABORT",R.EMPTY_VALUE="ERR:EMPTYVALUE",R.WRONG_VALUE="ERR:WRONGVALUE",R.EXPIRED="ERR:EXPIRED",R.TOO_EARLY="ERR:TOOEARLY",R))(E||{}),A=E;module.exports=A;
+'use strict';var E=(R=>(R.UNKNOWN="ERR:UNKNOWN",R.ABORT="ERR:ABORT",R.EMPTY_VALUE="ERR:EMPTYVALUE",R.WRONG_VALUE="ERR:WRONGVALUE",R.EXPIRED="ERR:EXPIRED",R.TOO_EARLY="ERR:TOOEARLY",R))(E||{});exports.ErrorCode=E;

package/dist/code.mjs

@@ -1 +1 @@
-var E=(R=>(R.UNKNOWN="ERR:UNKNOWN",R.ABORT="ERR:ABORT",R.EMPTY_VALUE="ERR:EMPTYVALUE",R.WRONG_VALUE="ERR:WRONGVALUE",R.EXPIRED="ERR:EXPIRED",R.TOO_EARLY="ERR:TOOEARLY",R))(E||{}),N=E;export{N as default};
+var E=(R=>(R.UNKNOWN="ERR:UNKNOWN",R.ABORT="ERR:ABORT",R.EMPTY_VALUE="ERR:EMPTYVALUE",R.WRONG_VALUE="ERR:WRONGVALUE",R.EXPIRED="ERR:EXPIRED",R.TOO_EARLY="ERR:TOOEARLY",R))(E||{});export{E as ErrorCode};

package/dist/index.d.mts

@@ -1,18 +1,60 @@
-import ErrorCode from './code.mjs';
+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 { type ExceptionOptions, Exception as default };
+export { Exception, type ExceptionOptions };

package/dist/index.d.ts

@@ -1,18 +1,60 @@
-import ErrorCode from './code.js';
+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 { type ExceptionOptions, Exception as default };
+export { Exception, type ExceptionOptions };

package/dist/index.js

@@ -1 +1 @@
-'use strict';var s=class o extends Error{message;status;name;typename;code;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"}},a=s;module.exports=a;
+'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{message;status;name;typename;code;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"}},r=s;export{r as default};
+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": "1.2.0",
+	"version": "2.1.0",
 	"description": "Handle errors with ease",
 	"author": {
 		"name": "Alessio Frittoli",
@@ -41,26 +41,33 @@
 	"sideEffects": false,
 	"scripts": {
 		"build": "pnpm lint && pnpm test:ci && tsup",
+		"build:watch": "tsup --watch",
 		"lint": "eslint",
-		"test": "jest --watchAll --verbose",
-		"test:jsdom": "JSDOM=true pnpm test",
+		"release": "node scripts/publish.js --verbose --npm",
+		"test": "pnpm test:watch",
+		"test:watch": "jest --watchAll --verbose",
+		"test:jsdom": "JSDOM=true pnpm test:watch",
 		"test:ci": "jest --ci --verbose",
 		"test:ci:jsdom": "JSDOM=true pnpm test:ci",
+		"test:coverage": "pnpm test:watch --coverage",
+		"test:ci:coverage": "pnpm test:ci --coverage",
 		"test:serve-coverage": "http-server ./coverage/lcov-report --gzip true -p 0 -o --silent",
-		"test:coverage": "concurrently --prefix none --kill-others \"pnpm jest --watchAll --verbose --coverage\" \"pnpm test:serve-coverage\"",
+		"test:coverage:serve": "concurrently --prefix none --kill-others \"pnpm test:coverage\" \"pnpm test:serve-coverage\"",
 		"test:coverage:jsdom": "JSDOM=true pnpm test:coverage",
-		"test:jest": "pnpm test jest.test.ts",
+		"test:coverage:jsdom:serve": "JSDOM=true pnpm test:coverage:serve",
+		"test:jest": "pnpm test:watch jest.test.ts",
 		"test:jest:jsdom": "JSDOM=true pnpm test:jest",
 		"test:exception": "pnpm test exception.test.ts"
 	},
 	"devDependencies": {
+		"@alessiofrittoli/node-scripts": "^2.2.1",
 		"@eslint/js": "^9.17.0",
 		"@jest/globals": "^29.7.0",
 		"@types/jest": "^29.5.14",
 		"@types/node": "^22.10.2",
-		"concurrently": "^9.1.0",
+		"concurrently": "^9.1.2",
 		"dotenv": "^16.4.7",
-		"esbuild": "0.24.0",
+		"esbuild": "0.24.2",
 		"eslint": "^9.17.0",
 		"globals": "^15.14.0",
 		"http-server": "^14.1.1",
@@ -70,6 +77,6 @@
 		"ts-node": "^10.9.2",
 		"tsup": "^8.3.5",
 		"typescript": "^5.7.2",
-		"typescript-eslint": "^8.18.1"
+		"typescript-eslint": "^8.19.0"
 	}
 }