@httptoolkit/util 0.1.3 → 0.1.5

package/dist/errors.d.ts

@@ -19,7 +19,7 @@ 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 class CustomError extends Error {
+export declare class CustomError extends Error implements ErrorLike {
     constructor(message?: string, extras?: {
         code?: string;
         statusCode?: number;

package/dist/errors.js

@@ -35,9 +35,12 @@ class CustomError extends Error {
         // This restores the details of the real error subclass:
         this.name = new.target.name;
         Object.setPrototypeOf(this, new.target.prototype);
-        this.code = extras.code;
-        this.statusCode = extras.statusCode;
-        this.cause = extras.cause;
+        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;

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,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAC9B,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":";;;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/dist/promises.d.ts

@@ -6,7 +6,7 @@ export declare const delay: (ms: number, options?: {
      * block the process shutdown.
      */
     unref?: boolean;
-}) => Promise<unknown>;
+}) => Promise<void>;
 export declare function doWhile<T>(doFn: () => Promise<T>, whileFn: () => Promise<boolean> | boolean): Promise<void>;
 export interface Deferred<T> {
     resolve: (arg: T) => void;
@@ -14,3 +14,11 @@ export interface Deferred<T> {
     promise: Promise<T>;
 }
 export declare function getDeferred<T = void>(): Deferred<T>;
+/**
+ * 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
+ * once, but the result is shared). This is useful for expensive async functions or
+ * race conditions. This ignores arguments completely, and is only applicable for
+ * functions that don't need any other input.
+ */
+export declare function combineParallelCalls<T>(fn: () => Promise<T>): () => Promise<T>;

package/dist/promises.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDeferred = exports.doWhile = exports.delay = void 0;
+exports.combineParallelCalls = exports.getDeferred = exports.doWhile = exports.delay = void 0;
 const delay = (ms, options = {}) => new Promise((resolve) => {
     const timer = setTimeout(resolve, ms);
     if (options.unref && timer.unref) {
@@ -26,4 +26,23 @@ function getDeferred() {
     return { 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
+ * once, but the result is shared). This is useful for expensive async functions or
+ * race conditions. This ignores arguments completely, and is only applicable for
+ * functions that don't need any other input.
+ */
+function combineParallelCalls(fn) {
+    let pendingPromise;
+    return () => {
+        if (pendingPromise === undefined) {
+            pendingPromise = fn().finally(() => {
+                pendingPromise = undefined;
+            });
+        }
+        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,CAAC,CAAC,OAAO,EAAE,EAAE;IACpB,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;AAQD,SAAgB,WAAW;IACvB,IAAI,OAAO,GAAmC,SAAS,CAAC;IACxD,IAAI,MAAM,GAAsC,SAAS,CAAC;IAE1D,IAAI,OAAO,GAAG,IAAI,OAAO,CAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE;QACjD,OAAO,GAAG,SAAS,CAAC;QACpB,MAAM,GAAG,QAAQ,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,oEAAoE;IACpE,iDAAiD;IACjD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAS,CAAC;AAC/C,CAAC;AAZD,kCAYC"}
+{"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;AAQD,SAAgB,WAAW;IACvB,IAAI,OAAO,GAAmC,SAAS,CAAC;IACxD,IAAI,MAAM,GAAsC,SAAS,CAAC;IAE1D,IAAI,OAAO,GAAG,IAAI,OAAO,CAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE;QACjD,OAAO,GAAG,SAAS,CAAC;QACpB,MAAM,GAAG,QAAQ,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,oEAAoE;IACpE,iDAAiD;IACjD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAS,CAAC;AAC/C,CAAC;AAZD,kCAYC;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"}

package/package.json

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

package/src/errors.ts

@@ -40,7 +40,7 @@ export function asErrorLike(error: any): ErrorLike {
 
 // 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 {
+export class CustomError extends Error implements ErrorLike {
     constructor(message?: string, extras: {
         code?: string,
         statusCode?: number,
@@ -52,9 +52,9 @@ export class CustomError extends Error {
         this.name = new.target.name;
         Object.setPrototypeOf(this, new.target.prototype);
 
-        this.code = extras.code;
-        this.statusCode = extras.statusCode;
-        this.cause = extras.cause;
+        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;

package/src/promises.ts

@@ -8,7 +8,7 @@ export const delay = (ms: number, options: {
      */
     unref?: boolean
 } = {}) =>
-    new Promise((resolve) => {
+    new Promise<void>((resolve) => {
         const timer = setTimeout(resolve, ms);
 
         if (options.unref && (timer as any).unref) {
@@ -43,4 +43,25 @@ export function getDeferred<T = void>(): Deferred<T> {
     // TS thinks we're using these before they're assigned, which is why
     // we need the undefined types, and the any here.
     return { resolve, reject, promise } as any;
+}
+
+/**
+ * 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
+ * once, but the result is shared). This is useful for expensive async functions or
+ * race conditions. This ignores arguments completely, and is only applicable for
+ * functions that don't need any other input.
+ */
+export function combineParallelCalls<T>(fn: () => Promise<T>): () => Promise<T> {
+    let pendingPromise: Promise<T> | undefined;
+
+    return () => {
+        if (pendingPromise === undefined) {
+            pendingPromise = fn().finally(() => {
+                pendingPromise = undefined;
+            });
+        }
+
+        return pendingPromise;
+    };
 }