@reykjavik/webtools 0.2.4 → 0.2.5

package/CHANGELOG.md

@@ -4,6 +4,13 @@
 
 - ... <!-- Add new lines here. -->
 
+## 0.2.5
+
+_2025-05-21_
+
+- `@reykjavik/webtools/async`:
+  - feat: Support passing `AbortSignal` to `sleep` and `addLag` helpers
+
 ## 0.2.4
 
 _2025-05-09_
@@ -39,7 +46,7 @@ _2024-12-17_
 _2024-12-12_
 
 - feat: Add `@reykjavik/webtools/react-router/*` (previously `/remix/*`)
-- **BREAKING** feat: Remove all `@reykjavik/webtools/react-router/*` modules
+- **BREAKING** feat: Remove all `@reykjavik/webtools/remix/*` modules
 - **BREAKING** feat: Bump `pkg.engines.node` version to >=20
 - **BREAKING** feat: Remove `@reykjavik/webtools/next/SiteImprove` (deprecated
   module)

package/async.d.ts

@@ -4,12 +4,16 @@ type PlainObj = Record<string, unknown>;
  * Simple sleep function. Returns a promise that resolves after `length`
  * milliseconds.
  */
-export declare const sleep: (length: number) => Promise<void>;
+export declare const sleep: (length: number, opts?: {
+    signal?: AbortSignal;
+}) => Promise<void>;
 /**
  * Returns a function that adds lag/delay to a promise chain,
  * passing the promise payload through.
  */
-export declare const addLag: (length: number) => <T>(res: T) => Promise<T>;
+export declare const addLag: (length: number, opts?: {
+    signal?: AbortSignal;
+}) => <T>(res: T) => Promise<T>;
 /**
  * Resolves as soon as all of the passed `promises` have resolved/settled,
  * or after `timeout` milliseconds — whichever comes first.

package/async.js

@@ -7,14 +7,33 @@ exports.maxWait = maxWait;
  * milliseconds.
  */
 /*#__NO_SIDE_EFFECTS__*/
-const sleep = (length) => new Promise((resolve) => setTimeout(resolve, length));
+const sleep = (length, opts) => new Promise((resolve, reject) => {
+    const signal = opts && opts.signal;
+    if (!signal) {
+        return setTimeout(resolve, length);
+    }
+    if (signal.aborted) {
+        return reject(signal.reason);
+    }
+    const onAbort = () => {
+        // eslint-disable-next-line @typescript-eslint/no-use-before-define
+        clearTimeout(timer);
+        signal.removeEventListener('abort', onAbort);
+        reject(signal.reason);
+    };
+    signal.addEventListener('abort', onAbort);
+    const timer = setTimeout(() => {
+        signal.removeEventListener('abort', onAbort);
+        resolve();
+    }, length);
+});
 exports.sleep = sleep;
 /**
  * Returns a function that adds lag/delay to a promise chain,
  * passing the promise payload through.
  */
 /*#__NO_SIDE_EFFECTS__*/
-const addLag = (length) => (res) => (0, exports.sleep)(length).then(() => res);
+const addLag = (length, opts) => (res) => (0, exports.sleep)(length, opts).then(() => res);
 exports.addLag = addLag;
 /*#__NO_SIDE_EFFECTS__*/
 function maxWait(timeout, promises) {

package/esm/async.d.ts

@@ -4,12 +4,16 @@ type PlainObj = Record<string, unknown>;
  * Simple sleep function. Returns a promise that resolves after `length`
  * milliseconds.
  */
-export declare const sleep: (length: number) => Promise<void>;
+export declare const sleep: (length: number, opts?: {
+    signal?: AbortSignal;
+}) => Promise<void>;
 /**
  * Returns a function that adds lag/delay to a promise chain,
  * passing the promise payload through.
  */
-export declare const addLag: (length: number) => <T>(res: T) => Promise<T>;
+export declare const addLag: (length: number, opts?: {
+    signal?: AbortSignal;
+}) => <T>(res: T) => Promise<T>;
 /**
  * Resolves as soon as all of the passed `promises` have resolved/settled,
  * or after `timeout` milliseconds — whichever comes first.

package/esm/async.js

@@ -3,13 +3,32 @@
  * milliseconds.
  */
 /*#__NO_SIDE_EFFECTS__*/
-export const sleep = (length) => new Promise((resolve) => setTimeout(resolve, length));
+export const sleep = (length, opts) => new Promise((resolve, reject) => {
+    const signal = opts && opts.signal;
+    if (!signal) {
+        return setTimeout(resolve, length);
+    }
+    if (signal.aborted) {
+        return reject(signal.reason);
+    }
+    const onAbort = () => {
+        // eslint-disable-next-line @typescript-eslint/no-use-before-define
+        clearTimeout(timer);
+        signal.removeEventListener('abort', onAbort);
+        reject(signal.reason);
+    };
+    signal.addEventListener('abort', onAbort);
+    const timer = setTimeout(() => {
+        signal.removeEventListener('abort', onAbort);
+        resolve();
+    }, length);
+});
 /**
  * Returns a function that adds lag/delay to a promise chain,
  * passing the promise payload through.
  */
 /*#__NO_SIDE_EFFECTS__*/
-export const addLag = (length) => (res) => sleep(length).then(() => res);
+export const addLag = (length, opts) => (res) => sleep(length, opts).then(() => res);
 /*#__NO_SIDE_EFFECTS__*/
 export function maxWait(timeout, promises) {
     if (Array.isArray(promises)) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@reykjavik/webtools",
-	"version": "0.2.4",
+	"version": "0.2.5",
 	"description": "Misc. JS/TS helpers used by Reykjavík City's web dev teams.",
 	"main": "index.js",
 	"repository": "ssh://git@github.com:reykjavikcity/webtools.git",