@httptoolkit/util 0.1.2 → 0.1.4

package/dist/errors.d.ts

@@ -8,6 +8,7 @@ export type ErrorLike = Partial<Error> & {
     signal?: string;
     statusCode?: number;
     statusMessage?: string;
+    cause?: ErrorLike;
 };
 /**
  * An easy way to check if an unknown object (e.g. a catch(e) argument) is
@@ -18,8 +19,25 @@ export declare function isErrorLike(error: any): error is ErrorLike;
  * A convenience method to make something error-ish into an actual Error instance.
  */
 export declare function asErrorLike(error: any): ErrorLike;
-export declare abstract class CustomError extends Error {
-    constructor(message?: string);
+export declare class CustomError extends Error implements ErrorLike {
+    constructor(message?: string, extras?: {
+        code?: string;
+        statusCode?: number;
+        cause?: Error;
+    });
+    readonly code?: string;
+    readonly statusCode?: number;
+    readonly cause?: Error;
+}
+export declare class StatusError extends CustomError {
+    constructor(
+    /**
+     * Should be a valid HTTP status code
+     */
+    statusCode: number, message: string, extras?: {
+        code?: string;
+        cause?: Error;
+    });
 }
 /**
  * An error to throw in expected-never cases - by using this, you ask TypeScript to

package/dist/errors.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unreachableCheck = exports.UnreachableCheck = exports.CustomError = exports.asErrorLike = exports.isErrorLike = void 0;
+exports.unreachableCheck = exports.UnreachableCheck = exports.StatusError = exports.CustomError = exports.asErrorLike = exports.isErrorLike = void 0;
 /**
  * An easy way to check if an unknown object (e.g. a catch(e) argument) is
  * actually an error-like
  */
 function isErrorLike(error) {
-    return typeof error === 'object' && (error instanceof Error ||
+    return error && typeof error === 'object' && (error instanceof Error ||
         error.message ||
         error.code ||
         error.stack);
@@ -16,21 +16,44 @@ exports.isErrorLike = isErrorLike;
  * A convenience method to make something error-ish into an actual Error instance.
  */
 function asErrorLike(error) {
-    if (isErrorLike(error))
+    if (isErrorLike(error)) {
         return error;
+    }
+    else if (error) {
+        return new Error(error.message || error.toString() || '[Unknown error]');
+    }
     else {
-        return new Error(error.message || error.toString());
+        return new Error('[Undefined error]');
     }
 }
 exports.asErrorLike = asErrorLike;
-// Tiny wrapper to make it super easy to make custom error classes where .name behaves correctly.
+// Tiny wrapper to make it super easy to make custom error classes where .name behaves
+// correctly, and useful metafields can be easily added.
 class CustomError extends Error {
-    constructor(message) {
-        super(message);
+    constructor(message, extras = {}) {
+        super(message); // 'Error' breaks prototype chain here
+        // This restores the details of the real error subclass:
         this.name = new.target.name;
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (extras.code !== undefined)
+            this.code = extras.code;
+        if (extras.statusCode !== undefined)
+            this.statusCode = extras.statusCode;
+        if (extras.cause !== undefined)
+            this.cause = extras.cause;
     }
 }
 exports.CustomError = CustomError;
+class StatusError extends CustomError {
+    constructor(
+    /**
+     * Should be a valid HTTP status code
+     */
+    statusCode, message, extras = {}) {
+        super(message, { ...extras, statusCode: statusCode });
+    }
+}
+exports.StatusError = StatusError;
 /**
  * An error to throw in expected-never cases - by using this, you ask TypeScript to
  * be sure that it agrees that the case is truly unreachable.

package/dist/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAaA;;;GAGG;AACH,SAAgB,WAAW,CAAC,KAAU;IAClC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,CAChC,KAAK,YAAY,KAAK;QACtB,KAAK,CAAC,OAAO;QACb,KAAK,CAAC,IAAI;QACV,KAAK,CAAC,KAAK,CACd,CAAA;AACL,CAAC;AAPD,kCAOC;AAED;;GAEG;AACH,SAAgB,WAAW,CAAC,KAAU;IAClC,IAAI,WAAW,CAAC,KAAK,CAAC;QAAE,OAAO,KAAkB,CAAC;SAC7C;QACD,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;KACvD;AACL,CAAC;AALD,kCAKC;AAED,iGAAiG;AACjG,MAAsB,WAAY,SAAQ,KAAK;IAC3C,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;IAChC,CAAC;CACJ;AALD,kCAKC;AAED;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,WAAW;IAE7C,qFAAqF;IACrF,mDAAmD;IACnD,YAAY,KAAY,EAAE,WAA4B,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1D,KAAK,CAAC,yBAAyB,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACtD,CAAC;CAEJ;AARD,4CAQC;AAED;;GAEG;AACI,MAAM,gBAAgB,GAAG,CAAC,KAAY,EAAE,WAA4B,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAS,EAAE;IAC1F,MAAM,IAAI,gBAAgB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAChD,CAAC,CAAA;AAFY,QAAA,gBAAgB,oBAE5B"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAcA;;;GAGG;AACH,SAAgB,WAAW,CAAC,KAAU;IAClC,OAAO,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CACzC,KAAK,YAAY,KAAK;QACtB,KAAK,CAAC,OAAO;QACb,KAAK,CAAC,IAAI;QACV,KAAK,CAAC,KAAK,CACd,CAAA;AACL,CAAC;AAPD,kCAOC;AAED;;GAEG;AACH,SAAgB,WAAW,CAAC,KAAU;IAClC,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE;QACpB,OAAO,KAAkB,CAAC;KAC7B;SAAM,IAAI,KAAK,EAAE;QACd,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE,IAAI,iBAAiB,CAAC,CAAC;KAC5E;SAAM;QACH,OAAO,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;KACzC;AACL,CAAC;AARD,kCAQC;AAED,sFAAsF;AACtF,wDAAwD;AACxD,MAAa,WAAY,SAAQ,KAAK;IAClC,YAAY,OAAgB,EAAE,SAI1B,EAAE;QACF,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,sCAAsC;QAEtD,wDAAwD;QACxD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;QAC5B,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAElD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;YAAE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACvD,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS;YAAE,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACzE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS;YAAE,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAC9D,CAAC;CAKJ;AApBD,kCAoBC;AAED,MAAa,WAAY,SAAQ,WAAW;IACxC;IACI;;OAEG;IACH,UAAkB,EAClB,OAAe,EACf,SAGI,EAAE;QAEN,KAAK,CAAC,OAAO,EAAE,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC;IAC1D,CAAC;CACJ;AAdD,kCAcC;AAED;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,WAAW;IAE7C,qFAAqF;IACrF,mDAAmD;IACnD,YAAY,KAAY,EAAE,WAA4B,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1D,KAAK,CAAC,yBAAyB,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACtD,CAAC;CAEJ;AARD,4CAQC;AAED;;GAEG;AACI,MAAM,gBAAgB,GAAG,CAAC,KAAY,EAAE,WAA4B,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAS,EAAE;IAC1F,MAAM,IAAI,gBAAgB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAChD,CAAC,CAAA;AAFY,QAAA,gBAAgB,oBAE5B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@httptoolkit/util",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "A tiny utility package, sharing JS code widely used across HTTP Toolkit projects",
   "main": "dist/index.js",
   "files": [

package/src/errors.ts

@@ -9,6 +9,7 @@ export type ErrorLike = Partial<Error> & {
     signal?: string;
     statusCode?: number;
     statusMessage?: string;
+    cause?: ErrorLike;
 };
 
 /**
@@ -16,7 +17,7 @@ export type ErrorLike = Partial<Error> & {
  * actually an error-like
  */
 export function isErrorLike(error: any): error is ErrorLike {
-    return typeof error === 'object' && (
+    return error && typeof error === 'object' && (
         error instanceof Error ||
         error.message ||
         error.code ||
@@ -28,17 +29,52 @@ export function isErrorLike(error: any): error is ErrorLike {
  * A convenience method to make something error-ish into an actual Error instance.
  */
 export function asErrorLike(error: any): ErrorLike {
-    if (isErrorLike(error)) return error as ErrorLike;
-    else {
-        return new Error(error.message || error.toString());
+    if (isErrorLike(error)) {
+        return error as ErrorLike;
+    } else if (error) {
+        return new Error(error.message || error.toString() || '[Unknown error]');
+    } else {
+        return new Error('[Undefined error]');
     }
 }
 
-// Tiny wrapper to make it super easy to make custom error classes where .name behaves correctly.
-export abstract class CustomError extends Error {
-    constructor(message?: string) {
-        super(message);
+// Tiny wrapper to make it super easy to make custom error classes where .name behaves
+// correctly, and useful metafields can be easily added.
+export class CustomError extends Error implements ErrorLike {
+    constructor(message?: string, extras: {
+        code?: string,
+        statusCode?: number,
+        cause?: Error
+    } = {}) {
+        super(message); // 'Error' breaks prototype chain here
+
+        // This restores the details of the real error subclass:
         this.name = new.target.name;
+        Object.setPrototypeOf(this, new.target.prototype);
+
+        if (extras.code !== undefined) this.code = extras.code;
+        if (extras.statusCode !== undefined) this.statusCode = extras.statusCode;
+        if (extras.cause !== undefined) this.cause = extras.cause;
+    }
+
+    public readonly code?: string;
+    public readonly statusCode?: number;
+    public readonly cause?: Error;
+}
+
+export class StatusError extends CustomError {
+    constructor(
+        /**
+         * Should be a valid HTTP status code
+         */
+        statusCode: number,
+        message: string,
+        extras: {
+            code?: string,
+            cause?: Error
+        } = {}
+    ) {
+        super(message, { ...extras, statusCode: statusCode });
     }
 }