Merge pull request #45 from haythamlabrini/f/add-detail-generic-to-ap…

…ierror ✨ add detail generic to apierror
icapps · May 7, 2020 · ba775e3 · ba775e3
2 parents d38c61e + d051631
commit ba775e3
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -23,9 +23,10 @@ yarn add @icapps/tree-house-errors
 
 ## Error types
 
-### ApiError
+### ApiError<T>
 
 Base error class which extends from the `Error` class.
+`ApiError` accepts a generic `T` for the `details` property; if not specified, it defaults to `any`.
 
 ```javascript
 // All keys are required

diff --git a/src/lib/errors.ts b/src/lib/errors.ts
@@ -3,15 +3,15 @@ import * as httpStatus from 'http-status';
 
 import { errors } from '../config/errors.config';
 
-export class ApiError extends Error {
+export class ApiError<T = any> extends Error {
   code: string;
   status: number;
   i18n?: string;
   id?: string;
-  detail?: any;
+  detail?: T;
   isApiError: boolean;
 
-  constructor(status: number, error: ErrorType, args: { message?: string, detail?: any, stack?: any } = {}) {
+  constructor(status: number, error: ErrorType, args: { message?: string, detail?: T, stack?: any } = {}) {
     const { message, detail, stack } = args;
     super(message || error.message);
     this.name = 'ApiError';
@@ -25,57 +25,57 @@ export class ApiError extends Error {
   }
 }
 
-export class GenericError extends ApiError {
-  constructor(error?: ErrorType, args?: ErrorArgs) {
+export class GenericError<T = any> extends ApiError<T> {
+  constructor(error?: ErrorType, args?: ErrorArgs<T>) {
     super(0, error == null ? errors.GENERIC_ERROR : error, args);
     this.name = 'GenericError';
   }
 }
 
-export class BadRequestError extends ApiError {
-  constructor(error?: ErrorType, args?: ErrorArgs) {
+export class BadRequestError<T = any> extends ApiError<T> {
+  constructor(error?: ErrorType, args?: ErrorArgs<T>) {
     super(httpStatus.BAD_REQUEST, error == null ? errors.BAD_REQUEST : error, args);
     this.name = 'BadRequestError';
   }
 }
 
-export class NotFoundError extends ApiError {
-  constructor(error?: ErrorType, args?: ErrorArgs) {
+export class NotFoundError<T = any> extends ApiError<T> {
+  constructor(error?: ErrorType, args?: ErrorArgs<T>) {
     super(httpStatus.NOT_FOUND, error == null ? errors.RESOURCE_NOT_FOUND : error, args);
     this.name = 'NotFoundError';
   }
 }
 
-export class ForbiddenError extends ApiError {
-  constructor(error?: ErrorType, args?: ErrorArgs) {
+export class ForbiddenError<T = any> extends ApiError<T> {
+  constructor(error?: ErrorType, args?: ErrorArgs<T>) {
     super(httpStatus.FORBIDDEN, error == null ? errors.FORBIDDEN : error, args);
     this.name = 'ForbiddenError';
   }
 }
 
-export class InternalServerError extends ApiError {
-  constructor(error?: ErrorType, args?: ErrorArgs) {
+export class InternalServerError<T = any> extends ApiError<T> {
+  constructor(error?: ErrorType, args?: ErrorArgs<T>) {
     super(httpStatus.INTERNAL_SERVER_ERROR, error == null ? errors.INTERNAL_ERROR : error, args);
     this.name = 'InternalServerError';
   }
 }
 
-export class UnauthorizedError extends ApiError {
-  constructor(error?: ErrorType, args?: ErrorArgs) {
+export class UnauthorizedError<T = any>  extends ApiError<T> {
+  constructor(error?: ErrorType, args?: ErrorArgs<T>) {
     super(httpStatus.UNAUTHORIZED, error == null ? errors.UNAUTHORIZED : error, args);
     this.name = 'UnauthorizedError';
   }
 }
 
-export class ValidationError extends ApiError {
-  constructor(error?: ErrorType, args?: ErrorArgs) {
+export class ValidationError<T = any> extends ApiError<T> {
+  constructor(error?: ErrorType, args?: ErrorArgs<T>) {
     super(httpStatus.BAD_REQUEST, error == null ? errors.INVALID_INPUT : error, args);
     this.name = 'ValidationError';
   }
 }
 
-export class AuthenticationError extends ApiError {
-  constructor(error?: ErrorType, args?: ErrorArgs) {
+export class AuthenticationError<T = any> extends ApiError<T> {
+  constructor(error?: ErrorType, args?: ErrorArgs<T>) {
     super(httpStatus.BAD_REQUEST, error == null ? errors.AUTHENTICATION_FAILED : error, args);
     this.name = 'AuthenticationError';
   }
@@ -88,9 +88,9 @@ export interface ErrorType {
   i18n?: string;
 }
 
-export interface ErrorArgs {
+export interface ErrorArgs<T> {
   message?: string;
   status?: number;
-  detail?: any;
+  detail?: T;
   stack?: any;
 }