@canonical/utils 0.9.0-experimental.9 → 0.9.0

package/dist/esm/debounce.js

@@ -5,22 +5,26 @@
  * @template F The type of the function to debounce
  * @param fn - The function to debounce.
  * @param delay - The time in milliseconds to wait before calling the function after the last call.
- * @returns A debounced version of the function that returns a promise.
+ * @returns A debounced version of the function that returns a promise and has a cancel method.
  *
  * @example
  * // Example usage of the debounce function
  * const debouncedFetchData = debounce(async (query: string) => {
- *   const response = await fetch(`/api/search?q=${query}`);
- *   return response.json();
+ * const response = await fetch(`/api/search?q=${query}`);
+ * return response.json();
  * }, 300);
  *
  * // Calling the debounced function multiple times
  * debouncedFetchData("hello").then(console.log); // Will only call fetch once after 300ms delay
  * debouncedFetchData("world").then(console.log); // Will cancel the previous call and make a new one
+ *
+ * // To cancel the debounced call before it executes
+ * const promise = debouncedFetchData("to be cancelled");
+ * promise.cancel();
  */
 export default function debounce(fn, delay) {
     let timeoutId = null;
-    return (...args) => {
+    const debounceExec = (...args) => {
         // Timer already exists, clear it. This way we avoid resolving more than once.
         if (timeoutId) {
             clearTimeout(timeoutId);
@@ -29,7 +33,8 @@ export default function debounce(fn, delay) {
             timeoutId = setTimeout(async () => {
                 // Timer hasn't been cancelled, call the function
                 try {
-                    resolve(fn(...args));
+                    const result = await fn(...args);
+                    resolve(result);
                 }
                 catch (error) {
                     reject(error);
@@ -37,5 +42,13 @@ export default function debounce(fn, delay) {
             }, delay);
         });
     };
+    // Clear the timeout and reject the promise
+    debounceExec.cancel = () => {
+        if (timeoutId) {
+            clearTimeout(timeoutId);
+            timeoutId = null;
+        }
+    };
+    return debounceExec;
 }
 //# sourceMappingURL=debounce.js.map

package/dist/esm/debounce.js.map

@@ -1 +1 @@
-{"version":3,"file":"debounce.js","sourceRoot":"","sources":["../../src/debounce.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAE9B,EAAK,EAAE,KAAa;IACpB,IAAI,SAAS,GAAyC,IAAI,CAAC;IAE3D,OAAO,CAAC,GAAG,IAAmB,EAA0B,EAAE;QACxD,8EAA8E;QAC9E,IAAI,SAAS,EAAE,CAAC;YACd,YAAY,CAAC,SAAS,CAAC,CAAC;QAC1B,CAAC;QAED,OAAO,IAAI,OAAO,CAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpD,SAAS,GAAG,UAAU,CAAC,KAAK,IAAI,EAAE;gBAChC,iDAAiD;gBACjD,IAAI,CAAC;oBACH,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;gBACvB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,KAAK,CAAC,CAAC;gBAChB,CAAC;YACH,CAAC,EAAE,KAAK,CAAC,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"debounce.js","sourceRoot":"","sources":["../../src/debounce.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAG9B,EAAK,EACL,KAAa;IAIb,IAAI,SAAS,GAAyC,IAAI,CAAC;IAE3D,MAAM,YAAY,GAAG,CAAC,GAAG,IAAmB,EAA0B,EAAE;QACtE,8EAA8E;QAC9E,IAAI,SAAS,EAAE,CAAC;YACd,YAAY,CAAC,SAAS,CAAC,CAAC;QAC1B,CAAC;QAED,OAAO,IAAI,OAAO,CAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpD,SAAS,GAAG,UAAU,CAAC,KAAK,IAAI,EAAE;gBAChC,iDAAiD;gBACjD,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;oBACjC,OAAO,CAAC,MAAM,CAAC,CAAC;gBAClB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,KAAK,CAAC,CAAC;gBAChB,CAAC;YACH,CAAC,EAAE,KAAK,CAAC,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,2CAA2C;IAC3C,YAAY,CAAC,MAAM,GAAG,GAAG,EAAE;QACzB,IAAI,SAAS,EAAE,CAAC;YACd,YAAY,CAAC,SAAS,CAAC,CAAC;YACxB,SAAS,GAAG,IAAI,CAAC;QACnB,CAAC;IACH,CAAC,CAAC;IAEF,OAAO,YAAY,CAAC;AACtB,CAAC"}

package/dist/types/debounce.d.ts

@@ -5,18 +5,24 @@
  * @template F The type of the function to debounce
  * @param fn - The function to debounce.
  * @param delay - The time in milliseconds to wait before calling the function after the last call.
- * @returns A debounced version of the function that returns a promise.
+ * @returns A debounced version of the function that returns a promise and has a cancel method.
  *
  * @example
  * // Example usage of the debounce function
  * const debouncedFetchData = debounce(async (query: string) => {
- *   const response = await fetch(`/api/search?q=${query}`);
- *   return response.json();
+ * const response = await fetch(`/api/search?q=${query}`);
+ * return response.json();
  * }, 300);
  *
  * // Calling the debounced function multiple times
  * debouncedFetchData("hello").then(console.log); // Will only call fetch once after 300ms delay
  * debouncedFetchData("world").then(console.log); // Will cancel the previous call and make a new one
+ *
+ * // To cancel the debounced call before it executes
+ * const promise = debouncedFetchData("to be cancelled");
+ * promise.cancel();
  */
-export default function debounce<F extends (...args: Parameters<F>) => ReturnType<F>>(fn: F, delay: number): (...args: Parameters<F>) => Promise<ReturnType<F>>;
+export default function debounce<F extends (...args: Parameters<F>) => ReturnType<F>>(fn: F, delay: number): ((...args: Parameters<F>) => Promise<ReturnType<F>>) & {
+    cancel: () => void;
+};
 //# sourceMappingURL=debounce.d.ts.map

package/dist/types/debounce.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"debounce.d.ts","sourceRoot":"","sources":["../../src/debounce.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,EACnD,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAoB1E"}
+{"version":3,"file":"debounce.d.ts","sourceRoot":"","sources":["../../src/debounce.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,EAEnD,EAAE,EAAE,CAAC,EACL,KAAK,EAAE,MAAM,GACZ,CAAC,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;IACxD,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB,CA+BA"}

package/dist/types/invariant.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invariant.d.ts","sourceRoot":"","sources":["../../src/invariant.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;oCAEU,OAAO,YACR,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,sBAEhC,QAAQ,SAAS;AAJpB,wBASE"}
+{"version":3,"file":"invariant.d.ts","sourceRoot":"","sources":["../../src/invariant.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;yBAED,WAAW,OAAO,EAClB,UAAU,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,EACjC,eAA8B,KAC7B,QAAQ,SAAS;AAJpB,wBASE"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@canonical/utils",
   "description": "Standard utility functions for Canonical's Web Engineering team",
-  "version": "0.9.0-experimental.9",
+  "version": "0.9.0",
   "type": "module",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -30,7 +30,8 @@
   "homepage": "https://github.com/canonical/ds25#readme",
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
-    "check": "bun run check:biome && bun run check:ts",
+    "build:all": "tsc -p tsconfig.build.json",
+    "check": "bun run check:biome",
     "check:fix": "bun run check:biome:fix && bun run check:ts",
     "check:biome": "biome check",
     "check:biome:fix": "biome check --write",
@@ -38,9 +39,9 @@
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
-    "@canonical/biome-config": "^0.9.0-experimental.2",
-    "@canonical/typescript-config-base": "^0.9.0-experimental.2",
-    "typescript": "^5.7.2"
+    "@canonical/biome-config": "^0.9.0",
+    "@canonical/typescript-config-base": "^0.9.0",
+    "typescript": "^5.8.3"
   },
-  "gitHead": "7bf4f96bcb2e435a1d5a49df9551244b9c1ab3cb"
+  "gitHead": "59f31f7d58a1794d36dae3cf99691b6eeb3f4042"
 }