error-message-utils 1.1.1 → 1.1.3

package/README.md

@@ -12,16 +12,10 @@ The `error-message-utils` package simplifies error management in your web applic
 
 Install the package:
 ```bash
-$ npm install -S error-message-utils
+npm install -S error-message-utils
 ```
 
-
-
-
-
-</br>
-
-## Usage
+### Examples
 
 Encoding an error:
 
@@ -102,40 +96,65 @@ isEncodedError(encodeError(new Error('Some unknown error.'), 'NASTY_ERROR'));
 
 <br/>
 
-## Built With
+In some cases, you may want to check whether the extracted error matches the default message provided by this package:
 
-- TypeScript
+```typescript
+import { isDefaultErrorMessage} from 'error-message-utils';
 
+const DEFAULT_MESSAGE: string = 'The error message could not be extracted, check the logs for more information.';
 
+isDefaultErrorMessage(DEFAULT_MESSAGE);
+// true
 
+isDefaultErrorMessage(`${DEFAULT_MESSAGE} and something else...`);
+// false
 
-<br/>
+isDefaultErrorMessage(`${DEFAULT_MESSAGE} and something else...`, true);
+// true
+```
 
-## Running the Tests
 
-```bash
-$ npm run test:unit
-```
 
 
+<br/>
 
+## Types
 
+```typescript
+/**
+ * Error Code
+ * The code that is inserted when encoding an error. If none is provided or none can be extracted, it defaults to -1.
+ */
+type IErrorCode = string | number;
+
+/**
+ * Decoded Error
+ * The object obtained when an error is decoded. Keep in mind that if the error message or the code cannot be extracted for any reason, the default values will be set instead.
+ */
+type IDecodedError = {
+  message: string,
+  code: IErrorCode,
+};
+```
 
-<br/>
 
-## License
 
-[MIT](https://choosealicense.com/licenses/mit/)
+<br/>
 
+## Built With
+
+- TypeScript
 
 
 
 
 <br/>
 
-## Acknowledgments
+## Running the Tests
 
-- ...
+```bash
+npm run test:unit
+```
 
 
 
@@ -143,9 +162,9 @@ $ npm run test:unit
 
 <br/>
 
-## @TODOS
+## License
 
-- [ ] ...
+[MIT](https://choosealicense.com/licenses/mit/)
 
 
 
@@ -157,17 +176,17 @@ $ npm run test:unit
 
 Install dependencies:
 ```bash
-$ npm install
+npm install
 ```
 
 
 Build the library:
 ```bash
-$ npm start
+npm start
 ```
 
 
 Publish to `npm`:
 ```bash
-$ npm publish
+npm publish
 ```

package/dist/index.d.ts

@@ -6,6 +6,13 @@ import { IErrorCode, IDecodedError } from './shared/types.js';
  * @returns string
  */
 declare const extractMessage: (error: any) => string;
+/**
+ * Verifies if a value matches the default error message used by this package.
+ * @param value
+ * @param fullMatch?
+ * @returns boolean
+ */
+declare const isDefaultErrorMessage: (value: string, fullMatch?: boolean) => value is string;
 /**
  * Given an error in any format, it extracts the message and inserts the code at the end.
  * @param error
@@ -26,4 +33,4 @@ declare const decodeError: (error: any) => IDecodedError;
  * @returns boolean
  */
 declare const isEncodedError: (error: any) => boolean;
-export { IErrorCode, IDecodedError, extractMessage, encodeError, decodeError, isEncodedError, };
+export { type IErrorCode, type IDecodedError, extractMessage, isDefaultErrorMessage, encodeError, decodeError, isEncodedError, };

package/dist/index.js

@@ -1 +1 @@
-import{DEFAULT_MESSAGE,DEFAULT_CODE,wrapCode,unwrapCode}from"./utils/utils.js";const extractMessage=r=>{if("string"==typeof r&&r.length)return r;if(r instanceof Error&&r.message)return r.cause?`${r.message}; [CAUSE]: ${extractMessage(r.cause)}`:r.message;if(r&&"object"==typeof r){if(r.message)return extractMessage(r.message);if(r.msg)return extractMessage(r.msg);if(r.error)return extractMessage(r.error);if(r.err)return extractMessage(r.err);if(r.errors)return extractMessage(r.errors);if(r.errs)return extractMessage(r.errs);try{return JSON.stringify(r)}catch(e){console.error("Error during extractMessage:"),console.error("Original Error: ",r),console.error("JSON.stringify Error:",e)}}return DEFAULT_MESSAGE},encodeError=(r,e)=>`${extractMessage(r)}${wrapCode(e)}`,decodeError=r=>{const e=extractMessage(r),{code:s,startsAt:t}=unwrapCode(e);return{message:t>0?e.slice(0,t):e,code:s}},isEncodedError=r=>decodeError(r).code!==DEFAULT_CODE;export{extractMessage,encodeError,decodeError,isEncodedError};
+import{DEFAULT_MESSAGE,DEFAULT_CODE,wrapCode,unwrapCode}from"./utils/utils.js";const extractMessage=r=>{if("string"==typeof r&&r.length)return r;if(r instanceof Error&&r.message)return r.cause?`${r.message}; [CAUSE]: ${extractMessage(r.cause)}`:r.message;if(r&&"object"==typeof r){if(r.message)return extractMessage(r.message);if(r.msg)return extractMessage(r.msg);if(r.error)return extractMessage(r.error);if(r.err)return extractMessage(r.err);if(r.errors)return extractMessage(r.errors);if(r.errs)return extractMessage(r.errs);try{return JSON.stringify(r)}catch(e){console.error("Error during extractMessage:"),console.error("Original Error: ",r),console.error("JSON.stringify Error:",e)}}return DEFAULT_MESSAGE},isDefaultErrorMessage=(r,e=!1)=>e?r===DEFAULT_MESSAGE:"string"==typeof r&&r.includes(DEFAULT_MESSAGE),encodeError=(r,e)=>`${extractMessage(r)}${wrapCode(e)}`,decodeError=r=>{const e=extractMessage(r),{code:s,startsAt:t}=unwrapCode(e);return{message:t>0?e.slice(0,t):e,code:s}},isEncodedError=r=>decodeError(r).code!==DEFAULT_CODE;export{extractMessage,isDefaultErrorMessage,encodeError,decodeError,isEncodedError};

package/dist/shared/types.d.ts

@@ -9,8 +9,8 @@ type IErrorCodeWrapper = {
 };
 /**
  * Error Code
- * The error's code that is inserted when encoding an error. If none is provided or none can be
- * extracted, it defaults to -1.
+ * The code that is inserted when encoding an error. If none is provided or none can be extracted,
+ * it defaults to -1.
  */
 type IErrorCode = string | number;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "error-message-utils",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "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",
@@ -37,14 +37,14 @@
   },
   "homepage": "https://github.com/jesusgraterol/error-message-utils#readme",
   "devDependencies": {
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.14.10",
-    "@typescript-eslint/eslint-plugin": "^7.16.0",
-    "@typescript-eslint/parser": "^7.16.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.17.9",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
     "eslint-config-airbnb-typescript": "^18.0.0",
     "jest": "^29.7.0",
-    "ts-jest": "^29.2.0",
-    "ts-lib-builder": "^1.0.3",
-    "typescript": "^5.5.3"
+    "ts-jest": "^29.2.5",
+    "ts-lib-builder": "^1.0.5",
+    "typescript": "^5.7.2"
   }
 }