@thi.ng/fibers 0.3.2 → 0.4.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-08-27T11:20:59Z
+- **Last updated**: 2023-09-06T13:36:28Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ 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.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/fibers@0.4.0) (2023-09-06)
+
+#### 🚀 Features
+
+- add timeSliceIterable() ([fe13b03](https://github.com/thi-ng/umbrella/commit/fe13b03))
+
 ## [0.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/fibers@0.3.0) (2023-08-14)
 
 #### 🚀 Features

package/README.md

@@ -376,7 +376,7 @@ For Node.js REPL:
 const fibers = await import("@thi.ng/fibers");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.27 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.33 KB
 
 ## Dependencies
 
@@ -402,6 +402,7 @@ A selection:
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/ascii-raymarch.jpg" width="240"/> | ASCII art raymarching with thi.ng/shader-ast & thi.ng/text-canvas | [Demo](https://demo.thi.ng/umbrella/ascii-raymarch/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/ascii-raymarch) |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/fiber-basics.png" width="240"/>   | Fiber-based cooperative multitasking basics                       | [Demo](https://demo.thi.ng/umbrella/fiber-basics/)   | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/fiber-basics)   |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/ifs-fractal.jpg" width="240"/>    | Barnsley fern IFS fractal renderer                                | [Demo](https://demo.thi.ng/umbrella/ifs-fractal/)    | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/ifs-fractal)    |
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/render-audio.png" width="240"/>   | Generative audio synth offline renderer and WAV file export       | [Demo](https://demo.thi.ng/umbrella/render-audio/)   | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/render-audio)   |
 
 ## API
 

package/ops.d.ts

@@ -1,4 +1,4 @@
-import type { Fn0, Predicate } from "@thi.ng/api";
+import type { Fn, Fn0, Predicate } from "@thi.ng/api";
 import type { IRandom } from "@thi.ng/random";
 import { type FiberOpts, type MaybeFiber, type State } from "./api.js";
 import { Fiber } from "./fiber.js";
@@ -84,6 +84,30 @@ export declare const withTimeout: (body: MaybeFiber, timeout: number, opts?: Par
  * @param opts
  */
 export declare const timeSlice: (body: MaybeFiber, maxTime: number, opts?: Partial<FiberOpts>) => Fiber<void>;
+/**
+ * Similar to {@link timeSlice}, but for consuming the given iterable in a
+ * time-sliced manner. With each fiber update consumes & buffers values from
+ * `src` in chunks for `maxTime` milliseconds, then passes recorded chunk to
+ * given `consume` function in order to process these values further.
+ *
+ * @example
+ * ```ts
+ * import { range } from "@this.ng/transducers";
+ *
+ * // consume & batch process iterable in 16ms time slices
+ * timeSliceIterable(
+ *   range(1_000_000),
+ *   (chunk) => console.log(chunk),
+ *   16
+ * ).run();
+ * ```
+ *
+ * @param src
+ * @param consume
+ * @param maxTime
+ * @param opts
+ */
+export declare const timeSliceIterable: <T>(src: Iterable<T>, consume: Fn<T[], void>, maxTime: number, opts?: Partial<FiberOpts>) => Fiber<void>;
 /**
  * Returns a fiber which "blocks" until given predicate function returns true.
  *

package/ops.js

@@ -127,6 +127,46 @@ export const timeSlice = (body, maxTime, opts) => fiber(function* () {
         yield;
     }
 }, opts);
+/**
+ * Similar to {@link timeSlice}, but for consuming the given iterable in a
+ * time-sliced manner. With each fiber update consumes & buffers values from
+ * `src` in chunks for `maxTime` milliseconds, then passes recorded chunk to
+ * given `consume` function in order to process these values further.
+ *
+ * @example
+ * ```ts
+ * import { range } from "@this.ng/transducers";
+ *
+ * // consume & batch process iterable in 16ms time slices
+ * timeSliceIterable(
+ *   range(1_000_000),
+ *   (chunk) => console.log(chunk),
+ *   16
+ * ).run();
+ * ```
+ *
+ * @param src
+ * @param consume
+ * @param maxTime
+ * @param opts
+ */
+export const timeSliceIterable = (src, consume, maxTime, opts) => fiber(function* () {
+    const iter = src[Symbol.iterator]();
+    while (true) {
+        let t0 = now();
+        const buf = [];
+        do {
+            const { value, done } = iter.next();
+            if (done) {
+                consume(buf);
+                return;
+            }
+            buf.push(value);
+        } while (timeDiff(t0, now()) < maxTime);
+        consume(buf);
+        yield;
+    }
+}, opts);
 /**
  * Returns a fiber which "blocks" until given predicate function returns true.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/fibers",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "Process hierarchies & operators for cooperative multitasking",
   "type": "module",
   "module": "./index.js",
@@ -35,13 +35,13 @@
   },
   "dependencies": {
     "@thi.ng/api": "^8.9.5",
-    "@thi.ng/arrays": "^2.5.21",
+    "@thi.ng/arrays": "^2.5.22",
     "@thi.ng/bench": "^3.4.6",
     "@thi.ng/checks": "^3.4.5",
     "@thi.ng/errors": "^2.3.5",
     "@thi.ng/idgen": "^2.2.6",
     "@thi.ng/logger": "^1.4.21",
-    "@thi.ng/random": "^3.6.3"
+    "@thi.ng/random": "^3.6.4"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.36.4",
@@ -108,5 +108,5 @@
     "status": "alpha",
     "year": 2023
   },
-  "gitHead": "5929dd20497668496af13415cdf784a4d6f69aa3\n"
+  "gitHead": "1bbef970bab7f7def0700e587cf0471e1e1ef9f3\n"
 }