@kikiutils/shared 18.0.0 → 18.0.1

package/dist/time.d.ts

@@ -1,4 +1,24 @@
 //#region src/time.d.ts
+/**
+ * Delays execution until the specified duration elapses or the signal is aborted.
+ *
+ * Aborting the signal resolves the promise normally without throwing.
+ *
+ * @param {number} ms - Delay duration in milliseconds
+ * @param {AbortSignal} [signal] - Optional signal used to end the delay early
+ *
+ * @returns {Promise<void>} Resolves when the delay completes or the signal is aborted
+ *
+ * @example
+ * ```typescript
+ * import { delay } from '@kikiutils/shared/time';
+ *
+ * const controller = new AbortController();
+ * setTimeout(() => controller.abort(), 1000);
+ * await delay(5000, controller.signal); // resolves after ~1s
+ * ```
+ */
+declare function delay(ms: number, signal?: AbortSignal): Promise<void>;
 /**
  * Delays execution until the specified duration elapses or the signal is aborted.
  *
@@ -20,5 +40,5 @@
  */
 declare function delayOrThrow(ms: number, signal?: AbortSignal): Promise<void>;
 //#endregion
-export { delayOrThrow };
+export { delay, delayOrThrow };
 //# sourceMappingURL=time.d.ts.map

package/dist/time.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"time.d.ts","names":[],"sources":["../src/time.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;iBAmBgB,aAAa,YAAY,SAAS,cAAc"}
+{"version":3,"file":"time.d.ts","names":[],"sources":["../src/time.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;iBAmBgB,MAAM,YAAY,SAAS,cAAc;;;;;;;;;;;;;;;;;;;;iBAsCzC,aAAa,YAAY,SAAS,cAAc"}

package/dist/time.js

@@ -2,6 +2,40 @@
 /**
 * Delays execution until the specified duration elapses or the signal is aborted.
 *
+* Aborting the signal resolves the promise normally without throwing.
+*
+* @param {number} ms - Delay duration in milliseconds
+* @param {AbortSignal} [signal] - Optional signal used to end the delay early
+*
+* @returns {Promise<void>} Resolves when the delay completes or the signal is aborted
+*
+* @example
+* ```typescript
+* import { delay } from '@kikiutils/shared/time';
+*
+* const controller = new AbortController();
+* setTimeout(() => controller.abort(), 1000);
+* await delay(5000, controller.signal); // resolves after ~1s
+* ```
+*/
+function delay(ms, signal) {
+	return new Promise((resolve) => {
+		if (signal?.aborted) {
+			resolve();
+			return;
+		}
+		const done = () => {
+			clearTimeout(timeout);
+			signal?.removeEventListener("abort", done);
+			resolve();
+		};
+		const timeout = setTimeout(done, ms);
+		signal?.addEventListener("abort", done, { once: true });
+	});
+}
+/**
+* Delays execution until the specified duration elapses or the signal is aborted.
+*
 * Aborting the signal rejects the promise with the signal's abort reason.
 *
 * @param {number} ms - Delay duration in milliseconds
@@ -36,6 +70,6 @@ function delayOrThrow(ms, signal) {
 	});
 }
 //#endregion
-export { delayOrThrow };
+export { delay, delayOrThrow };
 
 //# sourceMappingURL=time.js.map

package/dist/time.js.map

@@ -1 +1 @@
-{"version":3,"file":"time.js","names":[],"sources":["../src/time.ts"],"sourcesContent":["/**\n * Delays execution until the specified duration elapses or the signal is aborted.\n *\n * Aborting the signal rejects the promise with the signal's abort reason.\n *\n * @param {number} ms - Delay duration in milliseconds\n * @param {AbortSignal} [signal] - Optional signal used to abort the delay\n *\n * @returns {Promise<void>} Resolves when the delay completes or rejects when the signal is aborted\n *\n * @example\n * ```typescript\n * import { delayOrThrow } from '@kikiutils/shared/time';\n *\n * const controller = new AbortController();\n * setTimeout(() => controller.abort(), 1000);\n * await delayOrThrow(5000, controller.signal); // rejects after ~1s\n * ```\n */\nexport function delayOrThrow(ms: number, signal?: AbortSignal): Promise<void> {\n    return new Promise((resolve, reject) => {\n        if (signal?.aborted) {\n            reject(signal.reason);\n            return;\n        }\n\n        const onAbort = () => {\n            // eslint-disable-next-line ts/no-use-before-define\n            clearTimeout(timeout);\n            reject(signal!.reason);\n        };\n\n        const timeout = setTimeout(\n            () => {\n                signal?.removeEventListener('abort', onAbort);\n                resolve();\n            },\n            ms,\n        );\n\n        signal?.addEventListener('abort', onAbort, { once: true });\n    });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAmBA,SAAgB,aAAa,IAAY,QAAqC;CAC1E,OAAO,IAAI,SAAS,SAAS,WAAW;EACpC,IAAI,QAAQ,SAAS;GACjB,OAAO,OAAO,MAAM;GACpB;EACJ;EAEA,MAAM,gBAAgB;GAElB,aAAa,OAAO;GACpB,OAAO,OAAQ,MAAM;EACzB;EAEA,MAAM,UAAU,iBACN;GACF,QAAQ,oBAAoB,SAAS,OAAO;GAC5C,QAAQ;EACZ,GACA,EACJ;EAEA,QAAQ,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAK,CAAC;CAC7D,CAAC;AACL"}
+{"version":3,"file":"time.js","names":[],"sources":["../src/time.ts"],"sourcesContent":["/**\n * Delays execution until the specified duration elapses or the signal is aborted.\n *\n * Aborting the signal resolves the promise normally without throwing.\n *\n * @param {number} ms - Delay duration in milliseconds\n * @param {AbortSignal} [signal] - Optional signal used to end the delay early\n *\n * @returns {Promise<void>} Resolves when the delay completes or the signal is aborted\n *\n * @example\n * ```typescript\n * import { delay } from '@kikiutils/shared/time';\n *\n * const controller = new AbortController();\n * setTimeout(() => controller.abort(), 1000);\n * await delay(5000, controller.signal); // resolves after ~1s\n * ```\n */\nexport function delay(ms: number, signal?: AbortSignal): Promise<void> {\n    return new Promise((resolve) => {\n        if (signal?.aborted) {\n            resolve();\n            return;\n        }\n\n        const done = () => {\n            // eslint-disable-next-line ts/no-use-before-define\n            clearTimeout(timeout);\n            signal?.removeEventListener('abort', done);\n            resolve();\n        };\n\n        const timeout = setTimeout(done, ms);\n        signal?.addEventListener('abort', done, { once: true });\n    });\n}\n\n/**\n * Delays execution until the specified duration elapses or the signal is aborted.\n *\n * Aborting the signal rejects the promise with the signal's abort reason.\n *\n * @param {number} ms - Delay duration in milliseconds\n * @param {AbortSignal} [signal] - Optional signal used to abort the delay\n *\n * @returns {Promise<void>} Resolves when the delay completes or rejects when the signal is aborted\n *\n * @example\n * ```typescript\n * import { delayOrThrow } from '@kikiutils/shared/time';\n *\n * const controller = new AbortController();\n * setTimeout(() => controller.abort(), 1000);\n * await delayOrThrow(5000, controller.signal); // rejects after ~1s\n * ```\n */\nexport function delayOrThrow(ms: number, signal?: AbortSignal): Promise<void> {\n    return new Promise((resolve, reject) => {\n        if (signal?.aborted) {\n            reject(signal.reason);\n            return;\n        }\n\n        const onAbort = () => {\n            // eslint-disable-next-line ts/no-use-before-define\n            clearTimeout(timeout);\n            reject(signal!.reason);\n        };\n\n        const timeout = setTimeout(\n            () => {\n                signal?.removeEventListener('abort', onAbort);\n                resolve();\n            },\n            ms,\n        );\n\n        signal?.addEventListener('abort', onAbort, { once: true });\n    });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAmBA,SAAgB,MAAM,IAAY,QAAqC;CACnE,OAAO,IAAI,SAAS,YAAY;EAC5B,IAAI,QAAQ,SAAS;GACjB,QAAQ;GACR;EACJ;EAEA,MAAM,aAAa;GAEf,aAAa,OAAO;GACpB,QAAQ,oBAAoB,SAAS,IAAI;GACzC,QAAQ;EACZ;EAEA,MAAM,UAAU,WAAW,MAAM,EAAE;EACnC,QAAQ,iBAAiB,SAAS,MAAM,EAAE,MAAM,KAAK,CAAC;CAC1D,CAAC;AACL;;;;;;;;;;;;;;;;;;;;AAqBA,SAAgB,aAAa,IAAY,QAAqC;CAC1E,OAAO,IAAI,SAAS,SAAS,WAAW;EACpC,IAAI,QAAQ,SAAS;GACjB,OAAO,OAAO,MAAM;GACpB;EACJ;EAEA,MAAM,gBAAgB;GAElB,aAAa,OAAO;GACpB,OAAO,OAAQ,MAAM;EACzB;EAEA,MAAM,UAAU,iBACN;GACF,QAAQ,oBAAoB,SAAS,OAAO;GAC5C,QAAQ;EACZ,GACA,EACJ;EAEA,QAAQ,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAK,CAAC;CAC7D,CAAC;AACL"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kikiutils/shared",
   "type": "module",
-  "version": "18.0.0",
+  "version": "18.0.1",
   "description": "A lightweight and modular utility library for modern JavaScript and TypeScript — includes secure hashing, flexible logging, datetime tools, Vue/web helpers, storage abstraction, and more.",
   "author": "kiki-kanri",
   "license": "MIT",

package/src/time.ts

@@ -1,3 +1,41 @@
+/**
+ * Delays execution until the specified duration elapses or the signal is aborted.
+ *
+ * Aborting the signal resolves the promise normally without throwing.
+ *
+ * @param {number} ms - Delay duration in milliseconds
+ * @param {AbortSignal} [signal] - Optional signal used to end the delay early
+ *
+ * @returns {Promise<void>} Resolves when the delay completes or the signal is aborted
+ *
+ * @example
+ * ```typescript
+ * import { delay } from '@kikiutils/shared/time';
+ *
+ * const controller = new AbortController();
+ * setTimeout(() => controller.abort(), 1000);
+ * await delay(5000, controller.signal); // resolves after ~1s
+ * ```
+ */
+export function delay(ms: number, signal?: AbortSignal): Promise<void> {
+    return new Promise((resolve) => {
+        if (signal?.aborted) {
+            resolve();
+            return;
+        }
+
+        const done = () => {
+            // eslint-disable-next-line ts/no-use-before-define
+            clearTimeout(timeout);
+            signal?.removeEventListener('abort', done);
+            resolve();
+        };
+
+        const timeout = setTimeout(done, ms);
+        signal?.addEventListener('abort', done, { once: true });
+    });
+}
+
 /**
  * Delays execution until the specified duration elapses or the signal is aborted.
  *