@thi.ng/rstream 7.2.31 → 7.2.33

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-16T12:52:25Z
+- **Last updated**: 2022-12-22T21:47:07Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -45,7 +45,7 @@ This project is part of the
 
 ## About
 
-Reactive streams & subscription primitives for constructing dataflow graphs / pipelines
+Reactive streams & subscription primitives for constructing dataflow graphs / pipelines.
 
 This library provides & uses three key building blocks for reactive
 programming:

package/atom.d.ts

@@ -18,15 +18,16 @@ export interface FromAtomOpts<T> extends CommonOpts {
     changed: Predicate2<T>;
 }
 /**
- * Yields {@link Stream} of value changes in given
- * {@link @thi.ng/atom# | Atom-like state container}.
+ * Yields {@link Stream} of value changes in given [Atom-like state
+ * container](https://thi.ng/atom).
  *
  * @remarks
- * Attaches a {@link @thi.ng/api#IWatch.addWatch | watch} to the atom
- * and checks for value changes with given `changed` predicate (`!==` by
- * default). If the predicate returns truthy result, the new value is
- * emitted on the stream. If `emitFirst` is true (default), also emits
- * atom's current value when first subscriber attaches to stream.
+ * [Attaches a
+ * watch](https://docs.thi.ng/umbrella/api/interfaces/IWatch.html#addWatch) to
+ * the atom and checks for value changes with given `changed` predicate (`!==`
+ * by default). If the predicate returns truthy result, the new value is emitted
+ * on the stream. If `emitFirst` is true (default), also emits atom's current
+ * value when first subscriber attaches to stream.
  *
  * Also see {@link fromView}, {@link fromViewUnsafe}
  *

package/atom.js

@@ -1,15 +1,16 @@
 import { __optsWithID } from "./idgen.js";
 import { stream } from "./stream.js";
 /**
- * Yields {@link Stream} of value changes in given
- * {@link @thi.ng/atom# | Atom-like state container}.
+ * Yields {@link Stream} of value changes in given [Atom-like state
+ * container](https://thi.ng/atom).
  *
  * @remarks
- * Attaches a {@link @thi.ng/api#IWatch.addWatch | watch} to the atom
- * and checks for value changes with given `changed` predicate (`!==` by
- * default). If the predicate returns truthy result, the new value is
- * emitted on the stream. If `emitFirst` is true (default), also emits
- * atom's current value when first subscriber attaches to stream.
+ * [Attaches a
+ * watch](https://docs.thi.ng/umbrella/api/interfaces/IWatch.html#addWatch) to
+ * the atom and checks for value changes with given `changed` predicate (`!==`
+ * by default). If the predicate returns truthy result, the new value is emitted
+ * on the stream. If `emitFirst` is true (default), also emits atom's current
+ * value when first subscriber attaches to stream.
  *
  * Also see {@link fromView}, {@link fromViewUnsafe}
  *

package/merge.d.ts

@@ -11,9 +11,9 @@ export interface StreamMergeOpts<A, B> extends TransformableOpts<A, B> {
  * multiple inputs and passing received values on to any subscribers.
  *
  * @remarks
- * Input streams can be added and removed dynamically. By default,
- * `StreamMerge` calls {@link ISubscriber.done} when the last active
- * input is done, but this behavior can be overridden via the provided
+ * Input streams can be added and removed dynamically. By default, `StreamMerge`
+ * calls {@link ISubscriber.done} when the last active input is done, but this
+ * behavior can be overridden via the provided
  * {@link StreamMergeOpts | options}.
  *
  * @example
@@ -38,8 +38,10 @@ export interface StreamMergeOpts<A, B> extends TransformableOpts<A, B> {
  * ```
  *
  * @example
- * Use the {@link @thi.ng/transducers#(labeled:1)} transducer for each
- * input to create a stream of labeled values and track their provenance:
+ * Use the
+ * [`labeled()`](https://docs.thi.ng/umbrella/transducers/functions/labeled.html)
+ * transducer for each input to create a stream of labeled values and
+ * track their provenance:
  *
  * @example
  * ```ts

package/merge.js

@@ -8,9 +8,9 @@ import { Subscription } from "./subscription.js";
  * multiple inputs and passing received values on to any subscribers.
  *
  * @remarks
- * Input streams can be added and removed dynamically. By default,
- * `StreamMerge` calls {@link ISubscriber.done} when the last active
- * input is done, but this behavior can be overridden via the provided
+ * Input streams can be added and removed dynamically. By default, `StreamMerge`
+ * calls {@link ISubscriber.done} when the last active input is done, but this
+ * behavior can be overridden via the provided
  * {@link StreamMergeOpts | options}.
  *
  * @example
@@ -35,8 +35,10 @@ import { Subscription } from "./subscription.js";
  * ```
  *
  * @example
- * Use the {@link @thi.ng/transducers#(labeled:1)} transducer for each
- * input to create a stream of labeled values and track their provenance:
+ * Use the
+ * [`labeled()`](https://docs.thi.ng/umbrella/transducers/functions/labeled.html)
+ * transducer for each input to create a stream of labeled values and
+ * track their provenance:
  *
  * @example
  * ```ts

package/object.d.ts

@@ -43,8 +43,9 @@ export interface StreamObjOpts<T, K extends Keys<T>> extends CommonOpts {
      */
     defaults: Partial<T>;
     /**
-     * If true, attaches {@link @thi.ng/transducers#dedupe} transducer
-     * to each key's value stream to avoid obsolete downstream
+     * If true, attaches
+     * [`dedupe()`](https://docs.thi.ng/umbrella/transducers/functions/dedupe.html)
+     * transducer to each key's value stream to avoid obsolete downstream
      * propagation when a key's value hasn't actually changed.
      *
      * @defaultValue true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/rstream",
-  "version": "7.2.31",
+  "version": "7.2.33",
   "description": "Reactive streams & subscription primitives for constructing dataflow graphs / pipelines",
   "type": "module",
   "module": "./index.js",
@@ -38,18 +38,18 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.6.0",
-    "@thi.ng/arrays": "^2.4.5",
-    "@thi.ng/associative": "^6.2.19",
-    "@thi.ng/atom": "^5.1.25",
-    "@thi.ng/checks": "^3.3.5",
-    "@thi.ng/errors": "^2.2.6",
-    "@thi.ng/logger": "^1.4.5",
-    "@thi.ng/transducers": "^8.3.26"
+    "@thi.ng/api": "^8.6.2",
+    "@thi.ng/arrays": "^2.4.7",
+    "@thi.ng/associative": "^6.2.21",
+    "@thi.ng/atom": "^5.1.27",
+    "@thi.ng/checks": "^3.3.6",
+    "@thi.ng/errors": "^2.2.7",
+    "@thi.ng/logger": "^1.4.6",
+    "@thi.ng/transducers": "^8.3.28"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.7",
-    "@thi.ng/testament": "^0.3.7",
+    "@thi.ng/testament": "^0.3.8",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
     "typedoc": "^0.23.22",
@@ -205,5 +205,5 @@
     ],
     "year": 2017
   },
-  "gitHead": "f445a9cc8022bcdebbf6ff91fd66ced016d72f01\n"
+  "gitHead": "bc6f7f5e2765bb96fe64db804eaf4b2443b47fc6\n"
 }

package/pubsub.d.ts

@@ -33,9 +33,10 @@ export interface PubSubOpts<A, B, T> {
  * The actual topic (return value from `topic` fn) can be of any type `T`, or
  * `undefined`. If the latter is returned, the incoming value will not be
  * processed further. Complex topics (e.g objects / arrays) are allowed and
- * they're matched against registered topics using {@link @thi.ng/equiv#equiv}
- * by default (but customizable via `equiv` option). Each topic can have any
- * number of subscribers.
+ * they're matched against registered topics using
+ * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) by
+ * default (but customizable via `equiv` option). Each topic can have any number
+ * of subscribers.
  *
  * If a `xform` transducer is given, it is always applied prior to passing the
  * input to the topic function. I.e. in this case the topic function will

package/pubsub.js

@@ -12,9 +12,10 @@ import { Subscription, subscription } from "./subscription.js";
  * The actual topic (return value from `topic` fn) can be of any type `T`, or
  * `undefined`. If the latter is returned, the incoming value will not be
  * processed further. Complex topics (e.g objects / arrays) are allowed and
- * they're matched against registered topics using {@link @thi.ng/equiv#equiv}
- * by default (but customizable via `equiv` option). Each topic can have any
- * number of subscribers.
+ * they're matched against registered topics using
+ * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) by
+ * default (but customizable via `equiv` option). Each topic can have any number
+ * of subscribers.
  *
  * If a `xform` transducer is given, it is always applied prior to passing the
  * input to the topic function. I.e. in this case the topic function will

package/stream.d.ts

@@ -1,30 +1,29 @@
 import { CommonOpts, IStream, ISubscriber, ISubscription, StreamCancel, StreamSource, TransformableOpts, WithErrorHandlerOpts } from "./api.js";
 import { Subscription } from "./subscription.js";
 /**
- * Creates a new {@link Stream} instance, optionally with given
- * `StreamSource` function and / or options.
+ * Creates a new {@link Stream} instance, optionally with given `StreamSource`
+ * function and / or options.
  *
  * @remarks
- * If a `src` function is provided, the function will be only called
- * (with the `Stream` instance as single argument) once the first
- * subscriber has attached to the stream. If the function returns
- * another function, it will be used for cleanup purposes if the stream
- * is cancelled, e.g. if the first / last subscriber has unsubscribed
- * (depending on `closeOut` option). Streams are intended as (primarily
- * async) data sources in a dataflow graph and are the primary construct
- * for the various `from*()` functions provided by this package.
- * However, streams can also be triggered manually (from outside the
- * stream), in which case the user should call `stream.next()` to cause
- * value propagation.
+ * If a `src` function is provided, the function will be only called (with the
+ * `Stream` instance as single argument) once the first subscriber has attached
+ * to the stream. If the function returns another function, it will be used for
+ * cleanup purposes if the stream is cancelled, e.g. if the first / last
+ * subscriber has unsubscribed (depending on `closeOut` option). Streams are
+ * intended as (primarily async) data sources in a dataflow graph and are the
+ * primary construct for the various `from*()` functions provided by this
+ * package. However, streams can also be triggered manually (from outside the
+ * stream), in which case the user should call `stream.next()` to cause value
+ * propagation.
  *
  * Streams (like {@link Subscription}) implement the
- * {@link @thi.ng/api#IDeref} interface which provides read access to a
- * stream's last received value. This is useful for various purposes,
- * e.g. in combination with {@link @thi.ng/hdom# | @thi.ng/hdom}, which
- * supports direct embedding of streams (i.e. their values) into UI
- * components (and will be deref them automatically). If the stream has
- * not yet emitted a value, value caching is disabled or if the stream
- * is done, it will deref to `undefined`.
+ * [`IDeref`](https://docs.thi.ng/umbrella/api/interfaces/IDeref.html) interface
+ * which provides read access to a stream's last received value. This is useful
+ * for various purposes, e.g. in combination with
+ * [`thi.ng/hdom`](https://thi.ng/hdom), which supports direct embedding of
+ * streams (i.e. their values) into UI components (and will be deref them
+ * automatically). If the stream has not yet emitted a value, value caching is
+ * disabled or if the stream is done, it will deref to `undefined`.
  *
  * @example
  * ```ts

package/subscription.d.ts

@@ -3,35 +3,34 @@ import type { Reducer, Transducer } from "@thi.ng/transducers";
 import { Reduced } from "@thi.ng/transducers/reduced";
 import { CloseMode, CommonOpts, ISubscriber, ISubscription, State, SubscriptionOpts, TransformableOpts, WithErrorHandlerOpts, WithTransform } from "./api.js";
 /**
- * Creates a new {@link Subscription} instance, the fundamental datatype
- * and building block provided by this package.
+ * Creates a new {@link Subscription} instance, the fundamental datatype and
+ * building block provided by this package.
  *
  * @remarks
- * Most other types in rstream, including {@link Stream}s, are
- * `Subscription`s and all can be:
+ * Most other types in rstream, including {@link Stream}s, are `Subscription`s
+ * and all can be:
  *
- * - connected into directed graphs (sync or async & not necessarily
- *   DAGs)
+ * - connected into directed graphs (sync or async & not necessarily DAGs)
  * - transformed using transducers (incl. support for early termination)
  * - can have any number of subscribers (optionally each w/ their own
  *   transducers)
- * - recursively unsubscribe themselves from parent after their last
- *   subscriber unsubscribed (configurable)
- * - will go into a non-recoverable error state if none of the
- *   subscribers has an error handler itself
- * - implement the {@link @thi.ng/api#IDeref} interface
+ * - recursively unsubscribe themselves from parent after their last subscriber
+ *   unsubscribed (configurable)
+ * - will go into a non-recoverable error state if none of the subscribers has
+ *   an error handler itself
+ * - implement the
+ *   [`IDeref`](https://docs.thi.ng/umbrella/api/interfaces/IDeref.html)
+ *   interface
  *
- * If a transducer is provided (via the `xform` option), all received
- * values will be first processed by the transducer and only its
- * transformed result(s) (if any) will be passed to downstream
- * subscribers. Any uncaught errors *inside* the transducer will cause
- * this subscription's error handler to be called and will stop this
- * subscription from receiving any further values (by default, unless
- * overridden).
+ * If a transducer is provided (via the `xform` option), all received values
+ * will be first processed by the transducer and only its transformed result(s)
+ * (if any) will be passed to downstream subscribers. Any uncaught errors
+ * *inside* the transducer will cause this subscription's error handler to be
+ * called and will stop this subscription from receiving any further values (by
+ * default, unless overridden).
  *
- * Subscription behavior can be customized via the additional (optional)
- * options arg. See {@link CommonOpts} and {@link SubscriptionOpts} for
- * further details.
+ * Subscription behavior can be customized via the additional (optional) options
+ * arg. See {@link CommonOpts} and {@link SubscriptionOpts} for further details.
  *
  * @example
  * ```ts
@@ -76,10 +75,10 @@ export declare class Subscription<A, B> implements ISubscription<A, B> {
     subscribe(sub: Partial<ISubscriber<B>>, opts?: Partial<CommonOpts>): ISubscription<B, B>;
     subscribe<C>(sub: Partial<ISubscriber<C>>, opts?: Partial<TransformableOpts<B, C>>): ISubscription<B, C>;
     /**
-     * Creates a new child subscription using given transducers and
-     * optional subscription ID. Supports up to 4 transducers and if
-     * more than one transducer is given, composes them in left-to-right
-     * order using {@link @thi.ng/transducers#(comp:1)}.
+     * Creates a new child subscription using given transducers and optional
+     * subscription ID. Supports up to 4 transducers and if more than one
+     * transducer is given, composes them in left-to-right order using
+     * [`comp()`](https://docs.thi.ng/umbrella/transducers/functions/comp.html).
      *
      * Shorthand for `subscribe(comp(xf1, xf2,...), id)`
      */
@@ -89,9 +88,10 @@ export declare class Subscription<A, B> implements ISubscription<A, B> {
     transform<C, D, E, F>(a: Transducer<B, C>, b: Transducer<C, D>, c: Transducer<D, E>, d: Transducer<E, F>, opts?: Partial<WithErrorHandlerOpts>): ISubscription<B, F>;
     transform<C>(opts: WithTransform<B, C> & Partial<WithErrorHandlerOpts>): ISubscription<B, C>;
     /**
-     * Syntax sugar for {@link Subscription.transform} when using a
-     * single {@link @thi.ng/transducers#map} transducer only. The given
-     * function `fn` is used as `map`'s transformation fn.
+     * Syntax sugar for {@link Subscription.transform} when using a single
+     * [`map()`](https://docs.thi.ng/umbrella/transducers/functions/map.html)
+     * transducer only. The given function `fn` is used as `map`'s
+     * transformation fn.
      *
      * @param fn -
      * @param opts -

package/subscription.js

@@ -12,35 +12,34 @@ import { CloseMode, State, } from "./api.js";
 import { __optsWithID } from "./idgen.js";
 import { LOGGER } from "./logger.js";
 /**
- * Creates a new {@link Subscription} instance, the fundamental datatype
- * and building block provided by this package.
+ * Creates a new {@link Subscription} instance, the fundamental datatype and
+ * building block provided by this package.
  *
  * @remarks
- * Most other types in rstream, including {@link Stream}s, are
- * `Subscription`s and all can be:
+ * Most other types in rstream, including {@link Stream}s, are `Subscription`s
+ * and all can be:
  *
- * - connected into directed graphs (sync or async & not necessarily
- *   DAGs)
+ * - connected into directed graphs (sync or async & not necessarily DAGs)
  * - transformed using transducers (incl. support for early termination)
  * - can have any number of subscribers (optionally each w/ their own
  *   transducers)
- * - recursively unsubscribe themselves from parent after their last
- *   subscriber unsubscribed (configurable)
- * - will go into a non-recoverable error state if none of the
- *   subscribers has an error handler itself
- * - implement the {@link @thi.ng/api#IDeref} interface
+ * - recursively unsubscribe themselves from parent after their last subscriber
+ *   unsubscribed (configurable)
+ * - will go into a non-recoverable error state if none of the subscribers has
+ *   an error handler itself
+ * - implement the
+ *   [`IDeref`](https://docs.thi.ng/umbrella/api/interfaces/IDeref.html)
+ *   interface
  *
- * If a transducer is provided (via the `xform` option), all received
- * values will be first processed by the transducer and only its
- * transformed result(s) (if any) will be passed to downstream
- * subscribers. Any uncaught errors *inside* the transducer will cause
- * this subscription's error handler to be called and will stop this
- * subscription from receiving any further values (by default, unless
- * overridden).
+ * If a transducer is provided (via the `xform` option), all received values
+ * will be first processed by the transducer and only its transformed result(s)
+ * (if any) will be passed to downstream subscribers. Any uncaught errors
+ * *inside* the transducer will cause this subscription's error handler to be
+ * called and will stop this subscription from receiving any further values (by
+ * default, unless overridden).
  *
- * Subscription behavior can be customized via the additional (optional)
- * options arg. See {@link CommonOpts} and {@link SubscriptionOpts} for
- * further details.
+ * Subscription behavior can be customized via the additional (optional) options
+ * arg. See {@link CommonOpts} and {@link SubscriptionOpts} for further details.
  *
  * @example
  * ```ts
@@ -124,9 +123,10 @@ export class Subscription {
             : opts));
     }
     /**
-     * Syntax sugar for {@link Subscription.transform} when using a
-     * single {@link @thi.ng/transducers#map} transducer only. The given
-     * function `fn` is used as `map`'s transformation fn.
+     * Syntax sugar for {@link Subscription.transform} when using a single
+     * [`map()`](https://docs.thi.ng/umbrella/transducers/functions/map.html)
+     * transducer only. The given function `fn` is used as `map`'s
+     * transformation fn.
      *
      * @param fn -
      * @param opts -

package/sync.d.ts

@@ -87,9 +87,9 @@ export interface StreamSyncOpts<A extends IObjectOf<ISubscribable<any>>, B = Syn
  * option to `false`.
  *
  * The synchronization is done via the
- * {@link @thi.ng/transducers#(partitionSync:1)} transducer from the
- * {@link @thi.ng/transducers# | @thi.ng/transducers} package. See this
- * function's docs for further details.
+ * [`partitionSync()`](https://docs.thi.ng/umbrella/transducers/functions/partitionSync-1.html)
+ * transducer from the [`thi.ng/transducers`](https://thi.ng/transducers)
+ * package. See this function's docs for further details.
  *
  * @example
  * ```ts

package/sync.js

@@ -39,9 +39,9 @@ import { Subscription } from "./subscription.js";
  * option to `false`.
  *
  * The synchronization is done via the
- * {@link @thi.ng/transducers#(partitionSync:1)} transducer from the
- * {@link @thi.ng/transducers# | @thi.ng/transducers} package. See this
- * function's docs for further details.
+ * [`partitionSync()`](https://docs.thi.ng/umbrella/transducers/functions/partitionSync-1.html)
+ * transducer from the [`thi.ng/transducers`](https://thi.ng/transducers)
+ * package. See this function's docs for further details.
  *
  * @example
  * ```ts

package/tunnel.d.ts

@@ -21,9 +21,9 @@ export interface TunnelOpts<A> {
      */
     id?: string;
     /**
-     * Optional function to extract transferables from incoming stream
-     * values, e.g. ArrayBuffers. See:
-     * {@link https://developer.mozilla.org/en-US/docs/Web/API/Worker/postMessage}
+     * Optional function to extract transferables from incoming stream values,
+     * e.g. ArrayBuffers. See:
+     * https://developer.mozilla.org/en-US/docs/Web/API/Worker/postMessage
      */
     transferables?: Fn<A, any[]>;
     /**

package/view.d.ts

@@ -39,30 +39,31 @@ export type FromViewUnsafeOpts<T> = FromViewOpts<Path, any, T>;
  */
 export declare const fromViewUnsafe: <T>(atom: ReadonlyAtom<any>, opts: FromViewUnsafeOpts<T>) => Stream<T extends undefined ? any : T>;
 /**
- * Similar to {@link fromAtom}, but creates a type checked, eager
- * derived view for a nested value in an Atom-like state container and
- * yields stream of its value changes.
+ * Similar to {@link fromAtom}, but creates a type checked, eager derived view
+ * for a nested value in an Atom-like state container and yields stream of its
+ * value changes.
  *
  * @remarks
- * Stream value type is inferred from target path or (if given), the
- * result type of the optional view transformer (`tx` option).
+ * Stream value type is inferred from target path or (if given), the result type
+ * of the optional view transformer (`tx` option).
  *
- * Views are readonly and more lightweight versions of
- * {@link @thi.ng/atom#Cursor | cursors}. The view checks for value
- * changes with given `equiv` predicate (default:
- * {@link @thi.ng/equiv#equiv}). If the predicate returns a falsy result
- * (i.e. there's a new value), the new value is emitted on the stream.
- * The first value emitted is always the (possibly transformed) current
- * value at the stream's start time (i.e. when the first subscriber
- * attaches).
+ * Views are readonly and more lightweight versions of [thi.ng/atom
+ * cursors](https://docs.thi.ng/umbrella/atom/classes/Cursor.html). The view
+ * checks for value changes with given `equiv` predicate (default:
+ * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html)). If the
+ * predicate returns a falsy result (i.e. there's a new value), the new value is
+ * emitted on the stream. The first value emitted is always the (possibly
+ * transformed) current value at the stream's start time (i.e. when the first
+ * subscriber attaches).
  *
  * If the `tx` option is given, the raw value is first passed to this
  * transformer function and its result emitted on the stream instead.
  *
  * When the stream is cancelled the view is destroyed as well.
  *
- * Also see {@link @thi.ng/atom#defView},
- * {@link @thi.ng/atom#defViewUnsafe}
+ * Also see
+ * [`defView()`](https://docs.thi.ng/umbrella/atom/functions/defView.html),
+ * [`defViewUnsafe()`](https://docs.thi.ng/umbrella/atom/functions/defViewUnsafe.html)
  *
  * @example
  * ```ts