time-queues 1.0.5 → 1.1.0

package/src/throttle.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Throttles a function by ensuring it is not called more often than the specified interval.
+ * The first call calls the function and starts a timeout. Until the timeout expires, any subsequent calls are ignored.
+ * This function is similar to `audit()`, but the first seen arguments are passed to the function.
+ *
+ * @param fn The function to throttle.
+ * @param ms The minimum time interval between function calls, in milliseconds.
+ * @returns A throttled version of the function.
+ */
+export declare function throttle(
+  fn: (...args: unknown[]) => void,
+  ms: number
+): (...args: unknown[]) => void;
+
+export default throttle;

package/src/throttle.js

@@ -0,0 +1,14 @@
+// @ts-self-types="./throttle.d.ts"
+
+'use strict';
+
+export const throttle = (fn, ms) => {
+  let handle = null;
+  return (...args) => {
+    if (handle) return;
+    handle = setTimeout(() => (handle = null), ms);
+    fn(...args);
+  };
+};
+
+export default throttle;

package/src/when-dom-loaded.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Adds a function to the list of functions to be called when the DOM is loaded.
+ * If the DOM is already loaded, the function is called immediately.
+ *
+ * @param fn The function to add.
+ */
+export declare function whenDomLoaded(fn: () => void): void;
+
+/**
+ * Removes a function from the list of functions to be called when the DOM is loaded.
+ *
+ * @param fn The function to remove.
+ * @returns `true` if the function was removed, `false` otherwise.
+ */
+export declare function remove(fn: () => void): boolean;
+
+export default whenDomLoaded;

package/src/when-dom-loaded.js

@@ -1,3 +1,5 @@
+// @ts-self-types="./when-dom-loaded.d.ts"
+
 'use strict';
 
 import ValueList from 'list-toolkit/value-list.js';
@@ -12,7 +14,7 @@ export const remove = fn => {
     }
   }
   return false;
-}
+};
 
 const handleDomLoaded = () => {
   while (!waitingForDom.isEmpty) waitingForDom.pop()();

package/src/when-loaded.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Adds a function to the list of functions to be called when the document is loaded.
+ * If the document is already loaded, the function is called immediately.
+ *
+ * @param fn The function to add.
+ */
+export declare function whenLoaded(fn: () => void): void;
+
+/**
+ * Removes a function from the list of functions to be called when the document is loaded.
+ *
+ * @param fn The function to remove.
+ * @returns `true` if the function was removed, `false` otherwise.
+ */
+export declare function remove(fn: () => void): boolean;
+
+export default whenLoaded;

package/src/when-loaded.js

@@ -1,3 +1,5 @@
+// @ts-self-types="./when-loaded.d.ts"
+
 'use strict';
 
 import ValueList from 'list-toolkit/value-list.js';
@@ -12,7 +14,7 @@ export const remove = fn => {
     }
   }
   return false;
-}
+};
 
 const handleLoaded = () => {
   while (!waitingForLoad.isEmpty) waitingForLoad.pop()();