@httptoolkit/util 0.1.0 → 0.1.2

package/dist/promises.d.ts

@@ -1,5 +1,12 @@
 export type MaybePromise<T> = T | Promise<T>;
-export declare const delay: (ms: number) => Promise<unknown>;
+export declare const delay: (ms: number, options?: {
+    /**
+     * If set, if the code is running in a compatible runtime (i.e. Node.js)
+     * then the .unref() will be used to ensure that this delay does not
+     * block the process shutdown.
+     */
+    unref?: boolean;
+}) => Promise<unknown>;
 export declare function doWhile<T>(doFn: () => Promise<T>, whileFn: () => Promise<boolean> | boolean): Promise<void>;
 export interface Deferred<T> {
     resolve: (arg: T) => void;

package/dist/promises.js

@@ -1,7 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDeferred = exports.doWhile = exports.delay = void 0;
-const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+const delay = (ms, options = {}) => new Promise((resolve) => {
+    const timer = setTimeout(resolve, ms);
+    if (options.unref && timer.unref) {
+        timer.unref();
+    }
+});
 exports.delay = delay;
 async function doWhile(doFn, whileFn) {
     do {

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,EAAE,CAChC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CACnD,CAAC;AAFW,QAAA,KAAK,SAEhB;AAEK,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,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"}

package/package.json

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

package/src/promises.ts

@@ -1,8 +1,20 @@
 export type MaybePromise<T> = T | Promise<T>;
 
-export const delay = (ms: number) =>
-    new Promise((resolve) => setTimeout(resolve, ms)
-);
+export const delay = (ms: number, options: {
+    /**
+     * If set, if the code is running in a compatible runtime (i.e. Node.js)
+     * then the .unref() will be used to ensure that this delay does not
+     * block the process shutdown.
+     */
+    unref?: boolean
+} = {}) =>
+    new Promise((resolve) => {
+        const timer = setTimeout(resolve, ms);
+
+        if (options.unref && (timer as any).unref) {
+            (timer as any).unref();
+        }
+    });
 
 export async function doWhile<T>(
     doFn: () => Promise<T>,