feat: Add unit tests.

Author: Danial Manavi

README.md

@@ -4,10 +4,6 @@
 [![NPM downloads][downloads-image]](https://npmjs.org/package/error-lib)
 [![Build Status][github-actions-publish-npm-package]](https://github.com/DManavi/error_lib/actions/workflows/publish_npm_package.yml)
 
-## Deprecated
-
-This package is deprecated. Please use [@speedup/errors](https://www.npmjs.com/package/@speedup/error).
-
 ## About
 
 The error-lib project helps developers having a unified error structure in their NodeJS/Browser (JavaScript/TypeScript) projects.
@@ -31,13 +27,47 @@ pnpm add error-lib
 
 ## Usage
 
-See the [docs](https://github.com/DManavi/error_lib/wiki)
+To use any of the custom error libraries you need to simply import them in your typescript/javascript application.
+
+```js
+
+// for NodeJS applications (Common JS)
+const { ApplicationError, NotFoundError } = require('error-lib');
+
+try {
+
+  if (fileNotFound === true) {
+    throw new NotFoundError('config.json was not found');
+  }
+}
+catch (err) {
+
+  if (err instanceof NotFoundError) {
+    // 
+  }
+}
+
+```
+
+```ts
+
+// For typescript/javascript (ES Module)
+import { ApplicationError, NotFoundError } from 'error-lib';
+
+
+
+
+```
+
+## Extend / Custom errors
+
+
 
 And you're good to go!
 
 ## License
 
-GPL v3
+MIT
 
 [npm-image]: https://img.shields.io/npm/v/error-lib
 [npm-url]: https://npmjs.org/package/error-lib

package-lock.json

@@ -24,8 +24,7 @@
     "clean": "rimraf dist/",
     "build:import": "tsc -b ./tsconfig.build.import.json",
     "build:require": "tsc -b ./tsconfig.build.require.json",
-    "build": "run-p build:import build:require",
-    "rebuild": "run-s clean build",
+    "build": "run-p clean build:import build:require",
     "test": "jest",
     "test:watch": "jest --watch",
     "coverage": "jest --coverage"
@@ -53,6 +52,7 @@
   },
   "homepage": "https://github.com/DManavi/error_lib#readme",
   "devDependencies": {
+    "@types/jest": "27.5.2",
     "jest": "28.1.0",
     "npm-run-all": "4.1.5",
     "rimraf": "3.0.2",

package.json

@@ -0,0 +1,59 @@
+import { ApplicationError } from './application_error';
+
+describe('ApplicationError', () => {
+  it('check inheritance tree', () => {
+    const err = new ApplicationError();
+
+    expect(err instanceof Error).toBeTruthy();
+    expect(err instanceof ApplicationError).toBeTruthy();
+  });
+
+  it('should set default error message', () => {
+    const err = new ApplicationError();
+
+    expect(err).toHaveProperty('message');
+    expect(typeof err.message).toBe('string');
+    expect(err.message).toBe('ApplicationError');
+  });
+
+  it('should set custom error message', () => {
+    const err = new ApplicationError('MyErrorMessage');
+
+    expect(err).toHaveProperty('message');
+    expect(typeof err.message).toBe('string');
+    expect(err.message).toBe('MyErrorMessage');
+  });
+
+  it('should set default error code', () => {
+    const err = new ApplicationError();
+
+    expect(err).toHaveProperty('code');
+    expect(typeof err.code).toBe('string');
+    expect(err.code).toBe('E_APPLICATION_ERROR');
+  });
+
+  it('should set custom error code', () => {
+    const err = new ApplicationError(undefined, { code: 'E_CUSTOM_ERROR' });
+
+    expect(err).toHaveProperty('code');
+    expect(typeof err.code).toBe('string');
+    expect(err.code).toBe('E_CUSTOM_ERROR');
+  });
+
+  it('should set default cause (undefined)', () => {
+    const err = new ApplicationError();
+
+    expect(err).toHaveProperty('cause');
+    expect(typeof err.cause).toBe('undefined');
+    expect(err.cause).toBe(undefined);
+  });
+
+  it('should set custom cause (another application error)', () => {
+    const cause = new ApplicationError(undefined, { code: 'E_CAUSE' });
+    const err = new ApplicationError(undefined, { cause });
+
+    expect(err).toHaveProperty('cause');
+    expect(err.cause instanceof ApplicationError).toBeTruthy();
+    expect((err.cause as ApplicationError).code).toBe('E_CAUSE');
+  });
+});

resources/diagram.png

@@ -41,31 +41,7 @@ export class ApplicationError<TCause extends Error = Error> extends Error {
     this.code = opts?.code ?? 'E_APPLICATION_ERROR';
     this.cause = opts?.cause;
 
-    this.configureSubError(ApplicationError);
-  }
-
-  /**
-   * Configure sub error
-   * @param cls Constructor/class of the error
-   */
-  protected configureSubError<T>(cls: Class<T>) {
-    this.captureStackTrace(cls);
-    this.setPrototypeOf(cls);
-  }
-
-  /**
-   * Capture stack trace in the error
-   * @param cls Constructor/class of the error
-   */
-  private captureStackTrace<T>(cls: Class<T>) {
-    Error.captureStackTrace(this, cls);
-  }
-
-  /**
-   * Set prototype of the object to enable instanceOf operator
-   * @param cls Constructor/class of the error
-   */
-  private setPrototypeOf<T>(cls: Class<T>) {
-    Object.setPrototypeOf(this, cls.prototype);
+    Error.captureStackTrace(this, ApplicationError);
+    Object.setPrototypeOf(this, ApplicationError.prototype);
   }
 }