@zukhruf/async 0.0.0-stage → 0.3.15

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ezzabuzaid
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,55 @@
-# Temporary Holding Version
+# @zukhruf/async
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Helpers for code that waits for promises: `untilAborted` cancels a wait, and `Latch` holds callers until something happened. `@zukhruf/mutex` and `@zukhruf/single-flight` use them.
+
+The words in these documents have one meaning each. See the glossary in [CONTEXT.md](./CONTEXT.md).
+
+## Cancel a wait
+
+A caller waits for a promise. The caller wants to stop the wait when a signal aborts, for example after a time limit, or when the user stops the program. `untilAborted` gives a promise that settles in the same way as the promise of the caller. When the signal aborts first, it rejects with the reason of the signal.
+
+```ts
+import { untilAborted } from '@zukhruf/async';
+
+const report = buildReport(); // The work. It does not take a signal.
+const value = await untilAborted(report, AbortSignal.timeout(5_000));
+```
+
+- When `report` settles first, `value` is its value, or the call rejects with its error.
+- When the 5 seconds end first, the call rejects with the reason of the signal: a `TimeoutError`.
+- When the signal aborted before the call, the call rejects at once.
+- When the signal is `undefined`, the call settles in the same way as `report`.
+
+## A cancel stops the wait, not the work
+
+`untilAborted` cannot stop the work. In the example, `buildReport` continues after the cancel. Thus a caller that cancels must deal with the work that continues. For example, a caller of `MemoryStore` that cancels keeps its place in the line, and its place passes the key on when its turn comes.
+
+To stop the work too, give the signal to the work, for example `fetch(url, { signal })`.
+
+## The wait ends also when another listener stops the event
+
+An `AbortSignal` is an `EventTarget`. A listener of the `abort` event can call `event.stopImmediatePropagation()`. Then the listeners that were added after it do not run. A caller often shares its signal with other code. Thus a wait that listens with `addEventListener` can stay pending after the abort.
+
+`untilAborted` listens through `events.addAbortListener` of Node.js. That listener runs also on a stopped event. See [ADR 0001](./docs/adr/0001-a-wait-listens-for-the-abort-through-addabortlistener.md).
+
+## No listener stays on the signal
+
+When the promise settles, `untilAborted` removes its listener. Thus many waits on one signal that lives long, for example a signal that stops a server, do not add listeners to it.
+
+## Wait until something happened, with a latch
+
+A latch starts closed. It opens once, with a value. A wait on a closed latch ends when the latch opens, and gets the value. A wait on an open latch ends at once, with the same value. A latch never closes again, and a second `open` changes nothing.
+
+```ts
+import { Latch } from '@zukhruf/async';
+
+const released = new Latch(); // Carries no value.
+const done = new Latch<string>(); // Carries a string.
+
+done.open('report');
+const value = await done.wait(); // 'report'
+```
+
+A latch never rejects. It keeps its value in a box, so it never adopts a promise, whatever its type. Thus a class can keep a latch in a field: the latch cannot fail before somebody awaits it. A latch whose type names a promise refuses one at compile time, because a wait would adopt the promise and could then reject. To share the outcome of work that can fail, give the latch a value that tells how the work ended, for example the `PromiseSettledResult` of `Promise.allSettled`. Each caller then throws the error for itself. See [ADR 0002](./docs/adr/0002-a-latch-carries-a-value-never-a-failure.md).
+
+To stop a wait on a latch, cancel it: `untilAborted(latch.wait(), signal)`.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { Latch } from './latch.ts';
+export { untilAborted } from './until-aborted.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { Latch } from "./latch.js";
+export { untilAborted } from "./until-aborted.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/latch.d.ts

@@ -0,0 +1,15 @@
+/**
+ * A gate that starts closed and opens once, with a value. It never closes
+ * again and never rejects, so a wait that starts after it opened ends at once
+ * with the same value.
+ */
+export declare class Latch<T = void> {
+    #private;
+    /**
+     * A later open changes nothing. A type that names a promise is refused: a
+     * wait would adopt the promise, and could then reject.
+     */
+    open(value: T extends PromiseLike<unknown> ? never : T): void;
+    wait(): Promise<T>;
+}
+//# sourceMappingURL=latch.d.ts.map

package/dist/latch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"latch.d.ts","sourceRoot":"","sources":["../src/latch.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,qBAAa,KAAK,CAAC,CAAC,GAAG,IAAI;;IAKzB;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,CAAC,SAAS,WAAW,CAAC,OAAO,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,IAAI;IAI7D,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC;CAGnB"}

package/dist/latch.js

@@ -0,0 +1,21 @@
+/**
+ * A gate that starts closed and opens once, with a value. It never closes
+ * again and never rejects, so a wait that starts after it opened ends at once
+ * with the same value.
+ */
+export class Latch {
+    /** Holds the value in a box, so it never adopts a promise and never rejects, whatever `T` is. */
+    // eslint-disable-next-line zukhruf/no-promise-field -- A latch never rejects and is never replaced, so no hazard of the rule applies; it is the primitive the rule recommends.
+    #opened = Promise.withResolvers();
+    /**
+     * A later open changes nothing. A type that names a promise is refused: a
+     * wait would adopt the promise, and could then reject.
+     */
+    open(value) {
+        this.#opened.resolve({ value });
+    }
+    wait() {
+        return this.#opened.promise.then(({ value }) => value);
+    }
+}
+//# sourceMappingURL=latch.js.map

package/dist/latch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"latch.js","sourceRoot":"","sources":["../src/latch.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,OAAO,KAAK;IAChB,iGAAiG;IACjG,+KAA+K;IACtK,OAAO,GAAG,OAAO,CAAC,aAAa,EAAgB,CAAC;IAEzD;;;OAGG;IACH,IAAI,CAAC,KAAiD;QACpD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAClC,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;CACF"}

package/dist/until-aborted.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Settles like `promise`, or rejects with `signal.reason` first if `signal` aborts.
+ * Listens through `addAbortListener`, so a listener that stops the abort event
+ * cannot leave the wait pending.
+ */
+export declare function untilAborted<T>(promise: Promise<T>, signal: AbortSignal | undefined): Promise<T>;
+//# sourceMappingURL=until-aborted.d.ts.map

package/dist/until-aborted.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"until-aborted.d.ts","sourceRoot":"","sources":["../src/until-aborted.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,MAAM,EAAE,WAAW,GAAG,SAAS,GAC9B,OAAO,CAAC,CAAC,CAAC,CAgBZ"}

package/dist/until-aborted.js

@@ -0,0 +1,22 @@
+import { addAbortListener } from 'node:events';
+/**
+ * Settles like `promise`, or rejects with `signal.reason` first if `signal` aborts.
+ * Listens through `addAbortListener`, so a listener that stops the abort event
+ * cannot leave the wait pending.
+ */
+export function untilAborted(promise, signal) {
+    if (!signal)
+        return promise;
+    return new Promise((resolve, reject) => {
+        // Also calls the listener when the signal aborted before the call.
+        const listening = addAbortListener(signal, () => reject(signal.reason));
+        promise.then((value) => {
+            listening[Symbol.dispose]();
+            resolve(value);
+        }, (error) => {
+            listening[Symbol.dispose]();
+            reject(error);
+        });
+    });
+}
+//# sourceMappingURL=until-aborted.js.map

package/dist/until-aborted.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"until-aborted.js","sourceRoot":"","sources":["../src/until-aborted.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAmB,EACnB,MAA+B;IAE/B,IAAI,CAAC,MAAM;QAAE,OAAO,OAAO,CAAC;IAC5B,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACxC,mEAAmE;QACnE,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QACxE,OAAO,CAAC,IAAI,CACV,CAAC,KAAK,EAAE,EAAE;YACR,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC,EACD,CAAC,KAAc,EAAE,EAAE;YACjB,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@zukhruf/async",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.3.15",
+  "description": "Helpers for code that waits for promises: cancel a wait when an AbortSignal aborts, and hold callers on a one-shot latch that never rejects.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/JanuaryLabs/zukhruf",
+    "directory": "packages/async"
+  },
+  "bugs": {
+    "url": "https://github.com/JanuaryLabs/zukhruf/issues"
+  },
+  "homepage": "https://github.com/JanuaryLabs/zukhruf/tree/main/packages/async#readme",
+  "keywords": [
+    "abort",
+    "abortsignal",
+    "abortable",
+    "promise",
+    "async",
+    "latch"
+  ],
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "@zukhruf/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/spec/**",
+    "!**/*.tsbuildinfo",
+    "!**/*.test.*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}