@augment-vir/common 22.0.1 → 22.1.0

package/dist/cjs/augments/debounce.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDebounce = exports.DebounceStyle = void 0;
+var DebounceStyle;
+(function (DebounceStyle) {
+    /**
+     * Fires on the first call, then waits the given amount of milliseconds until a subsequent call
+     * can be made.
+     */
+    DebounceStyle["FirstThenWait"] = "first-then-wait";
+    /**
+     * Waits the given amount of milliseconds after the first call and then fires the latest
+     * assigned callback.
+     */
+    DebounceStyle["AfterWait"] = "after-wait";
+})(DebounceStyle || (exports.DebounceStyle = DebounceStyle = {}));
+function createDebounce(debounceStyle, debounceDuration) {
+    let nextCallTimestamp = 0;
+    let latestCallback = undefined;
+    return (callback) => {
+        latestCallback = callback;
+        const now = Date.now();
+        if (nextCallTimestamp > now) {
+            return;
+        }
+        if (debounceStyle === DebounceStyle.FirstThenWait) {
+            latestCallback();
+        }
+        else if (debounceStyle === DebounceStyle.AfterWait) {
+            setTimeout(() => {
+                /** Use whatever the latest latestCallback is. */
+                latestCallback?.();
+            }, debounceDuration.milliseconds);
+        }
+        nextCallTimestamp = now + debounceDuration.milliseconds;
+    };
+}
+exports.createDebounce = createDebounce;

package/dist/cjs/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./augments/async"), exports);
 __exportStar(require("./augments/boolean"), exports);
 __exportStar(require("./augments/common-number"), exports);
 __exportStar(require("./augments/common-string"), exports);
+__exportStar(require("./augments/debounce"), exports);
 __exportStar(require("./augments/environment"), exports);
 __exportStar(require("./augments/error"), exports);
 __exportStar(require("./augments/function"), exports);

package/dist/esm/augments/debounce.js

@@ -0,0 +1,34 @@
+export var DebounceStyle;
+(function (DebounceStyle) {
+    /**
+     * Fires on the first call, then waits the given amount of milliseconds until a subsequent call
+     * can be made.
+     */
+    DebounceStyle["FirstThenWait"] = "first-then-wait";
+    /**
+     * Waits the given amount of milliseconds after the first call and then fires the latest
+     * assigned callback.
+     */
+    DebounceStyle["AfterWait"] = "after-wait";
+})(DebounceStyle || (DebounceStyle = {}));
+export function createDebounce(debounceStyle, debounceDuration) {
+    let nextCallTimestamp = 0;
+    let latestCallback = undefined;
+    return (callback) => {
+        latestCallback = callback;
+        const now = Date.now();
+        if (nextCallTimestamp > now) {
+            return;
+        }
+        if (debounceStyle === DebounceStyle.FirstThenWait) {
+            latestCallback();
+        }
+        else if (debounceStyle === DebounceStyle.AfterWait) {
+            setTimeout(() => {
+                /** Use whatever the latest latestCallback is. */
+                latestCallback?.();
+            }, debounceDuration.milliseconds);
+        }
+        nextCallTimestamp = now + debounceDuration.milliseconds;
+    };
+}

package/dist/esm/index.js

@@ -4,6 +4,7 @@ export * from './augments/async';
 export * from './augments/boolean';
 export * from './augments/common-number';
 export * from './augments/common-string';
+export * from './augments/debounce';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';

package/dist/types/augments/debounce.d.ts

@@ -0,0 +1,15 @@
+export declare enum DebounceStyle {
+    /**
+     * Fires on the first call, then waits the given amount of milliseconds until a subsequent call
+     * can be made.
+     */
+    FirstThenWait = "first-then-wait",
+    /**
+     * Waits the given amount of milliseconds after the first call and then fires the latest
+     * assigned callback.
+     */
+    AfterWait = "after-wait"
+}
+export declare function createDebounce(debounceStyle: DebounceStyle, debounceDuration: {
+    milliseconds: number;
+}): (callback: () => void) => void;

package/dist/types/index.d.ts

@@ -4,6 +4,7 @@ export * from './augments/async';
 export * from './augments/boolean';
 export * from './augments/common-number';
 export * from './augments/common-string';
+export * from './augments/debounce';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "22.0.1",
+    "version": "22.1.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"