@etsoo/shared 1.1.11 → 1.1.14

package/README.md

@@ -122,6 +122,7 @@ Extend current class/object functioning
 |Name|Description|
 |---:|---|
 |applyMixins|Apply mixins to current class|
+|delayedExecutor|Create delayed executor|
 |promiseHandler|Promise handler to catch error|
 |sleep|Delay promise|
 

package/__tests__/ExtendUtils.ts

@@ -23,6 +23,26 @@ test('Tests for applyMixins', () => {
     expect(item.m2()).toBe('hello');
 });
 
+test('Tests for delayedExecutor', () => {
+    // Arrange
+    const f = jest.fn();
+
+    jest.useFakeTimers();
+    jest.spyOn(global, 'setTimeout');
+
+    const e = ExtendUtils.delayedExecutor(f, 50);
+
+    e.call(1, false, 'a');
+    expect(e.isRunning()).toBeTruthy();
+
+    e.call(2, true, 'b');
+    expect(setTimeout).toHaveBeenCalledTimes(2);
+
+    jest.runOnlyPendingTimers();
+    expect(f).toBeCalledTimes(1);
+    expect(e.isRunning()).toBeFalsy();
+});
+
 test('Tests for promiseHandler', async () => {
     // Arrange
     const p = (id: number) => {

package/lib/cjs/ExtendUtils.d.ts

@@ -1,3 +1,4 @@
+import { DelayedExecutorType } from './types/DelayedExecutorType';
 /**
  * Extend utilities
  */
@@ -9,6 +10,13 @@ export declare namespace ExtendUtils {
      * @param baseCtors Mixin base classes
      */
     function applyMixins(derivedCtor: any, baseCtors: any[]): void;
+    /**
+     * Create delayed executor
+     * @param func Function
+     * @param delayMiliseconds Delay miliseconds
+     * @returns Result
+     */
+    function delayedExecutor<P extends any[]>(func: (...args: P) => void, delayMiliseconds: number): DelayedExecutorType<P>;
     /**
      * Promise handler to catch error
      * @param promise Promise

package/lib/cjs/ExtendUtils.js

@@ -23,6 +23,46 @@ var ExtendUtils;
         });
     }
     ExtendUtils.applyMixins = applyMixins;
+    /**
+     * Create delayed executor
+     * @param func Function
+     * @param delayMiliseconds Delay miliseconds
+     * @returns Result
+     */
+    function delayedExecutor(func, delayMiliseconds) {
+        let seed = 0;
+        return {
+            /**
+             * Call the function
+             * @param miliseconds Delayed miliseconds for this call
+             * @param args Args
+             */
+            call(miliseconds, ...args) {
+                this.clear();
+                seed = window.setTimeout((...args) => {
+                    func(...args);
+                    seed = 0;
+                }, miliseconds !== null && miliseconds !== void 0 ? miliseconds : delayMiliseconds, ...args);
+            },
+            /**
+             * Clear
+             */
+            clear() {
+                if (this.isRunning()) {
+                    window.clearTimeout(seed);
+                    seed = 0;
+                }
+            },
+            /**
+             * Is running or not
+             * @returns Result
+             */
+            isRunning() {
+                return seed > 0;
+            }
+        };
+    }
+    ExtendUtils.delayedExecutor = delayedExecutor;
     /**
      * Promise handler to catch error
      * @param promise Promise

package/lib/cjs/index.d.ts

@@ -1,4 +1,5 @@
 export * from './types/FormData';
+export * from './types/DelayedExecutorType';
 export * from './storage/IStorage';
 export * from './storage/WindowStorage';
 export * from './DataTypes';

package/lib/cjs/index.js

@@ -11,6 +11,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types/FormData"), exports);
+__exportStar(require("./types/DelayedExecutorType"), exports);
 __exportStar(require("./storage/IStorage"), exports);
 __exportStar(require("./storage/WindowStorage"), exports);
 __exportStar(require("./DataTypes"), exports);

package/lib/cjs/types/DelayedExecutorType.d.ts

@@ -0,0 +1,17 @@
+export declare type DelayedExecutorType<P extends any[]> = {
+    /**
+     * Call the function
+     * @param miliseconds Delayed miliseconds for this call
+     * @param args Args
+     */
+    call(miliseconds?: number, ...args: P): void;
+    /**
+     * Clear
+     */
+    clear(): void;
+    /**
+     * Is running or not
+     * @returns Result
+     */
+    isRunning(): boolean;
+};

package/lib/cjs/types/DelayedExecutorType.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/mjs/ExtendUtils.d.ts

@@ -1,3 +1,4 @@
+import { DelayedExecutorType } from './types/DelayedExecutorType';
 /**
  * Extend utilities
  */
@@ -9,6 +10,13 @@ export declare namespace ExtendUtils {
      * @param baseCtors Mixin base classes
      */
     function applyMixins(derivedCtor: any, baseCtors: any[]): void;
+    /**
+     * Create delayed executor
+     * @param func Function
+     * @param delayMiliseconds Delay miliseconds
+     * @returns Result
+     */
+    function delayedExecutor<P extends any[]>(func: (...args: P) => void, delayMiliseconds: number): DelayedExecutorType<P>;
     /**
      * Promise handler to catch error
      * @param promise Promise

package/lib/mjs/ExtendUtils.js

@@ -20,6 +20,46 @@ export var ExtendUtils;
         });
     }
     ExtendUtils.applyMixins = applyMixins;
+    /**
+     * Create delayed executor
+     * @param func Function
+     * @param delayMiliseconds Delay miliseconds
+     * @returns Result
+     */
+    function delayedExecutor(func, delayMiliseconds) {
+        let seed = 0;
+        return {
+            /**
+             * Call the function
+             * @param miliseconds Delayed miliseconds for this call
+             * @param args Args
+             */
+            call(miliseconds, ...args) {
+                this.clear();
+                seed = window.setTimeout((...args) => {
+                    func(...args);
+                    seed = 0;
+                }, miliseconds !== null && miliseconds !== void 0 ? miliseconds : delayMiliseconds, ...args);
+            },
+            /**
+             * Clear
+             */
+            clear() {
+                if (this.isRunning()) {
+                    window.clearTimeout(seed);
+                    seed = 0;
+                }
+            },
+            /**
+             * Is running or not
+             * @returns Result
+             */
+            isRunning() {
+                return seed > 0;
+            }
+        };
+    }
+    ExtendUtils.delayedExecutor = delayedExecutor;
     /**
      * Promise handler to catch error
      * @param promise Promise

package/lib/mjs/index.d.ts

@@ -1,4 +1,5 @@
 export * from './types/FormData';
+export * from './types/DelayedExecutorType';
 export * from './storage/IStorage';
 export * from './storage/WindowStorage';
 export * from './DataTypes';

package/lib/mjs/index.js

@@ -1,4 +1,5 @@
 export * from './types/FormData';
+export * from './types/DelayedExecutorType';
 export * from './storage/IStorage';
 export * from './storage/WindowStorage';
 export * from './DataTypes';

package/lib/mjs/types/DelayedExecutorType.d.ts

@@ -0,0 +1,17 @@
+export declare type DelayedExecutorType<P extends any[]> = {
+    /**
+     * Call the function
+     * @param miliseconds Delayed miliseconds for this call
+     * @param args Args
+     */
+    call(miliseconds?: number, ...args: P): void;
+    /**
+     * Clear
+     */
+    clear(): void;
+    /**
+     * Is running or not
+     * @returns Result
+     */
+    isRunning(): boolean;
+};

package/lib/mjs/types/DelayedExecutorType.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.11",
+    "version": "1.1.14",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -54,13 +54,13 @@
     "homepage": "https://github.com/ETSOO/Shared#readme",
     "dependencies": {},
     "devDependencies": {
-        "@types/jest": "^27.4.0",
-        "@typescript-eslint/eslint-plugin": "^5.10.1",
-        "@typescript-eslint/parser": "^5.10.1",
-        "eslint": "^8.8.0",
+        "@types/jest": "^27.4.1",
+        "@typescript-eslint/eslint-plugin": "^5.12.1",
+        "@typescript-eslint/parser": "^5.12.1",
+        "eslint": "^8.10.0",
         "eslint-config-airbnb-base": "^15.0.0",
         "eslint-plugin-import": "^2.25.4",
-        "jest": "^27.4.7",
+        "jest": "^27.5.1",
         "ts-jest": "^27.1.3",
         "typescript": "^4.5.5"
     }

package/src/ExtendUtils.ts

@@ -1,3 +1,5 @@
+import { DelayedExecutorType } from './types/DelayedExecutorType';
+
 /**
  * Extend utilities
  */
@@ -19,6 +21,55 @@ export namespace ExtendUtils {
         });
     }
 
+    /**
+     * Create delayed executor
+     * @param func Function
+     * @param delayMiliseconds Delay miliseconds
+     * @returns Result
+     */
+    export function delayedExecutor<P extends any[]>(
+        func: (...args: P) => void,
+        delayMiliseconds: number
+    ): DelayedExecutorType<P> {
+        let seed: number = 0;
+        return {
+            /**
+             * Call the function
+             * @param miliseconds Delayed miliseconds for this call
+             * @param args Args
+             */
+            call(miliseconds?: number, ...args: P) {
+                this.clear();
+                seed = window.setTimeout(
+                    (...args: P) => {
+                        func(...args);
+                        seed = 0;
+                    },
+                    miliseconds ?? delayMiliseconds,
+                    ...args
+                );
+            },
+
+            /**
+             * Clear
+             */
+            clear() {
+                if (this.isRunning()) {
+                    window.clearTimeout(seed);
+                    seed = 0;
+                }
+            },
+
+            /**
+             * Is running or not
+             * @returns Result
+             */
+            isRunning() {
+                return seed > 0;
+            }
+        };
+    }
+
     /**
      * Promise handler to catch error
      * @param promise Promise

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from './types/FormData';
+export * from './types/DelayedExecutorType';
 
 export * from './storage/IStorage';
 export * from './storage/WindowStorage';

package/src/types/DelayedExecutorType.ts

@@ -0,0 +1,19 @@
+export type DelayedExecutorType<P extends any[]> = {
+    /**
+     * Call the function
+     * @param miliseconds Delayed miliseconds for this call
+     * @param args Args
+     */
+    call(miliseconds?: number, ...args: P): void;
+
+    /**
+     * Clear
+     */
+    clear(): void;
+
+    /**
+     * Is running or not
+     * @returns Result
+     */
+    isRunning(): boolean;
+};