@httptoolkit/util 0.1.6 → 0.1.8

package/dist/errors.d.ts

@@ -8,7 +8,7 @@ export type ErrorLike = Partial<Error> & {
     signal?: string;
     statusCode?: number;
     statusMessage?: string;
-    cause?: ErrorLike;
+    cause?: ErrorLike | Error | unknown;
 };
 /**
  * An easy way to check if an unknown object (e.g. a catch(e) argument) is

package/dist/errors.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unreachableCheck = exports.UnreachableCheck = exports.StatusError = exports.CustomError = exports.asErrorLike = exports.isErrorLike = void 0;
+exports.unreachableCheck = exports.UnreachableCheck = exports.StatusError = exports.CustomError = void 0;
+exports.isErrorLike = isErrorLike;
+exports.asErrorLike = asErrorLike;
 /**
  * An easy way to check if an unknown object (e.g. a catch(e) argument) is
  * actually an error-like
@@ -11,7 +13,6 @@ function isErrorLike(error) {
         error.code ||
         error.stack);
 }
-exports.isErrorLike = isErrorLike;
 /**
  * A convenience method to make something error-ish into an actual Error instance.
  */
@@ -26,7 +27,6 @@ function asErrorLike(error) {
         return new Error('[Undefined error]');
     }
 }
-exports.asErrorLike = asErrorLike;
 // 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 {
@@ -42,6 +42,9 @@ class CustomError extends Error {
         if (extras.cause !== undefined)
             this.cause = extras.cause;
     }
+    code;
+    statusCode;
+    cause;
 }
 exports.CustomError = CustomError;
 class StatusError extends CustomError {

package/dist/errors.js.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAkBA,kCAOC;AAKD,kCAQC;AAxBD;;;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;AAED;;GAEG;AACH,SAAgB,WAAW,CAAC,KAAU;IAClC,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,KAAkB,CAAC;IAC9B,CAAC;SAAM,IAAI,KAAK,EAAE,CAAC;QACf,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE,IAAI,iBAAiB,CAAC,CAAC;IAC7E,CAAC;SAAM,CAAC;QACJ,OAAO,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC1C,CAAC;AACL,CAAC;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;IAEe,IAAI,CAAU;IACd,UAAU,CAAU;IACpB,KAAK,CAAS;CACjC;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/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './promises';
 export * from './errors';
+export * from './text';

package/dist/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./promises"), exports);
 __exportStar(require("./errors"), exports);
+__exportStar(require("./text"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,2CAAyB;AACzB,yCAAuB"}

package/dist/promises.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.combineParallelCalls = exports.getDeferred = exports.doWhile = exports.delay = void 0;
+exports.delay = void 0;
+exports.doWhile = doWhile;
+exports.getDeferred = getDeferred;
+exports.combineParallelCalls = combineParallelCalls;
 const delay = (ms, options = {}) => new Promise((resolve) => {
     const timer = setTimeout(resolve, ms);
     if (options.unref && timer.unref) {
@@ -13,7 +16,6 @@ async function doWhile(doFn, whileFn) {
         await doFn();
     } while (await whileFn());
 }
-exports.doWhile = doWhile;
 function getDeferred() {
     let resolve;
     let reject;
@@ -23,7 +25,6 @@ function getDeferred() {
     });
     return Object.assign(promise, { resolve, reject, promise });
 }
-exports.getDeferred = getDeferred;
 /**
  * Wrap a function, so that any parallel calls which happen while the async function
  * is pending return the same value as the first call (so the function is only run
@@ -42,5 +43,4 @@ function combineParallelCalls(fn) {
         return pendingPromise;
     };
 }
-exports.combineParallelCalls = combineParallelCalls;
 //# sourceMappingURL=promises.js.map

package/dist/promises.js.map

@@ -1 +1 @@
-{"version":3,"file":"promises.js","sourceRoot":"","sources":["../src/promises.ts"],"names":[],"mappings":";;;AAEO,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,UAO9B,EAAE,EAAE,EAAE,CACN,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;IAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAEtC,IAAI,OAAO,CAAC,KAAK,IAAK,KAAa,CAAC,KAAK,EAAE;QACtC,KAAa,CAAC,KAAK,EAAE,CAAC;KAC1B;AACL,CAAC,CAAC,CAAC;AAdM,QAAA,KAAK,SAcX;AAEA,KAAK,UAAU,OAAO,CACzB,IAAsB,EACtB,OAAyC;IAEzC,GAAG;QACC,MAAM,IAAI,EAAE,CAAC;KAChB,QAAQ,MAAM,OAAO,EAAE,EAAE;AAC9B,CAAC;AAPD,0BAOC;AAaD,SAAgB,WAAW;IACvB,IAAI,OAA4B,CAAC;IACjC,IAAI,MAA6B,CAAC;IAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE;QACnD,OAAO,GAAG,SAAS,CAAC;QACpB,MAAM,GAAG,QAAQ,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;AAChE,CAAC;AAVD,kCAUC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAI,EAAoB;IACxD,IAAI,cAAsC,CAAC;IAE3C,OAAO,GAAG,EAAE;QACR,IAAI,cAAc,KAAK,SAAS,EAAE;YAC9B,cAAc,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;gBAC/B,cAAc,GAAG,SAAS,CAAC;YAC/B,CAAC,CAAC,CAAC;SACN;QAED,OAAO,cAAc,CAAC;IAC1B,CAAC,CAAC;AACN,CAAC;AAZD,oDAYC"}
+{"version":3,"file":"promises.js","sourceRoot":"","sources":["../src/promises.ts"],"names":[],"mappings":";;;AAkBA,0BAOC;AAaD,kCAUC;AASD,oDAYC;AAnEM,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,UAO9B,EAAE,EAAE,EAAE,CACN,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;IAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAEtC,IAAI,OAAO,CAAC,KAAK,IAAK,KAAa,CAAC,KAAK,EAAE,CAAC;QACvC,KAAa,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;AACL,CAAC,CAAC,CAAC;AAdM,QAAA,KAAK,SAcX;AAEA,KAAK,UAAU,OAAO,CACzB,IAAsB,EACtB,OAAyC;IAEzC,GAAG,CAAC;QACA,MAAM,IAAI,EAAE,CAAC;IACjB,CAAC,QAAQ,MAAM,OAAO,EAAE,EAAE;AAC9B,CAAC;AAaD,SAAgB,WAAW;IACvB,IAAI,OAA4B,CAAC;IACjC,IAAI,MAA6B,CAAC;IAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE;QACnD,OAAO,GAAG,SAAS,CAAC;QACpB,MAAM,GAAG,QAAQ,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;AAChE,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAI,EAAoB;IACxD,IAAI,cAAsC,CAAC;IAE3C,OAAO,GAAG,EAAE;QACR,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YAC/B,cAAc,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;gBAC/B,cAAc,GAAG,SAAS,CAAC;YAC/B,CAAC,CAAC,CAAC;QACP,CAAC;QAED,OAAO,cAAc,CAAC;IAC1B,CAAC,CAAC;AACN,CAAC"}

package/dist/text.d.ts

@@ -0,0 +1,7 @@
+export declare function truncateWithEllipsis(str: string, length: number): string;
+export declare function joinAnd(val: string[], options?: {
+    separator?: string;
+    finalSeparator?: string;
+    oxfordComma?: boolean;
+}): string;
+export declare function aOrAn(value: string): "a" | "an";

package/dist/text.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.truncateWithEllipsis = truncateWithEllipsis;
+exports.joinAnd = joinAnd;
+exports.aOrAn = aOrAn;
+function truncateWithEllipsis(str, length) {
+    if (str.length <= length) {
+        return str;
+    }
+    else {
+        return str.slice(0, length - 3) + "...";
+    }
+}
+function joinAnd(val, options = {}) {
+    if (val.length === 1)
+        return val[0];
+    const separator = options.separator ?? ', ';
+    const finalSeparator = options.finalSeparator ?? 'and ';
+    const oxfordComma = options.oxfordComma ?? false;
+    return val.slice(0, -1).join(separator) +
+        (oxfordComma ? separator : ' ') +
+        finalSeparator +
+        val[val.length - 1];
+}
+const VOWEL_ISH = ['a', 'e', 'i', 'o', 'u', 'y'];
+function aOrAn(value) {
+    if (VOWEL_ISH.includes(value[0].toLowerCase()))
+        return 'an';
+    else
+        return 'a';
+}
+//# sourceMappingURL=text.js.map

package/dist/text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../src/text.ts"],"names":[],"mappings":";;AAAA,oDAMC;AAED,0BAkBC;AAGD,sBAGC;AAhCD,SAAgB,oBAAoB,CAAC,GAAW,EAAE,MAAc;IAC5D,IAAI,GAAG,CAAC,MAAM,IAAI,MAAM,EAAE,CAAC;QACvB,OAAO,GAAG,CAAC;IACf,CAAC;SAAM,CAAC;QACJ,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;IAC5C,CAAC;AACL,CAAC;AAED,SAAgB,OAAO,CAAC,GAAa,EAAE,UAOnC,EAAE;IACF,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;IAEpC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC;IAC5C,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,MAAM,CAAC;IACxD,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,KAAK,CAAC;IAEjD,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;QACnC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC;QAC/B,cAAc;QACd,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC5B,CAAC;AAED,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACjD,SAAgB,KAAK,CAAC,KAAa;IAC/B,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAAE,OAAO,IAAI,CAAC;;QACvD,OAAO,GAAG,CAAC;AACpB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@httptoolkit/util",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "A tiny utility package, sharing JS code widely used across HTTP Toolkit projects",
   "main": "dist/index.js",
   "files": [
@@ -28,6 +28,6 @@
   },
   "homepage": "https://github.com/httptoolkit/httptoolkit-js-util#readme",
   "devDependencies": {
-    "typescript": "5.2.2"
+    "typescript": "5.9.3"
   }
 }

package/src/errors.ts

@@ -9,7 +9,7 @@ export type ErrorLike = Partial<Error> & {
     signal?: string;
     statusCode?: number;
     statusMessage?: string;
-    cause?: ErrorLike;
+    cause?: ErrorLike | Error | unknown; // Needs to be compatible with Error types for this
 };
 
 /**

package/src/index.ts

@@ -1,2 +1,3 @@
 export * from './promises';
-export * from './errors';
+export * from './errors';
+export * from './text';

package/src/text.ts

@@ -0,0 +1,33 @@
+export function truncateWithEllipsis(str: string, length: number) {
+    if (str.length <= length) {
+        return str;
+    } else {
+        return str.slice(0, length - 3) + "...";
+    }
+}
+
+export function joinAnd(val: string[], options: {
+    // Separator between all but the last value
+    separator?: string,
+    // Separator before last value (preceeded with space or `separator` if oxfordComma is true)
+    finalSeparator?: string,
+    // Should there be a separator between the penultimate value & finalSeparator?
+    oxfordComma?: boolean
+} = {}) {
+    if (val.length === 1) return val[0];
+
+    const separator = options.separator ?? ', ';
+    const finalSeparator = options.finalSeparator ?? 'and ';
+    const oxfordComma = options.oxfordComma ?? false;
+
+    return val.slice(0, -1).join(separator) +
+        (oxfordComma ? separator : ' ') +
+        finalSeparator +
+        val[val.length - 1];
+}
+
+const VOWEL_ISH = ['a', 'e', 'i', 'o', 'u', 'y'];
+export function aOrAn(value: string) {
+    if (VOWEL_ISH.includes(value[0].toLowerCase())) return 'an';
+    else return 'a';
+}