@zukhruf/async 0.3.14 → 0.3.15

package/README.md

@@ -1,6 +1,6 @@
 # @zukhruf/async
 
-Helpers for code that waits for promises. The package has one function: `untilAborted`. `@zukhruf/mutex` and `@zukhruf/single-flight` use it.
+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).
 
@@ -35,3 +35,21 @@ An `AbortSignal` is an `EventTarget`. A listener of the `abort` event can call `
 ## 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

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

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC"}
+{"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

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

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC"}
+{"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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zukhruf/async",
-  "version": "0.3.14",
-  "description": "Stop a wait for a promise when an AbortSignal aborts, also when another listener stops the abort event, and leave no listener on the signal.",
+  "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",
@@ -17,7 +17,8 @@
     "abortsignal",
     "abortable",
     "promise",
-    "async"
+    "async",
+    "latch"
   ],
   "type": "module",
   "types": "./dist/index.d.ts",