error-message-utils 1.1.0 → 1.1.2

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:
 
@@ -100,42 +94,47 @@ isEncodedError(encodeError(new Error('Some unknown error.'), 'NASTY_ERROR'));
 ```
 
 
-<br/>
-
-## Built With
-
-- TypeScript
-
-
 
 
 <br/>
 
-## Running the Tests
+## Types
 
-```bash
-$ npm run test:unit
+```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/)
+## Built With
 
+- TypeScript
 
 
 
 
 <br/>
 
-## Acknowledgments
+## Running the Tests
 
-- ...
+```bash
+npm run test:unit
+```
 
 
 
@@ -143,9 +142,9 @@ $ npm run test:unit
 
 <br/>
 
-## @TODOS
+## License
 
-- [ ] ...
+[MIT](https://choosealicense.com/licenses/mit/)
 
 
 
@@ -157,17 +156,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

@@ -26,4 +26,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, encodeError, decodeError, isEncodedError, };

package/dist/shared/types.d.ts

@@ -3,31 +3,31 @@
  * When an error code is inserted into a message (encoding a message), it must be wrapped first so
  * it can be decoded later.
  */
-interface IErrorCodeWrapper {
+type IErrorCodeWrapper = {
     prefix: string;
     suffix: string;
-}
+};
 /**
  * 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;
 /**
  * Unwrapped Error Code
  * In order to decode an error, the code must be first unwrapped.
  */
-interface IUnwrappedErrorCode {
+type IUnwrappedErrorCode = {
     code: IErrorCode;
     startsAt: 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.
  */
-interface IDecodedError {
+type IDecodedError = {
     message: string;
     code: IErrorCode;
-}
-export { IErrorCodeWrapper, IErrorCode, IUnwrappedErrorCode, IDecodedError, };
+};
+export type { IErrorCodeWrapper, IErrorCode, IUnwrappedErrorCode, IDecodedError, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "error-message-utils",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "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.12.9",
-    "@typescript-eslint/eslint-plugin": "^7.8.0",
-    "@typescript-eslint/parser": "^7.8.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.1.2",
-    "ts-lib-builder": "^1.0.3",
-    "typescript": "^5.4.5"
+    "ts-jest": "^29.2.5",
+    "ts-lib-builder": "^1.0.5",
+    "typescript": "^5.7.2"
   }
 }