@thi.ng/rstream 8.3.9 → 8.3.11

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-03-01T15:22:50Z
+- **Last updated**: 2024-03-07T20:40:47Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -135,6 +135,9 @@ src.transform({ xform: map(...), error: handleError });
    (transducer) must now be given as part of the options object:
 
 ```ts
+import { reactive, trace } from "@thi.ng/rstream";
+import { filter } from "@thi.ng/transducers";
+
 const src = reactive(1);
 
 // old
@@ -149,6 +152,9 @@ src.subscribe(trace("foo"), { xform: filter((x) => x < 10), id: "child-sub" });
    similarity to above.
 
 ```ts
+import { pubsub } from "@thi.ng/rstream";
+import { map } from "@thi.ng/transducers";
+
 type Event = { id: string; value: any; };
 
 const src = pubsub<Event>({ topic: (e) => e.id });
@@ -341,6 +347,8 @@ triggered manually (from outside the stream), in which case the user
 should call `stream.next()` to cause value propagation.
 
 ```ts
+import { stream, trace } from "@thi.ng/rstream";
+
 a = stream<number>((s) => {
     s.next(1);
     s.next(2);
@@ -400,14 +408,19 @@ too). Subscriptions can be:
 - implement the @thi.ng/api `IDeref` interface
 
 ```ts
+import { subscription, trace } from "@thi.ng/rstream";
+import { filter } from "@thi.ng/transducers";
+
 // as reactive value mechanism (same as with stream() above)
 s = subscription<any, any>();
 s.subscribe(trace("s1"));
-s.subscribe(trace("s2"), tx.filter((x) => x > 25));
+s.subscribe(trace("s2"), filter((x) => x > 25));
 
 // external trigger
 s.next(23);
 // s1 23
+// (s2 doesn't receive value here due to its filter)
+
 s.next(42);
 // s2 42
 // s1 42
@@ -457,12 +470,15 @@ function returns `null` / `undefined`, no further action will be taken
 ignored).
 
 ```ts
+import { metastream, fromIterable, trace } from "@thi.ng/rstream";
+import { repeat } from "@thi.ng/transducers";
+
 // transform each received odd number into a stream
 // producing 3 copies of that number in the metastream
 // even numbers are ignored
 a = metastream<number, string>(
   (x) => (x & 1)
-    ? fromIterable(tx.repeat("odd: " + x, 3), { delay: 100 })
+    ? fromIterable(repeat("odd: " + x, 3), { delay: 100 })
     : null
 );
 
@@ -491,14 +507,17 @@ inputs. This keeps them alive and allows for dynamic switching between
 them.
 
 ```ts
+import { metastream, fromIterable, trace, CloseMode } from "@thi.ng/rstream";
+import { repeat } from "@thi.ng/transducers";
+
 // infinite inputs
 a = fromIterable(
-  tx.repeat("a"),
+  repeat("a"),
   { delay: 1000, closeOut: CloseMode.NEVER }
 );
 
 b = fromIterable(
-  tx.repeat("b"),
+  repeat("b"),
   { delay: 1000, closeOut: CloseMode.NEVER }
 );
 
@@ -532,6 +551,8 @@ done, but this behavior can be overridden via the `close` option, using
 `CloseMode` enums.
 
 ```ts
+import { merge, fromIterable, trace } from "@thi.ng/rstream";
+
 merge({
     // input streams w/ different frequencies
     src: [
@@ -556,10 +577,13 @@ transducer](https://docs.thi.ng/umbrella/transducers/functions/labeled.html) for
 each input to create a stream of labeled values and track their provenance:
 
 ```ts
+import { merge, fromIterable, trace } from "@thi.ng/rstream";
+import { labeled } from "@thi.ng/transducers";
+
 merge({
     src: [
-        fromIterable([1, 2, 3]).transform(tx.labeled("a")),
-        fromIterable([10, 20, 30]).transform(tx.labeled("b")),
+        fromIterable([1, 2, 3]).transform(labeled("a")),
+        fromIterable([10, 20, 30]).transform(labeled("b")),
     ]
 }).subscribe(trace());
 // ["a", 1]
@@ -582,12 +606,13 @@ as new input to the merge and then automatically remove once that stream
 is exhausted.
 
 ```ts
+import { merge, stream, fromIterable, trace } from "@thi.ng/rstream";
 import { repeat } from "@thi.ng/transducers";
 
 // stream source w/ transducer mapping values to new streams
 a = stream().map((x) => fromIterable(repeat(x, 3)));
 // simple 1Hz counter
-b = fromInterval(1000);
+b = fromInterval(1000).map((x) => "b" + x);
 
 merge({ src: [a, b] }).subscribe(trace());
 // 0
@@ -630,6 +655,8 @@ calls `done()` when the last active input is done, but this behavior can
 be overridden via the `close` constructor option, using `CloseMode` enums.
 
 ```ts
+import { sync, stream, trace } from "@thi.ng/rstream";
+
 const a = stream();
 const b = stream();
 s = sync<any,any>({ src: { a, b } }).subscribe(trace("result: "));
@@ -692,6 +719,8 @@ topic function and `a` & `b` as subscribers for truthy (`a`) and falsy
 `b` values.
 
 ```ts
+import { bisect, fromIterable, trace } from "@thi.ng/rstream";
+
 fromIterable([1, 2, 3, 4]).subscribe(
     bisect((x) => !!(x & 1), trace("odd"), trace("even"))
 );
@@ -708,6 +737,8 @@ first created as `Subscription` (if not already) and a reference kept
 prior to calling `bisect()`.
 
 ```ts
+import { bisect, fromIterable, subscription, trace } from "@thi.ng/rstream";
+
 const odd = subscription();
 const even = subscription();
 odd.subscribe(trace("odd"));
@@ -741,6 +772,11 @@ optional predicate can be used to only trigger for specific values /
 conditions.
 
 ```ts
+import {
+    merge, fromEvent, fromRAF,
+    sidechainPartition, trace
+} from "@thi.ng/rstream";
+
 // queue event processing to only execute during the
 // requestAnimationFrame cycle (RAF)
 sidechainPartition(
@@ -755,7 +791,21 @@ sidechainPartition(
 ).subscribe(trace());
 ```
 
-Since v8.0.0 there's [`syncRAF()`](https://docs.thi.ng/umbrella/rstream/functions/syncRAF-1.html)
+Since v8.0.0 there's
+[`syncRAF()`](https://docs.thi.ng/umbrella/rstream/functions/syncRAF-1.html),
+which allows the above to be simplified to:
+
+```ts
+import { merge, fromEvent, syncRAF, trace } from "@thi.ng/rstream";
+
+syncRAF(
+    merge([
+        fromEvent(document, "mousemove"),
+        fromEvent(document, "mousedown"),
+        fromEvent(document, "mouseup")
+    ])
+).subscribe(trace());
+```
 
 #### Input toggling, controlled by sidechain
 
@@ -771,6 +821,8 @@ will be toggled on/off. Whilst switched off, no input values will be
 forwarded.
 
 ```ts
+import { sidechainToggle, fromInterval, trace } from "@thi.ng/rstream";
+
 // use slower interval stream to toggle faster main stream on/off
 sidechainToggle(fromInterval(500), fromInterval(1000)).subscribe(trace());
 // 0
@@ -789,6 +841,8 @@ Buffers the most recent value received and only forwards it downstream whenever
 a new control value is received from the sidechain.
 
 ```ts
+import { sidechainTrigger, reactive, stream, trace } from "@thi.ng/rstream";
+
 const src = reactive("payload");
 
 const side = stream();
@@ -832,6 +886,8 @@ self.addEventListener("message", (e) => {
 ##### main.ts
 
 ```ts
+import { forkJoin, trace } from "@thi.ng/rstream";
+
 const src = stream<number[]>();
 
 // fork worker jobs & re-join results
@@ -898,6 +954,8 @@ handler will be called, which _might_ put this subscription into an error
 state and stop it from receiving new values.
 
 ```ts
+import { subscription, State } from "@thi.ng/rstream";
+
 src = subscription({ next(x) { throw x; } });
 
 // triggers error, caught by subscription wrapper

package/object.d.ts

@@ -66,7 +66,7 @@ export interface StreamObjOpts<T, K extends Keys<T>> extends CommonOpts {
  * The structure of the returned object is
  * {@link StreamObj | as follows}:
  *
- * ```ts
+ * ```text
  * {
  *   streams: { ... },
  *   next(x): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/rstream",
-  "version": "8.3.9",
+  "version": "8.3.11",
   "description": "Reactive streams & subscription primitives for constructing dataflow graphs / pipelines",
   "type": "module",
   "module": "./index.js",
@@ -36,17 +36,18 @@
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
     "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
     "pub": "yarn npm publish --access public",
-    "test": "bun test"
+    "test": "bun test",
+    "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.27",
-    "@thi.ng/arrays": "^2.8.4",
-    "@thi.ng/associative": "^6.3.44",
-    "@thi.ng/atom": "^5.2.34",
-    "@thi.ng/checks": "^3.5.1",
-    "@thi.ng/errors": "^2.4.19",
-    "@thi.ng/logger": "^3.0.4",
-    "@thi.ng/transducers": "^8.9.8"
+    "@thi.ng/api": "^8.9.28",
+    "@thi.ng/arrays": "^2.8.6",
+    "@thi.ng/associative": "^6.3.46",
+    "@thi.ng/atom": "^5.2.36",
+    "@thi.ng/checks": "^3.5.2",
+    "@thi.ng/errors": "^2.4.20",
+    "@thi.ng/logger": "^3.0.5",
+    "@thi.ng/transducers": "^8.9.10"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.40.1",
@@ -214,5 +215,5 @@
     ],
     "year": 2017
   },
-  "gitHead": "d660ae8fd1bf64d919b4334f19509f1f539d70f6\n"
+  "gitHead": "a421058a65ba76608d94129ac29451bfedaf201c\n"
 }