umaki 0.2.6 → 0.3.1

package/README.md

@@ -26,6 +26,9 @@ import { foo } from 'umaki'
 - [Convert](#convert)
   - [changeDateStringToSpecificFormat](#changedatestringtospecificformat)
   - [jsonStringToJsonObject](#jsonstringtojsonobject)
+- [EventControl](#eventcontrol)
+  - [debounce](#debounce)
+  - [throttle](#throttle)
 - [Get](#get)
   - [getAspectRatio](#getaspectratio)
   - [getClassNames](#getclassnames)
@@ -129,6 +132,9 @@ import { videoPlayControl } from 'umaki'
 const videoElement = document.getElementById('myVideo')
 videoPlayControl(videoElement, true) // play
 videoPlayControl(videoElement, false) // pause
+
+// set currentTime
+videoPlayControl(videoElement, true, 10) // play and set currentTime to 10
 ```
 
 [View file →](src/libs/control/videoPlayControl.ts)
@@ -163,6 +169,40 @@ console.log(jsonObject) // { name: 'John', age: 30 }
 
 [View file →](src/libs/convert/jsonStringToJsonObject.ts)
 
+## EventControl
+
+### debounce
+
+A function that limits the number of times a function is called to at most one time over a specified time period.
+
+```ts
+import { debounce } from 'umaki'
+
+const debouncedFunction = debounce(() => {
+  console.log('Debounced!')
+}, 300)
+
+window.addEventListener('resize', debouncedFunction)
+```
+
+[View file →](src/libs/eventControl/debounce.ts)
+
+### throttle
+
+A function that limits the number of times a function is called to a maximum of once in a specified period.
+
+```ts
+import { throttle } from 'umaki'
+
+const throttledFunction = throttle(() => {
+  console.log('Throttled!')
+}, 300)
+
+window.addEventListener('scroll', throttledFunction)
+```
+
+[View file →](src/libs/eventControl/throttle.ts)
+
 ## Get
 
 ### getAspectRatio
@@ -681,7 +721,7 @@ import { sleep } from 'umaki'
 
 ;(async () => {
   console.log('Start')
-  await sleep(1) // 1ms wait
+  await sleep(1) // 1s wait
   console.log('End')
 })()
 ```

package/dist/_virtual/_commonjsHelpers.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/_virtual/_commonjsHelpers.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/_virtual/isBetween.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/_virtual/isBetween.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/index.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki
@@ -17,6 +17,8 @@ const scrollToHash = require("./libs/control/scrollToHash.cjs.js");
 const videoPlayControl = require("./libs/control/videoPlayControl.cjs.js");
 const changeDateStringToSpecificFormat = require("./libs/convert/changeDateStringToSpecificFormat.cjs.js");
 const jsonStringToJsonObject = require("./libs/convert/jsonStringToJsonObject.cjs.js");
+const debounce = require("./libs/eventControl/debounce.cjs.js");
+const throttle = require("./libs/eventControl/throttle.cjs.js");
 const getAspectRatio = require("./libs/get/getAspectRatio.cjs.js");
 const getClassNames = require("./libs/get/getClassNames.cjs.js");
 const getDocumentHeight = require("./libs/get/getDocumentHeight.cjs.js");
@@ -60,6 +62,8 @@ exports.scrollToHash = scrollToHash.scrollToHash;
 exports.videoPlayControl = videoPlayControl.videoPlayControl;
 exports.changeDateStringToSpecificFormat = changeDateStringToSpecificFormat.changeDateStringToSpecificFormat;
 exports.jsonStringToJsonObject = jsonStringToJsonObject.jsonStringToJsonObject;
+exports.debounce = debounce.debounce;
+exports.throttle = throttle.throttle;
 exports.getAspectRatio = getAspectRatio.getAspectRatio;
 exports.getClassNames = getClassNames.getClassNames;
 exports.getDocumentHeight = getDocumentHeight.getDocumentHeight;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './libs/control';
 export * from './libs/convert';
+export * from './libs/eventControl';
 export * from './libs/get';
 export * from './libs/is';
 export * from './libs/remove';

package/dist/index.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki
@@ -15,6 +15,8 @@ import { scrollToHash } from "./libs/control/scrollToHash.es.js";
 import { videoPlayControl } from "./libs/control/videoPlayControl.es.js";
 import { changeDateStringToSpecificFormat } from "./libs/convert/changeDateStringToSpecificFormat.es.js";
 import { jsonStringToJsonObject } from "./libs/convert/jsonStringToJsonObject.es.js";
+import { debounce } from "./libs/eventControl/debounce.es.js";
+import { throttle } from "./libs/eventControl/throttle.es.js";
 import { getAspectRatio } from "./libs/get/getAspectRatio.es.js";
 import { getClassNames } from "./libs/get/getClassNames.es.js";
 import { getDocumentHeight } from "./libs/get/getDocumentHeight.es.js";
@@ -55,6 +57,7 @@ import { waitForAllMediaLoaded } from "./libs/wait/waitForAllMediaLoaded.es.js";
 export {
   bgScrollStop,
   changeDateStringToSpecificFormat,
+  debounce,
   getAspectRatio,
   getClassNames,
   getDocumentHeight,
@@ -91,6 +94,7 @@ export {
   setSessionStorage,
   setStylePropertyValue,
   sleep,
+  throttle,
   toBoolean,
   toPositiveNumber,
   videoPlayControl,

package/dist/libs/control/bgScrollStop.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/control/bgScrollStop.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/control/pd.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/control/pd.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/control/scrollToHash.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/control/scrollToHash.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/control/videoPlayControl.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki
@@ -12,7 +12,7 @@
  */
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const toBoolean = require("../to/toBoolean.cjs.js");
-const videoPlayControl = async (videoElement, state) => {
+const videoPlayControl = async (videoElement, state, currentTime) => {
   if (state && videoElement.paused) {
     const isPlaying = toBoolean.toBoolean(videoElement.dataset.playing);
     if (isPlaying) return;
@@ -20,7 +20,7 @@ const videoPlayControl = async (videoElement, state) => {
     if (playPromise === void 0) return;
     try {
       await playPromise;
-      videoElement.currentTime = 0;
+      videoElement.currentTime = currentTime || 0;
       videoElement.dataset.playing = "true";
     } catch (error) {
     }

package/dist/libs/control/videoPlayControl.d.ts

@@ -11,4 +11,4 @@
  * the video. The function also manages a custom `data-playing` attribute on the video element
  * to track the playback state.
  */
-export declare const videoPlayControl: (videoElement: HTMLVideoElement, state: boolean) => Promise<void>;
+export declare const videoPlayControl: (videoElement: HTMLVideoElement, state: boolean, currentTime?: number) => Promise<void>;

package/dist/libs/control/videoPlayControl.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki
@@ -10,7 +10,7 @@
  * For license information, please see LICENSE.txt
  */
 import { toBoolean } from "../to/toBoolean.es.js";
-const videoPlayControl = async (videoElement, state) => {
+const videoPlayControl = async (videoElement, state, currentTime) => {
   if (state && videoElement.paused) {
     const isPlaying = toBoolean(videoElement.dataset.playing);
     if (isPlaying) return;
@@ -18,7 +18,7 @@ const videoPlayControl = async (videoElement, state) => {
     if (playPromise === void 0) return;
     try {
       await playPromise;
-      videoElement.currentTime = 0;
+      videoElement.currentTime = currentTime || 0;
       videoElement.dataset.playing = "true";
     } catch (error) {
     }

package/dist/libs/convert/changeDateStringToSpecificFormat.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/convert/changeDateStringToSpecificFormat.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/convert/jsonStringToJsonObject.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/convert/jsonStringToJsonObject.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/eventControl/debounce.cjs.js

@@ -0,0 +1,24 @@
+"use strict";
+/*!
+ * name: umaki
+ * version: v0.3.1
+ * description: A utility that is often used in web production.
+ * author: TsubasaHiga
+ * homepage: https://github.com/TsubasaHiga/umaki
+ * Released under the MIT License
+ *
+ * This software includes dependencies licensed under MIT, ISC, BSD-3-Clause, and Apache-2.0.
+ * For license information, please see LICENSE.txt
+ */
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const debounce = (fn, delay) => {
+  let timeoutId = null;
+  return (...args) => {
+    timeoutId && clearTimeout(timeoutId);
+    timeoutId = setTimeout(() => {
+      fn(...args);
+      timeoutId = null;
+    }, delay);
+  };
+};
+exports.debounce = debounce;

package/dist/libs/eventControl/debounce.d.ts

@@ -0,0 +1,11 @@
+type DebounceProcedure = (...args: unknown[]) => void;
+/**
+ * Creates a debounced function that delays invoking the provided function until after the specified delay.
+ *
+ * @template F - The type of the function to debounce.
+ * @param {F} fn - The function to debounce.
+ * @param {number} delay - The number of milliseconds to delay.
+ * @returns {(...args: Parameters<F>) => void} - A debounced version of the provided function.
+ */
+export declare const debounce: <F extends DebounceProcedure>(fn: F, delay: number) => ((...args: Parameters<F>) => void);
+export {};

package/dist/libs/eventControl/debounce.es.js

@@ -0,0 +1,24 @@
+/*!
+ * name: umaki
+ * version: v0.3.1
+ * description: A utility that is often used in web production.
+ * author: TsubasaHiga
+ * homepage: https://github.com/TsubasaHiga/umaki
+ * Released under the MIT License
+ *
+ * This software includes dependencies licensed under MIT, ISC, BSD-3-Clause, and Apache-2.0.
+ * For license information, please see LICENSE.txt
+ */
+const debounce = (fn, delay) => {
+  let timeoutId = null;
+  return (...args) => {
+    timeoutId && clearTimeout(timeoutId);
+    timeoutId = setTimeout(() => {
+      fn(...args);
+      timeoutId = null;
+    }, delay);
+  };
+};
+export {
+  debounce
+};

package/dist/libs/eventControl/debounce.test.d.ts

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

package/dist/libs/eventControl/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * eventControl functions
+ */
+export { debounce } from './debounce';
+export { throttle } from './throttle';

package/dist/libs/eventControl/throttle.cjs.js

@@ -0,0 +1,24 @@
+"use strict";
+/*!
+ * name: umaki
+ * version: v0.3.1
+ * description: A utility that is often used in web production.
+ * author: TsubasaHiga
+ * homepage: https://github.com/TsubasaHiga/umaki
+ * Released under the MIT License
+ *
+ * This software includes dependencies licensed under MIT, ISC, BSD-3-Clause, and Apache-2.0.
+ * For license information, please see LICENSE.txt
+ */
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const throttle = (fn, wait) => {
+  let lastCallTime = 0;
+  return (...args) => {
+    const currentTime = Date.now();
+    if (currentTime - lastCallTime >= wait) {
+      fn(...args);
+      lastCallTime = currentTime;
+    }
+  };
+};
+exports.throttle = throttle;

package/dist/libs/eventControl/throttle.d.ts

@@ -0,0 +1,12 @@
+type ThrottleFunction = (...args: unknown[]) => void;
+/**
+ * Creates a throttled version of the provided function that will only execute
+ * at most once in the specified wait period.
+ *
+ * @template F - The type of the function to be throttled.
+ * @param fn - The function to throttle.
+ * @param wait - The number of milliseconds to wait before allowing the next execution.
+ * @returns A throttled version of the provided function.
+ */
+export declare const throttle: <F extends ThrottleFunction>(fn: F, wait: number) => ((...args: Parameters<F>) => void);
+export {};

package/dist/libs/eventControl/throttle.es.js

@@ -0,0 +1,24 @@
+/*!
+ * name: umaki
+ * version: v0.3.1
+ * description: A utility that is often used in web production.
+ * author: TsubasaHiga
+ * homepage: https://github.com/TsubasaHiga/umaki
+ * Released under the MIT License
+ *
+ * This software includes dependencies licensed under MIT, ISC, BSD-3-Clause, and Apache-2.0.
+ * For license information, please see LICENSE.txt
+ */
+const throttle = (fn, wait) => {
+  let lastCallTime = 0;
+  return (...args) => {
+    const currentTime = Date.now();
+    if (currentTime - lastCallTime >= wait) {
+      fn(...args);
+      lastCallTime = currentTime;
+    }
+  };
+};
+export {
+  throttle
+};

package/dist/libs/eventControl/throttle.test.d.ts

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

package/dist/libs/get/getAspectRatio.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getAspectRatio.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getClassNames.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getClassNames.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getDocumentHeight.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getDocumentHeight.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getEventPaths.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getEventPaths.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getGcd.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getGcd.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getOrientation.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getOrientation.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getParentList.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getParentList.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getQueryParams.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getQueryParams.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getRem.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getRem.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.2.6
+ * version: v0.3.1
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki