@augment-vir/common 31.41.0 → 31.42.0

package/dist/augments/interval/blocking-interval.d.ts

@@ -0,0 +1,14 @@
+import { type MaybePromise } from '@augment-vir/core';
+import { type AnyDuration } from '@date-vir/duration';
+/**
+ * Creates an interval that prevents multiple parallel executions. If the previous callback
+ * execution is still executing, the next one will not fire.
+ *
+ * @category Interval
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function createBlockingInterval(callback: () => MaybePromise<void>, interval: AnyDuration): {
+    intervalId: NodeJS.Timeout;
+    clearInterval(this: void): void;
+};

package/dist/augments/interval/blocking-interval.js

@@ -0,0 +1,30 @@
+import { convertDuration } from '@date-vir/duration';
+/**
+ * Creates an interval that prevents multiple parallel executions. If the previous callback
+ * execution is still executing, the next one will not fire.
+ *
+ * @category Interval
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function createBlockingInterval(callback, interval) {
+    let isExecuting = false;
+    const intervalId = globalThis.setInterval(async () => {
+        if (isExecuting) {
+            return;
+        }
+        isExecuting = true;
+        try {
+            await callback();
+        }
+        finally {
+            isExecuting = false;
+        }
+    }, convertDuration(interval, { milliseconds: true }).milliseconds);
+    return {
+        intervalId,
+        clearInterval() {
+            globalThis.clearInterval(intervalId);
+        },
+    };
+}

package/dist/index.d.ts

@@ -22,6 +22,7 @@ export * from './augments/function/execution-duration.js';
 export * from './augments/function/if-truthy.js';
 export * from './augments/function/retry.js';
 export * from './augments/function/wrap-in-try.js';
+export * from './augments/interval/blocking-interval.js';
 export * from './augments/json/append-json.js';
 export * from './augments/json/copy-through-json.js';
 export * from './augments/json/json5.js';

package/dist/index.js

@@ -22,6 +22,7 @@ export * from './augments/function/execution-duration.js';
 export * from './augments/function/if-truthy.js';
 export * from './augments/function/retry.js';
 export * from './augments/function/wrap-in-try.js';
+export * from './augments/interval/blocking-interval.js';
 export * from './augments/json/append-json.js';
 export * from './augments/json/copy-through-json.js';
 export * from './augments/json/json5.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "31.41.0",
+    "version": "31.42.0",
     "description": "A collection of augments, helpers types, functions, and classes for any JavaScript environment.",
     "keywords": [
         "augment",
@@ -40,9 +40,9 @@
         "test:web": "virmator --no-deps test web"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.41.0",
-        "@augment-vir/core": "^31.41.0",
-        "@date-vir/duration": "^7.4.3",
+        "@augment-vir/assert": "^31.42.0",
+        "@augment-vir/core": "^31.42.0",
+        "@date-vir/duration": "^8.0.0",
         "ansi-styles": "^6.2.3",
         "deepcopy-esm": "^2.1.1",
         "json5": "^2.2.3",