@augment-vir/common 22.0.0 → 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/augments/object/merge-deep.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.mergeDeep = void 0;
 const run_time_assertions_1 = require("run-time-assertions");
 const tuple_1 = require("../tuple");
-const object_1 = require("./object");
 /**
  * Accepts multiple objects and merges their key-value pairs recursively. Any values set to
  * undefined will be removed.
@@ -22,42 +21,32 @@ function mergeDeep(...inputs) {
     let result = undefined;
     const mergeProps = {};
     inputs.forEach((individualInput) => {
-        try {
-            if (!(0, object_1.isObject)(individualInput)) {
-                /** If not an object, we can't merge. So overwrite instead. */
-                result = individualInput;
-                return;
-            }
-            Object.entries(individualInput).forEach(([key, value,]) => {
-                if (!mergeProps[key]) {
-                    mergeProps[key] = [];
-                }
-                mergeProps[key].push(value);
-            });
-            if (!result) {
-                if ((0, run_time_assertions_1.isRunTimeType)(individualInput, 'array')) {
-                    result = [...individualInput];
-                }
-                else {
-                    result = { ...individualInput };
-                }
-            }
-        }
-        catch (error) {
-            /** Ignore errors, such as individualInput not actually being an object. */
-        }
-    });
-    Object.entries(mergeProps).forEach(([key, mergeValues,]) => {
-        const newValue = mergeDeep(...mergeValues);
-        if (newValue === undefined && key in result) {
-            delete result[key];
+        if (!(0, run_time_assertions_1.isRunTimeType)(individualInput, 'object')) {
+            /** If not an object, we can't merge. So overwrite instead. */
+            result = individualInput;
+            return;
         }
-        else if (newValue !== undefined) {
-            result[key] = newValue;
+        else if (!(0, run_time_assertions_1.isRunTimeType)(result, 'object')) {
+            /** If result isn't an object then we need to make it into one. */
+            result = { ...individualInput };
         }
+        Object.entries(individualInput).forEach(([key, value,]) => {
+            if (!mergeProps[key]) {
+                mergeProps[key] = [];
+            }
+            mergeProps[key].push(value);
+        });
     });
-    if ((0, run_time_assertions_1.isRunTimeType)(result, 'array')) {
-        result = result.filter((entry) => entry !== undefined);
+    if ((0, run_time_assertions_1.isRunTimeType)(result, 'object')) {
+        Object.entries(mergeProps).forEach(([key, mergeValues,]) => {
+            const newValue = mergeDeep(...mergeValues);
+            if (newValue === undefined && key in result) {
+                delete result[key];
+            }
+            else if (newValue !== undefined) {
+                result[key] = newValue;
+            }
+        });
     }
     return result;
 }

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/augments/object/merge-deep.js

@@ -1,6 +1,5 @@
 import { isRunTimeType } from 'run-time-assertions';
 import { isLengthAtLeast } from '../tuple';
-import { isObject } from './object';
 /**
  * Accepts multiple objects and merges their key-value pairs recursively. Any values set to
  * undefined will be removed.
@@ -19,42 +18,32 @@ export function mergeDeep(...inputs) {
     let result = undefined;
     const mergeProps = {};
     inputs.forEach((individualInput) => {
-        try {
-            if (!isObject(individualInput)) {
-                /** If not an object, we can't merge. So overwrite instead. */
-                result = individualInput;
-                return;
-            }
-            Object.entries(individualInput).forEach(([key, value,]) => {
-                if (!mergeProps[key]) {
-                    mergeProps[key] = [];
-                }
-                mergeProps[key].push(value);
-            });
-            if (!result) {
-                if (isRunTimeType(individualInput, 'array')) {
-                    result = [...individualInput];
-                }
-                else {
-                    result = { ...individualInput };
-                }
-            }
-        }
-        catch (error) {
-            /** Ignore errors, such as individualInput not actually being an object. */
-        }
-    });
-    Object.entries(mergeProps).forEach(([key, mergeValues,]) => {
-        const newValue = mergeDeep(...mergeValues);
-        if (newValue === undefined && key in result) {
-            delete result[key];
+        if (!isRunTimeType(individualInput, 'object')) {
+            /** If not an object, we can't merge. So overwrite instead. */
+            result = individualInput;
+            return;
         }
-        else if (newValue !== undefined) {
-            result[key] = newValue;
+        else if (!isRunTimeType(result, 'object')) {
+            /** If result isn't an object then we need to make it into one. */
+            result = { ...individualInput };
         }
+        Object.entries(individualInput).forEach(([key, value,]) => {
+            if (!mergeProps[key]) {
+                mergeProps[key] = [];
+            }
+            mergeProps[key].push(value);
+        });
     });
-    if (isRunTimeType(result, 'array')) {
-        result = result.filter((entry) => entry !== undefined);
+    if (isRunTimeType(result, 'object')) {
+        Object.entries(mergeProps).forEach(([key, mergeValues,]) => {
+            const newValue = mergeDeep(...mergeValues);
+            if (newValue === undefined && key in result) {
+                delete result[key];
+            }
+            else if (newValue !== undefined) {
+                result[key] = newValue;
+            }
+        });
     }
     return result;
 }

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.0",
+    "version": "22.1.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -25,11 +25,11 @@
     },
     "dependencies": {
         "browser-or-node": "^2.1.1",
-        "run-time-assertions": "^0.2.0",
-        "type-fest": "^4.8.1"
+        "run-time-assertions": "^0.2.1",
+        "type-fest": "^4.8.2"
     },
     "devDependencies": {
-        "typescript": "^5.2.2"
+        "typescript": "5.2.2"
     },
     "publishConfig": {
         "access": "public"