Add detail generic to ApiError

icapps · May 7, 2020 · 94a300a · 94a300a
1 parent d38c61e
commit 94a300a
Show file tree

Hide file tree

Showing 3 changed files with 5,433 additions and 4 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';