@sohanemon/utils 5.0.8 → 5.1.0

package/dist/functions/shield.js

@@ -9,6 +9,7 @@ export function shield(operation) {
         return [null, data];
     }
     catch (error) {
+        console.log(`\x1b[31m🛡 [shield]\x1b[0m ${operation.name} failed →`, error);
         return [error, null];
     }
 }

package/dist/functions/utils.d.ts

@@ -86,10 +86,13 @@ export declare const svgToBase64: (str: string) => string;
 /**
  * Pauses execution for the specified time.
  *
+ * `signal` allows cancelling the sleep via AbortSignal.
+ *
  * @param time - Time in milliseconds to sleep (default is 1000ms)
- * @returns - A Promise that resolves after the specified time
+ * @param signal - Optional AbortSignal to cancel the sleep early
+ * @returns - A Promise that resolves after the specified time or when aborted
  */
-export declare const sleep: (time?: number) => Promise<unknown>;
+export declare const sleep: (time?: number, signal?: AbortSignal) => Promise<void>;
 type DebouncedFunction<F extends (...args: any[]) => any> = {
     (...args: Parameters<F>): ReturnType<F> | undefined;
     readonly isPending: boolean;

package/dist/functions/utils.js

@@ -158,10 +158,32 @@ export const svgToBase64 = (str) => isSSR ? Buffer.from(str).toString('base64')
 /**
  * Pauses execution for the specified time.
  *
+ * `signal` allows cancelling the sleep via AbortSignal.
+ *
  * @param time - Time in milliseconds to sleep (default is 1000ms)
- * @returns - A Promise that resolves after the specified time
+ * @param signal - Optional AbortSignal to cancel the sleep early
+ * @returns - A Promise that resolves after the specified time or when aborted
  */
-export const sleep = (time = 1000) => new Promise((resolve) => setTimeout(resolve, time));
+export const sleep = (time = 1000, signal) => new Promise((resolve) => {
+    if (signal?.aborted)
+        return resolve();
+    const id = setTimeout(() => {
+        cleanup();
+        resolve();
+    }, time);
+    function onAbort() {
+        clearTimeout(id);
+        cleanup();
+        resolve();
+    }
+    function cleanup() {
+        signal?.removeEventListener('abort', onAbort);
+    }
+    // only add listener if a signal was supplied
+    if (signal) {
+        signal.addEventListener('abort', onAbort, { once: true });
+    }
+});
 /**
  * Creates a debounced function that delays invoking the provided function until
  * after the specified `wait` time has elapsed since the last invocation.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sohanemon/utils",
-  "version": "5.0.8",
+  "version": "5.1.0",
   "author": "Sohan Emon <sohanemon@outlook.com>",
   "description": "",
   "type": "module",