kontroll 1.0.0 → 1.0.2

package/README.md

@@ -55,12 +55,13 @@ If a `options.key` is not present, key are taken as `callback.toString()`.
 <!-- Explaining the basic for sleep derived beginner :> -->
 If you call something like:
 ```js
-// * Case 1, (arrow) function with unchanged/variable-only body
+// // * Case 1, (arrow) function with unchanged/variable-only body
 debounce(1000, () => console.log(variable))
 
-// * Case 2, declared function
+
+// // * Case 2, declared function
 debounce(1000, makeDoSum(1, 2))
-// For declared function, input could be changed.
+// For declared function, it's parameter could be changed and still share the same key.
 debounce(1000, makeDoSum(2, 3))
 ```
 multiple times,  

package/dist/index.d.mts

@@ -1,10 +1,11 @@
 type Fn<T = void> = () => T;
 type FnWithArgs<T = void> = (...args: any) => T;
 interface KontrollStore {
-    [x: keyof any]: {
+    [x: PropertyKey]: {
         timer: ReturnType<typeof setTimeout>;
-        callback: Fn;
+        callback: Fn<any | Promise<any>>;
         trailing?: [FnWithArgs, ...any];
+        finishing?: boolean;
     };
 }
 declare function clear(callback: Fn): void;
@@ -48,7 +49,7 @@ interface KontrollCountdownOptions extends KontrollBaseOptions {
  * // Result: 2
  * ```
  */
-declare function countdown(ms: number, callback: Fn, options?: KontrollCountdownOptions): KontrollClearer;
+declare function countdown(ms: number, callback: Fn, { key, replace }?: KontrollCountdownOptions): KontrollClearer;
 interface KontrollDebounceOptions extends KontrollBaseOptions {
     /**
      * Avoiding initial wait for first call
@@ -83,7 +84,7 @@ interface KontrollDebounceOptions extends KontrollBaseOptions {
  * // Result: 3
  * ```
  */
-declare function debounce(ms: number, callback: Fn, options?: KontrollDebounceOptions): KontrollClearer;
+declare function debounce(ms: number, callback: Fn, { key, leading }?: KontrollDebounceOptions): KontrollClearer;
 interface KontrollThrottleOptions extends KontrollBaseOptions {
     /**
      * Perform additional execution with last received arguments
@@ -124,6 +125,6 @@ interface KontrollThrottleOptions extends KontrollBaseOptions {
  * ```
  *
  */
-declare function throttle(ms: number, callback: Fn, options?: KontrollThrottleOptions): KontrollClearer;
+declare function throttle(ms: number, callback: Fn, { key, trailing }?: KontrollThrottleOptions): KontrollClearer;
 
 export { type KontrollBaseOptions, type KontrollClearer, type KontrollCountdownOptions, type KontrollDebounceOptions, type KontrollStore, type KontrollThrottleOptions, clear, countdown, debounce, throttle };

package/dist/index.d.ts

@@ -1,10 +1,11 @@
 type Fn<T = void> = () => T;
 type FnWithArgs<T = void> = (...args: any) => T;
 interface KontrollStore {
-    [x: keyof any]: {
+    [x: PropertyKey]: {
         timer: ReturnType<typeof setTimeout>;
-        callback: Fn;
+        callback: Fn<any | Promise<any>>;
         trailing?: [FnWithArgs, ...any];
+        finishing?: boolean;
     };
 }
 declare function clear(callback: Fn): void;
@@ -48,7 +49,7 @@ interface KontrollCountdownOptions extends KontrollBaseOptions {
  * // Result: 2
  * ```
  */
-declare function countdown(ms: number, callback: Fn, options?: KontrollCountdownOptions): KontrollClearer;
+declare function countdown(ms: number, callback: Fn, { key, replace }?: KontrollCountdownOptions): KontrollClearer;
 interface KontrollDebounceOptions extends KontrollBaseOptions {
     /**
      * Avoiding initial wait for first call
@@ -83,7 +84,7 @@ interface KontrollDebounceOptions extends KontrollBaseOptions {
  * // Result: 3
  * ```
  */
-declare function debounce(ms: number, callback: Fn, options?: KontrollDebounceOptions): KontrollClearer;
+declare function debounce(ms: number, callback: Fn, { key, leading }?: KontrollDebounceOptions): KontrollClearer;
 interface KontrollThrottleOptions extends KontrollBaseOptions {
     /**
      * Perform additional execution with last received arguments
@@ -124,6 +125,6 @@ interface KontrollThrottleOptions extends KontrollBaseOptions {
  * ```
  *
  */
-declare function throttle(ms: number, callback: Fn, options?: KontrollThrottleOptions): KontrollClearer;
+declare function throttle(ms: number, callback: Fn, { key, trailing }?: KontrollThrottleOptions): KontrollClearer;
 
 export { type KontrollBaseOptions, type KontrollClearer, type KontrollCountdownOptions, type KontrollDebounceOptions, type KontrollStore, type KontrollThrottleOptions, clear, countdown, debounce, throttle };

package/dist/index.mjs

@@ -1 +1 @@
-const i={};function o(n){const t=typeof n=="function"?n.toString():n;i[t]&&(clearTimeout(i[t].timer),delete i[t])}async function f(n){if(i[n]){const t=i[n].trailing;await i[n].callback(),o(n),t&&t[0](...t.slice(1))}}function l(n){return()=>{o(n)}}function u(n,t,c){const e=setTimeout(()=>{f(n)},t);return i[n]={timer:e,callback:c},l(n)}function s(n,t,c={}){const{key:e=t.toString(),replace:r=!1}=c;return i[e]?(r&&(i[e].callback=t),l(e)):u(e,n,t)}function g(n,t,c={}){const{key:e=t.toString(),leading:r=!1}=c;if(i[e])o(e);else if(r)return a(n,t,{key:e});return u(e,n,t)}function a(n,t,c={}){const{key:e=t.toString(),trailing:r=!1}=c;return i[e]?(r&&(i[e].trailing=[a,n,t,c]),l(e)):(t(),u(e,n,()=>{}))}export{o as clear,s as countdown,g as debounce,a as throttle};
+const e={};function c(i){const t=typeof i=="function"?i.toString():i;e[t]&&(clearTimeout(e[t].timer),delete e[t])}function u(i){return()=>{c(i)}}async function a(i){if(e[i]){e[i].finishing=!0;const t=e[i].trailing;await e[i].callback(),c(i),t&&t[0](...t.slice(1))}}function l(i,t,n){if(e[n]?.finishing)return u(n);const r=setTimeout(()=>{a(n)},i);return e[n]={timer:r,callback:t},u(n)}function g(i,t,{key:n=t.toString(),replace:r}={}){return e[n]?(r&&(e[n].callback=t),u(n)):l(i,t,n)}function s(i,t,{key:n=t.toString(),leading:r}={}){if(e[n]&&!e[n].finishing)c(n);else if(r)return f(i,t,{key:n});return l(i,t,n)}function f(i,t,{key:n=t.toString(),trailing:r}={}){return e[n]?(r&&(e[n].trailing=[f,i,t,{key:n}]),u(n)):(t(),l(i,()=>{},n))}export{c as clear,g as countdown,s as debounce,f as throttle};

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "kontroll",
   "type": "module",
-  "version": "1.0.0",
-  "packageManager": "pnpm@8.14.1",
+  "version": "1.0.2",
+  "packageManager": "pnpm@9.6.0",
   "description": "kontroll (\"control\") is a tiny, dead-simple package for function behavior controls like debounce, countdown, throttle (limit).",
   "author": "NamesMT <dangquoctrung123@gmail.com>",
   "license": "MIT",
@@ -58,17 +58,16 @@
     "prepublishOnly": "pnpm run build"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^2.6.3",
-    "@types/node": "^20.11.5",
-    "@unocss/eslint-plugin": "^0.58.3",
-    "@vitest/coverage-v8": "^1.2.1",
-    "eslint": "^8.56.0",
-    "lint-staged": "^15.2.0",
-    "simple-git-hooks": "^2.9.0",
-    "tsx": "^4.7.0",
-    "typescript": "^5.3.3",
+    "@antfu/eslint-config": "^2.24.0",
+    "@types/node": "^20.14.13",
+    "@vitest/coverage-v8": "^2.0.5",
+    "eslint": "^9.8.0",
+    "lint-staged": "^15.2.7",
+    "simple-git-hooks": "^2.11.1",
+    "tsx": "^4.16.3",
+    "typescript": "^5.5.4",
     "unbuild": "^2.0.0",
-    "vitest": "^1.2.1"
+    "vitest": "^2.0.5"
   },
   "pnpm": {
     "overrides": {