@thi.ng/fibers 0.5.10 → 0.6.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-10-30T14:31:56Z
+- **Last updated**: 2023-11-09T10:28:18Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,16 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [0.6.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/fibers@0.6.0) (2023-11-09)
+
+#### 🚀 Features
+
+- add Fiber.promise() ([4861d95](https://github.com/thi-ng/umbrella/commit/4861d95))
+
+#### ♻️ Refactoring
+
+- update all tests (packages A-S) ([e3085e4](https://github.com/thi-ng/umbrella/commit/e3085e4))
+
 ### [0.5.5](https://github.com/thi-ng/umbrella/tree/@thi.ng/fibers@0.5.5) (2023-10-18)
 
 #### 🩹 Bug fixes

package/README.md

@@ -378,7 +378,7 @@ For Node.js REPL:
 const fibers = await import("@thi.ng/fibers");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.40 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.60 KB
 
 ## Dependencies
 

package/csp.js

@@ -10,9 +10,11 @@ const STATE_CLOSED = 2;
  * (and ordering). By default uses a single value {@link fifo} buffer impl.
  */
 export class Channel {
+    opts;
+    buffer;
+    state = STATE_OPEN;
     constructor(buffer = 1, opts) {
         this.opts = opts;
-        this.state = STATE_OPEN;
         this.buffer = isNumber(buffer) ? new FIFOBuffer(buffer) : buffer;
     }
     /**
@@ -157,9 +159,10 @@ export const channel = (buffer, opts) => new Channel(buffer, opts);
  * First-in, first-out ring buffer implementation for use with {@link Channel}.
  */
 export class FIFOBuffer {
+    buf;
+    rpos = 0;
+    wpos = 0;
     constructor(cap = 1) {
-        this.rpos = 0;
-        this.wpos = 0;
         assert(cap >= 1, `capacity must be >= 1`);
         this.buf = new Array(cap + 1);
     }
@@ -201,9 +204,10 @@ export class FIFOBuffer {
  */
 export const fifo = (cap) => new FIFOBuffer(cap);
 export class LIFOBuffer {
+    cap;
+    buf = [];
     constructor(cap = 1) {
         this.cap = cap;
-        this.buf = [];
         assert(cap >= 1, `capacity must be >= 1`);
     }
     clear() {

package/fiber.d.ts

@@ -20,12 +20,29 @@ export declare class Fiber<T = any> implements IDeref<T | undefined>, IID<string
     error?: Error;
     logger?: ILogger;
     user?: Partial<Pick<FiberOpts, "init" | "deinit" | "catch">>;
+    _promise?: Promise<T | undefined>;
     constructor(gen?: Nullable<FiberFactory<T> | Generator<unknown, T>>, opts?: Partial<FiberOpts>);
     /**
      * Co-routine which blocks whilst this fiber (incl. its children) is active.
      * Then return this fiber's value.
      */
     [Symbol.iterator](): Generator<undefined, T | undefined, unknown>;
+    /**
+     * Returns a promise which only resolves when the fiber is not active
+     * anymore. If there was an unhandled error during the fiber execution the
+     * promise will reject, else if the fiber (incl. children) completed on its
+     * own or was cancelled, the promise resolves with the fiber's final
+     * (possibly `undefined`) value.
+     *
+     * @remarks
+     * The promise assumes the fiber either already has been (or will be)
+     * scheduled & executed via other means. This promise only repeatedly checks
+     * for any state changes of this fiber (at a configurable
+     * frequency/interval), but does *NOT* trigger fiber execution!
+     *
+     * @param delay
+     */
+    promise(delay?: number): Promise<T | undefined>;
     /**
      * Returns this fiber's result value (if any). Only available if the fiber
      * completed successfully and produced a value (either by returning a value

package/fiber.js

@@ -10,11 +10,25 @@ let DEFAULT_ID_GEN = prefixed("fib-", monotonic());
 export const setDefaultIDGen = (gen) => (DEFAULT_ID_GEN = gen);
 const NO_RESULT = { done: false, value: undefined };
 let Fiber = Fiber_1 = class Fiber {
+    /**
+     * This fiber's user provided or generated ID.
+     */
+    id;
+    /**
+     * This fiber's parent.
+     */
+    parent;
+    gen;
+    idgen;
+    state = STATE_NEW;
+    autoTerminate = false;
+    children = [];
+    value = undefined;
+    error;
+    logger;
+    user;
+    _promise;
     constructor(gen, opts) {
-        this.state = STATE_NEW;
-        this.autoTerminate = false;
-        this.children = [];
-        this.value = undefined;
         if (opts) {
             this.autoTerminate = !!opts.terminate;
             this.logger = opts.logger;
@@ -47,6 +61,34 @@ let Fiber = Fiber_1 = class Fiber {
             yield;
         return this.value;
     }
+    /**
+     * Returns a promise which only resolves when the fiber is not active
+     * anymore. If there was an unhandled error during the fiber execution the
+     * promise will reject, else if the fiber (incl. children) completed on its
+     * own or was cancelled, the promise resolves with the fiber's final
+     * (possibly `undefined`) value.
+     *
+     * @remarks
+     * The promise assumes the fiber either already has been (or will be)
+     * scheduled & executed via other means. This promise only repeatedly checks
+     * for any state changes of this fiber (at a configurable
+     * frequency/interval), but does *NOT* trigger fiber execution!
+     *
+     * @param delay
+     */
+    promise(delay = 1) {
+        return (this._promise ||
+            (this._promise = new Promise((resolve, reject) => {
+                const timerID = setInterval(() => {
+                    if (this.state > STATE_ACTIVE) {
+                        clearInterval(timerID);
+                        this.state < STATE_ERROR
+                            ? resolve(this.value)
+                            : reject(this.error);
+                    }
+                }, delay);
+            })));
+    }
     /**
      * Returns this fiber's result value (if any). Only available if the fiber
      * completed successfully and produced a value (either by returning a value

package/ops.js

@@ -241,6 +241,7 @@ export const untilEvent = (target, type, opts) => {
  * Custom fiber implementation for {@link shuffle}.
  */
 export class Shuffle extends Fiber {
+    rnd;
     constructor(fibers, opts) {
         super((ctx) => ctx.join(), opts);
         this.rnd = opts?.rnd || SYSTEM;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/fibers",
-  "version": "0.5.10",
+  "version": "0.6.1",
   "description": "Process hierarchies & operators for cooperative multitasking",
   "type": "module",
   "module": "./index.js",
@@ -28,27 +28,26 @@
     "clean": "rimraf --glob '*.js' '*.d.ts' '*.map' doc",
     "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
-    "doc:readme": "yarn doc:stats && tools:readme",
-    "doc:stats": "tools:module-stats",
+    "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
     "pub": "yarn npm publish --access public",
-    "test": "testament test"
+    "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.6",
-    "@thi.ng/arrays": "^2.7.2",
-    "@thi.ng/bench": "^3.4.8",
-    "@thi.ng/checks": "^3.4.6",
-    "@thi.ng/errors": "^2.4.0",
-    "@thi.ng/idgen": "^2.2.9",
-    "@thi.ng/logger": "^1.4.22",
-    "@thi.ng/random": "^3.6.12"
+    "@thi.ng/api": "^8.9.8",
+    "@thi.ng/arrays": "^2.7.4",
+    "@thi.ng/bench": "^3.4.10",
+    "@thi.ng/checks": "^3.4.8",
+    "@thi.ng/errors": "^2.4.2",
+    "@thi.ng/idgen": "^2.2.11",
+    "@thi.ng/logger": "^1.4.24",
+    "@thi.ng/random": "^3.6.14"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.38.0",
-    "@thi.ng/testament": "^0.3.24",
+    "@microsoft/api-extractor": "^7.38.2",
+    "@thi.ng/testament": "^0.4.1",
     "rimraf": "^5.0.5",
     "tools": "^0.0.1",
-    "typedoc": "^0.25.2",
+    "typedoc": "^0.25.3",
     "typescript": "^5.2.2"
   },
   "keywords": [
@@ -108,5 +107,5 @@
     "status": "alpha",
     "year": 2023
   },
-  "gitHead": "336bd1bf95825b3c318a3ab49c54451c94aaa883\n"
+  "gitHead": "669a3151e4302480244fe3e60eff5e732ea5b7a7\n"
 }