error-message-utils 1.2.3 → 1.2.5

package/README.md

@@ -147,6 +147,12 @@ exception instanceof Exception; // true
 exception.message; // "Request failed"
 exception.code; // "SOME_ERROR_CODE"
 exception.toString(); // "Request failed{(SOME_ERROR_CODE)}"
+exception.toRecord();
+// {
+//   message: "Request failed",
+//   code: "SOME_ERROR_CODE",
+//   data: null,
+// }
 ```
 
 
@@ -169,6 +175,16 @@ type IDecodedError = {
   message: string,
   code: IErrorCode,
 };
+
+/**
+ * Exception Record
+ * The record type for the Exception class.
+*/
+type IExceptionRecord = {
+  message: string;
+  code: IErrorCode;
+  data: unknown | null;
+};
 ```
 
 

package/dist/exception/exception.d.ts

@@ -0,0 +1,23 @@
+import { type IErrorCode } from '../shared/types.js';
+import { IExceptionRecord } from './types.js';
+export declare class Exception extends Error {
+    readonly code: IErrorCode;
+    readonly data: unknown;
+    constructor(error: unknown, code?: IErrorCode, data?: unknown);
+    /**
+     * Override the default toString method to return a formatted error message with the code.
+     * @returns A string representation of the error with the code.
+     */
+    toString(): string;
+    /**
+     * Override the default behavior for type conversion to return a formatted error message with the code.
+     * @param hint The type hint for the conversion.
+     * @returns A string representation of the error with the code or null for other types.
+     */
+    [Symbol.toPrimitive](hint: string): string | null;
+    /**
+     * Convert the exception to a record format.
+     * @returns An object representing the exception with message, code, and data.
+     */
+    toRecord(): IExceptionRecord;
+}

package/dist/exception/exception.js

@@ -0,0 +1 @@
+import{decodeError,encodeError}from"../error-handler/index.js";export class Exception extends Error{code;data;constructor(e,r,t){const o=decodeError(e);super(o.message),this.name="Exception",this.code=r??o.code,this.data=t}toString(){return encodeError(this.message,this.code)}[Symbol.toPrimitive](e){return"string"===e||"default"===e?this.toString():null}toRecord(){return{message:this.message,code:this.code,data:this.data??null}}}

package/dist/exception/index.d.ts

@@ -1,16 +1,2 @@
-import { type IErrorCode } from '../shared/types.js';
-export declare class Exception extends Error {
-    readonly code: IErrorCode;
-    constructor(error: unknown, code: IErrorCode);
-    /**
-     * Override the default toString method to return a formatted error message with the code.
-     * @returns A string representation of the error with the code.
-     */
-    toString(): string;
-    /**
-     * Override the default behavior for type conversion to return a formatted error message with the code.
-     * @param hint The type hint for the conversion.
-     * @returns A string representation of the error with the code or null for other types.
-     */
-    [Symbol.toPrimitive](hint: string): string | null;
-}
+export type { IExceptionRecord } from './types.js';
+export { Exception } from './exception.js';

package/dist/exception/index.js

@@ -1 +1 @@
-import{encodeError,extractMessage}from"../error-handler/index.js";export class Exception extends Error{code;constructor(e,r){super(extractMessage(e)),this.name="Exception",this.code=r}toString(){return encodeError(this.message,this.code)}[Symbol.toPrimitive](e){return"string"===e||"default"===e?this.toString():null}}
+export{Exception}from"./exception.js";

package/dist/exception/types.d.ts

@@ -0,0 +1,6 @@
+import { IErrorCode } from '../shared/types.js';
+export type IExceptionRecord = {
+    message: string;
+    code: IErrorCode;
+    data: unknown | null;
+};

package/dist/exception/types.js

@@ -0,0 +1 @@
+export{};

package/dist/index.d.ts

@@ -1,8 +1,4 @@
-import { IErrorCode, IDecodedError } from './shared/types.js';
-import { DEFAULT_CODE, DEFAULT_MESSAGE } from './shared/constants.js';
-import { decodeError, encodeError, extractMessage, isDefaultErrorMessage, isEncodedError } from './error-handler/index.js';
-import { Exception } from './exception/index.js';
-/**
- * Module exports
- */
-export { type IErrorCode, type IDecodedError, DEFAULT_MESSAGE, DEFAULT_CODE, extractMessage, encodeError, decodeError, isEncodedError, isDefaultErrorMessage, Exception, };
+export { IErrorCode, IDecodedError } from './shared/types.js';
+export { DEFAULT_CODE, DEFAULT_MESSAGE } from './shared/constants.js';
+export { decodeError, encodeError, extractMessage, isDefaultErrorMessage, isEncodedError, } from './error-handler/index.js';
+export { Exception } from './exception/exception.js';

package/dist/index.js

@@ -1 +1 @@
-import{DEFAULT_CODE,DEFAULT_MESSAGE}from"./shared/constants.js";import{decodeError,encodeError,extractMessage,isDefaultErrorMessage,isEncodedError}from"./error-handler/index.js";import{Exception}from"./exception/index.js";export{DEFAULT_MESSAGE,DEFAULT_CODE,extractMessage,encodeError,decodeError,isEncodedError,isDefaultErrorMessage,Exception};
+export{DEFAULT_CODE,DEFAULT_MESSAGE}from"./shared/constants.js";export{decodeError,encodeError,extractMessage,isDefaultErrorMessage,isEncodedError}from"./error-handler/index.js";export{Exception}from"./exception/exception.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "error-message-utils",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "The error-message-utils package simplifies error management in your web applications and RESTful APIs. It ensures consistent and scalable handling of error messages, saving you time and effort. Moreover, it gives you the ability to assign custom error codes so all possible cases can be handled accordingly.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",