@thi.ng/transducers 8.3.25 → 8.3.27

package/interpolate.d.ts

@@ -1,23 +1,23 @@
 import type { Fn2 } from "@thi.ng/api";
 import type { Transducer } from "./api.js";
 /**
- * Higher order interpolation transducer. The resulting transducer forms
- * a sliding window and calls `fn` (the given interpolation function)
- * `n` times with the current window and a normalized time value to
- * produce the requested number of interpolated values per interval.
+ * Higher order interpolation transducer. The resulting transducer forms a
+ * sliding window and calls `fn` (the given interpolation function) `n` times
+ * with the current window and a normalized time value to produce the requested
+ * number of interpolated values per interval.
  *
  * @remarks
- * If the optional `src` iterable is given, `interpolate` returns an
- * iterator of interpolated values. No values will be produced if the
- * number of inputs is less than given `window` size.
+ * If the optional `src` iterable is given, `interpolate` returns an iterator of
+ * interpolated values. No values will be produced if the number of inputs is
+ * less than given `window` size.
  *
- * Note: The *very last* input value can never be fully reached and
- * might need to be explicitly duplicated in the input, e.g. via the
- * {@link extendSides} iterator...
+ * Note: The *very last* input value can never be fully reached and might need
+ * to be explicitly duplicated in the input, e.g. via the {@link extendSides}
+ * iterator...
  *
  * See also:
- * - {@link (interpolateHermite:1)}
- * - {@link (interpolateLinear:1)}
+ * - {@link interpolateHermite}
+ * - {@link interpolateLinear}
  * - {@link extendSides}
  *
  * @example

package/labeled.d.ts

@@ -1,5 +1,5 @@
 import type { Transducer } from "./api.js";
-export declare type LabelFn<L, T> = L | ((x: T) => L);
+export type LabelFn<L, T> = L | ((x: T) => L);
 export declare function labeled<L, T>(id: LabelFn<L, T>): Transducer<T, [L, T]>;
 export declare function labeled<L, T>(id: LabelFn<L, T>, src: Iterable<T>): IterableIterator<[L, T]>;
 //# sourceMappingURL=labeled.d.ts.map

package/line.d.ts

@@ -1,14 +1,14 @@
 /**
- * Iterator yielding `steps` + 1 interpolated values on a line in the
- * closed `[start .. end]` interval.
+ * Iterator yielding `steps` + 1 interpolated values on a line in the closed
+ * `[start .. end]` interval.
  *
  * @remarks
- * This is similar to {@link range}, but potentially provides more
- * precise values (by avoiding the accumulation of floating point errors
- * during iteration).
+ * This is similar to {@link range}, but potentially provides more precise
+ * values (by avoiding the accumulation of floating point errors during
+ * iteration).
  *
  * Similar functionality (w/ more options) is availble here:
- * {@link @thi.ng/dsp#line}.
+ * [`line()`](https://docs.thi.ng/umbrella/dsp/functions/line.html).
  *
  * @example
  * ```ts

package/line.js

@@ -1,16 +1,16 @@
 import { map } from "./map.js";
 import { normRange } from "./norm-range.js";
 /**
- * Iterator yielding `steps` + 1 interpolated values on a line in the
- * closed `[start .. end]` interval.
+ * Iterator yielding `steps` + 1 interpolated values on a line in the closed
+ * `[start .. end]` interval.
  *
  * @remarks
- * This is similar to {@link range}, but potentially provides more
- * precise values (by avoiding the accumulation of floating point errors
- * during iteration).
+ * This is similar to {@link range}, but potentially provides more precise
+ * values (by avoiding the accumulation of floating point errors during
+ * iteration).
  *
  * Similar functionality (w/ more options) is availble here:
- * {@link @thi.ng/dsp#line}.
+ * [`line()`](https://docs.thi.ng/umbrella/dsp/functions/line.html).
  *
  * @example
  * ```ts

package/map-indexed.d.ts

@@ -1,8 +1,8 @@
 import type { Fn2 } from "@thi.ng/api";
 import type { Transducer } from "./api.js";
 /**
- * Transducer. Similar to {@link (map:1)}, but given `fn` takes two
- * arguments: `index` and `value` to transform.
+ * Transducer. Similar to {@link map}, but given `fn` takes two arguments:
+ * `index` and `value` to transform.
  *
  * @remarks
  * An optional start index `offset` can be provided (default 0).

package/map-nth.d.ts

@@ -1,13 +1,12 @@
 import type { Fn } from "@thi.ng/api";
 import type { Transducer } from "./api.js";
 /**
- * Transducer. Similar to {@link (map:1)}, but only transforms every
- * `n`-th input value and passes intermediate values unchanged
- * downstream.
+ * Transducer. Similar to {@link map}, but only transforms every `n`-th input
+ * value and passes intermediate values unchanged downstream.
  *
  * @remarks
- * The optional `offset` arg can be used to adjust the
- * number of inputs before the first transformation occurs (default 0).
+ * The optional `offset` arg can be used to adjust the number of inputs before
+ * the first transformation occurs (default 0).
  *
  * @example
  * ```ts

package/map-vals.d.ts

@@ -1,13 +1,13 @@
 import type { Fn, IObjectOf } from "@thi.ng/api";
 import type { Transducer } from "./api.js";
 /**
- * Transducer. Similar to {@link (map:1)}, but expects object values and
- * the given function `fn` is applied to each enumerable property value
- * and the results reassigned to their original keys.
+ * Transducer. Similar to {@link map}, but expects object values and the given
+ * function `fn` is applied to each enumerable property value and the results
+ * reassigned to their original keys.
  *
  * @remarks
- * By default, a shallow copy of the source object is created. The
- * resulting object is then used as the result of this transducer.
+ * By default, a shallow copy of the source object is created. The resulting
+ * object is then used as the result of this transducer.
  *
  * @example
  * ```ts
@@ -16,8 +16,8 @@ import type { Transducer } from "./api.js";
  * ```
  *
  * @param fn -
- * @param copy - if true (default), creates a shallow copy of each
- * incoming value
+ * @param copy - if true (default), creates a shallow copy of each incoming
+ * value
  */
 export declare function mapVals<A, B>(fn: Fn<A, B>, copy?: boolean): Transducer<IObjectOf<A>, IObjectOf<B>>;
 export declare function mapVals<A, B>(fn: Fn<A, B>, src: Iterable<IObjectOf<A>>): IterableIterator<IObjectOf<B>>;

package/mapcat-indexed.d.ts

@@ -1,12 +1,12 @@
 import type { Fn2 } from "@thi.ng/api";
 import type { Transducer } from "./api.js";
 /**
- * Transducer. Similar to {@link (mapcat:1)}, but given `fn` takes two
- * arguments: `index` and `value` to transform.
+ * Transducer. Similar to {@link mapcat}, but given `fn` takes two arguments:
+ * `index` and `value` to transform.
  *
  * @remarks
  * An optional start index `offset` can be provided (default 0). Also see
- * {@link (mapIndexed:1)}.
+ * {@link mapIndexed}.
  *
  * @param fn - transformation function
  * @param offset - initial index

package/mapcat.d.ts

@@ -1,10 +1,10 @@
 import type { Fn } from "@thi.ng/api";
 import type { Transducer } from "./api.js";
 /**
- * Transducer. Similar to {@link (map:1)}, but expects the given mapping
- * function `fn` to return an iterable result (or `null`) and then emits
- * each value of the result individually downstream. `null` or
- * `undefined` result values will be skipped / omitted.
+ * Transducer. Similar to {@link map}, but expects the given mapping function
+ * `fn` to return an iterable result (or `null`) and then emits each value of
+ * the result individually downstream. `null` or `undefined` result values will
+ * be skipped / omitted.
  *
  * @example
  * ```

package/match-first.d.ts

@@ -10,7 +10,7 @@ import type { Transducer } from "./api.js";
  *
  * Yields none or only the first value which passed the predicate check
  * and then causes early termination. If `src` input is given, returns
- * first match found (or `undefined`). Also see {@link (matchLast:1)}.
+ * first match found (or `undefined`). Also see {@link matchLast}.
  *
  * @example
  * ```ts

package/moving-average.d.ts

@@ -1,16 +1,15 @@
 import type { Transducer } from "./api.js";
 /**
- * Computes the
- * {@link https://en.wikipedia.org/wiki/Moving_average#Simple_moving_average | Simple Moving Average}
+ * Computes the [Simple Moving
+ * Average](https://en.wikipedia.org/wiki/Moving_average#Simple_moving_average)
  * of given period.
  *
  * @remarks
- * The number of results will be `period-1` less than the number of
- * processed inputs and no outputs will be produced if there were less
- * than `period` input values.
+ * The number of results will be `period-1` less than the number of processed
+ * inputs and no outputs will be produced if there were less than `period` input
+ * values.
  *
- * Also see the
- * {@link @thi.ng/transducers-stats# | @thi.ng/transducers-stats}
+ * Also see the [thi.ng/transducers-stats](https://thi.ng/transducers-stats)
  * package for more optimized and alternative MA strategies.
  *
  * @param period -

package/moving-median.d.ts

@@ -1,11 +1,11 @@
 import type { SortOpts, Transducer } from "./api.js";
 /**
- * Transducer. Similar to {@link (movingAverage:1)}, but yields median
- * of sliding window and supports non-numeric inputs.
+ * Transducer. Similar to {@link movingAverage}, but yields median of sliding
+ * window and supports non-numeric inputs.
  *
  * @remarks
- * The optional `key` and `cmp` function options can be used to select /
- * compute a sortable value and change sorting behavior.
+ * The optional `key` and `cmp` function options can be used to select / compute
+ * a sortable value and change sorting behavior.
  *
  * @param n - window size
  * @param opts -

package/multiplex-obj.d.ts

@@ -1,7 +1,7 @@
 import type { IObjectOf } from "@thi.ng/api";
 import type { Reducer, Transducer, TxLike } from "./api.js";
 /**
- * Transducer. Similar to (and building on) {@link (multiplex:1)}, but takes an
+ * Transducer. Similar to (and building on) {@link multiplex}, but takes an
  * object of transducers and produces a result object for each input.
  *
  * @example

package/multiplex.d.ts

@@ -1,12 +1,12 @@
 import type { Transducer, TxLike } from "./api.js";
 /**
- * Yields a new transducer which applies given transducers in parallel
- * (using {@link @thi.ng/compose#(juxt:1)} & {@link step}) and produces
- * tuples of results.
+ * Yields a new transducer which applies given transducers in parallel (using
+ * [`juxt()`](https://docs.thi.ng/umbrella/compose/functions/juxt.html) &
+ * {@link step}) and produces tuples of results.
  *
  * @remarks
- * Use the {@link noop} transducer for processing lanes which should
- * retain the original input values.
+ * Use the {@link noop} transducer for processing lanes which should retain the
+ * original input values.
  *
  * @example
  * ```ts

package/noop.d.ts

@@ -1,8 +1,8 @@
 import type { Transducer } from "./api.js";
 /**
- * No-op / pass-through transducer, essentially the same as:
- * `map((x) => x)`, but faster. Useful for testing and / or to keep
- * existing values in a {@link (multiplex:1)} tuple lane.
+ * No-op / pass-through transducer, essentially the same as: `map((x) => x)`,
+ * but faster. Useful for testing and / or to keep existing values in a
+ * {@link multiplex} tuple lane.
  */
 export declare const noop: <T>() => Transducer<T, T>;
 //# sourceMappingURL=noop.d.ts.map

package/noop.js

@@ -1,6 +1,6 @@
 /**
- * No-op / pass-through transducer, essentially the same as:
- * `map((x) => x)`, but faster. Useful for testing and / or to keep
- * existing values in a {@link (multiplex:1)} tuple lane.
+ * No-op / pass-through transducer, essentially the same as: `map((x) => x)`,
+ * but faster. Useful for testing and / or to keep existing values in a
+ * {@link multiplex} tuple lane.
  */
 export const noop = () => (rfn) => rfn;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/transducers",
-  "version": "8.3.25",
+  "version": "8.3.27",
   "description": "Lightweight transducer implementations for ES6 / TypeScript",
   "type": "module",
   "module": "./index.js",
@@ -21,7 +21,11 @@
       "url": "https://patreon.com/thing_umbrella"
     }
   ],
-  "author": "Karsten Schmidt <k+npm@thi.ng>",
+  "author": "Karsten Schmidt (https://thi.ng)",
+  "contributors": [
+    "Gavin Cannizzaro (https://github.com/gavinpc-mindgrub)",
+    "@nkint (https://github.com/nkint)"
+  ],
   "license": "Apache-2.0",
   "scripts": {
     "build": "yarn clean && tsc --declaration",
@@ -34,22 +38,22 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.5.1",
-    "@thi.ng/arrays": "^2.4.4",
-    "@thi.ng/checks": "^3.3.4",
-    "@thi.ng/compare": "^2.1.18",
-    "@thi.ng/compose": "^2.1.20",
-    "@thi.ng/errors": "^2.2.5",
-    "@thi.ng/math": "^5.3.15",
-    "@thi.ng/random": "^3.3.17"
+    "@thi.ng/api": "^8.6.1",
+    "@thi.ng/arrays": "^2.4.6",
+    "@thi.ng/checks": "^3.3.5",
+    "@thi.ng/compare": "^2.1.20",
+    "@thi.ng/compose": "^2.1.22",
+    "@thi.ng/errors": "^2.2.6",
+    "@thi.ng/math": "^5.3.17",
+    "@thi.ng/random": "^3.3.19"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.33.5",
-    "@thi.ng/testament": "^0.3.6",
+    "@microsoft/api-extractor": "^7.33.7",
+    "@thi.ng/testament": "^0.3.7",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.20",
-    "typescript": "^4.8.4"
+    "typedoc": "^0.23.22",
+    "typescript": "^4.9.4"
   },
   "keywords": [
     "2d",
@@ -567,5 +571,5 @@
     ],
     "year": 2016
   },
-  "gitHead": "1fe40da507070653f420156d91e6b27cf682004f\n"
+  "gitHead": "7b2af448da8a63fb21704a79cc4cdf1f3d7d7a64\n"
 }

package/page.d.ts

@@ -1,12 +1,11 @@
 import type { Transducer } from "./api.js";
 /**
- * Pagination helper. Returns transducer which extracts only items for
- * given page number (and page length, default 10).
+ * Pagination helper. Returns transducer which extracts only items for given
+ * page number (and page length, default 10).
  *
  * @remarks
- * When {@link (comp:1) | composing} with other transducers, it's most
- * efficient if `page` is used as early as possible / prior to any heavy
- * processing steps.
+ * When {@link comp}osing with other transducers, it's most efficient if `page`
+ * is used as early as possible / prior to any heavy processing steps.
  *
  * @example
  * ```ts

package/pairs.d.ts

@@ -1,11 +1,11 @@
 import type { IObjectOf } from "@thi.ng/api";
 /**
- * Iterator yielding key-value pairs of given object's own properties
- * and their values. Same as `zip(keys(x), vals(x))`.
+ * Iterator yielding key-value pairs of given object's own properties and their
+ * values. Same as `zip(keys(x), vals(x))`.
  *
  * @remarks
  * - {@link vals}
- * - {@link (zip:1)}
+ * - {@link zip}
  *
  * @example
  * ```ts

package/pairs.js

@@ -1,10 +1,10 @@
 /**
- * Iterator yielding key-value pairs of given object's own properties
- * and their values. Same as `zip(keys(x), vals(x))`.
+ * Iterator yielding key-value pairs of given object's own properties and their
+ * values. Same as `zip(keys(x), vals(x))`.
  *
  * @remarks
  * - {@link vals}
- * - {@link (zip:1)}
+ * - {@link zip}
  *
  * @example
  * ```ts

package/partition-sort.d.ts

@@ -1,7 +1,7 @@
 import type { SortOpts, Transducer } from "./api.js";
 /**
- * Transducer. Composition of {@link (partition:1)} and
- * {@link (mapcat:1)} which yields a **partially** sorted sequence of
+ * Transducer. Composition of {@link partition} and
+ * {@link mapcat} which yields a **partially** sorted sequence of
  * input values. Sorting is performed on sliding / non-overlapping
  * chunks of `n` inputs.
  *

package/partition-time.d.ts

@@ -1,16 +1,15 @@
 import type { Transducer } from "./api.js";
 /**
- * Transducer. Yields tumbling, non-overlapping windows/partitions of
- * input values, with the window size defined by given realtime `period`
- * (in milliseconds).
+ * Transducer. Yields tumbling, non-overlapping windows/partitions of input
+ * values, with the window size defined by given realtime `period` (in
+ * milliseconds).
  *
  * @remarks
- * Only to be used in async contexts, NOT with {@link (transduce:1)}
- * directly.
+ * Only to be used in async contexts, NOT with {@link transduce} directly.
  *
  * Also see:
- * - {@link @thi.ng/rstream# | @thi.ng/rstream}
- * - {@link @thi.ng/csp# | @thi.ng/csp}.
+ * - [`thi.ng/rstream`](https://thi.ng/rstream)
+ * - [`thi.ng/csp`](https://thi.ng/csp).
  *
  * @example
  * ```ts

package/peek.d.ts

@@ -1,7 +1,8 @@
 import type { Transducer } from "./api.js";
 /**
- * Transducer version of {@link @thi.ng/api#peek}, i.e. extracts the
- * last item of an array.
+ * Transducer version of
+ * [`peek()`](https://docs.thi.ng/umbrella/api/functions/peek.html), i.e.
+ * extracts the last item of an array.
  *
  * @example
  * ```ts

package/push-sort.d.ts

@@ -1,9 +1,9 @@
 import type { Comparator } from "@thi.ng/api";
 import type { Reducer } from "./api.js";
 /**
- * Similar to {@link (push:1)}, but sorts result array upon completion
- * using optionally given comparator (default
- * {@link @thi.ng/compare#compare}).
+ * Similar to {@link push}, but sorts result array upon completion using
+ * optionally given comparator (default
+ * [`compare()`](https://docs.thi.ng/umbrella/compare/functions/compare.html)).
  *
  * @param cmp -
  */

package/range.d.ts

@@ -5,9 +5,9 @@ export declare function range(to: number): Range;
 export declare function range(from: number, to: number): Range;
 export declare function range(from: number, to: number, step: number): Range;
 /**
- * Simple class wrapper around given range interval and implementing
- * `Iterable` and {@link IReducible} interfaces, the latter is used to
- * accelerate use with {@link (reduce:1)}.
+ * Simple class wrapper around given range interval and implementing `Iterable`
+ * and {@link IReducible} interfaces, the latter is used to accelerate use with
+ * {@link reduce}.
  */
 export declare class Range implements Iterable<number>, IReducible<any, number> {
     protected from: number;

package/range.js

@@ -3,9 +3,9 @@ export function range(from, to, step) {
     return new Range(from, to, step);
 }
 /**
- * Simple class wrapper around given range interval and implementing
- * `Iterable` and {@link IReducible} interfaces, the latter is used to
- * accelerate use with {@link (reduce:1)}.
+ * Simple class wrapper around given range interval and implementing `Iterable`
+ * and {@link IReducible} interfaces, the latter is used to accelerate use with
+ * {@link reduce}.
  */
 export class Range {
     constructor(from, to, step) {

package/sample.d.ts

@@ -3,7 +3,7 @@ import type { Transducer } from "./api.js";
 /**
  * Transducer which only yields values with given `prob` probability
  * (0.0 .. 1.0 range). Supports custom PRNGs via
- * {@link @thi.ng/random#IRandom} interface.
+ * [`IRandom`](https://docs.thi.ng/umbrella/random/interfaces/IRandom.html) interface.
  *
  * @example
  * ```ts

package/scan.d.ts

@@ -8,7 +8,7 @@ import type { Reducer, Transducer } from "./api.js";
  * default.
  *
  * @remarks
- * {@link https://en.wikipedia.org/wiki/Prefix_sum#Scan_higher_order_function}
+ * https://en.wikipedia.org/wiki/Prefix_sum#Scan_higher_order_function
  *
  * @example
  * ```ts

package/select-keys.d.ts

@@ -1,11 +1,11 @@
 import type { Transducer } from "./api.js";
 /**
- * Transducer which yields sequence of transformed objects, each only
- * only containing the given `keys`. If a key's value is `undefined` (or
- * missing entirely) it will be omitted in the result.
+ * Transducer which yields sequence of transformed objects, each only only
+ * containing the given `keys`. If a key's value is `undefined` (or missing
+ * entirely) it will be omitted in the result.
  *
  * @remarks
- * For single key extraction {@link (pluck:1)} is a faster alternative.
+ * For single key extraction {@link pluck} is a faster alternative.
  *
  * @example
  * ```ts

package/some.d.ts

@@ -1,9 +1,9 @@
 import type { Predicate } from "@thi.ng/api";
 import type { Reducer } from "./api.js";
 /**
- * Similar to {@link (every:1)} reducer, but only requires at least 1 value to
- * succeed predicate test (and then immediately terminates with `true`
- * as result).
+ * Similar to {@link every} reducer, but only requires at least 1 value to
+ * succeed predicate test (and then immediately terminates with `true` as
+ * result).
  *
  * @param pred -
  */

package/sorted-keys.d.ts

@@ -1,8 +1,9 @@
 import type { Comparator } from "@thi.ng/api";
 /**
- * Syntax sugar for `Object.keys(x).sort()` with support for custom
- * comparator (default: {@link @thi.ng/compare#compare}) and yielding
- * iterator of sorted keys.
+ * Syntax sugar for `Object.keys(x).sort()` with support for custom comparator
+ * (default:
+ * [`compare()`](https://docs.thi.ng/umbrella/compare/functions/compare.html))
+ * and yielding iterator of sorted keys.
  *
  * @param x -
  * @param cmp -

package/sorted-keys.js

@@ -1,8 +1,9 @@
 import { compare } from "@thi.ng/compare/compare";
 /**
- * Syntax sugar for `Object.keys(x).sort()` with support for custom
- * comparator (default: {@link @thi.ng/compare#compare}) and yielding
- * iterator of sorted keys.
+ * Syntax sugar for `Object.keys(x).sort()` with support for custom comparator
+ * (default:
+ * [`compare()`](https://docs.thi.ng/umbrella/compare/functions/compare.html))
+ * and yielding iterator of sorted keys.
  *
  * @param x -
  * @param cmp -

package/stream-sort.d.ts

@@ -1,8 +1,8 @@
 import type { SortOpts, Transducer } from "./api.js";
 /**
- * Transducer. Similar to {@link (partitionSort:1)}, however uses proper
- * sliding window and insertion sort instead of fully sorting window as
- * done by `partitionSort`.
+ * Transducer. Similar to {@link partitionSort}, however uses proper sliding
+ * window and insertion sort instead of fully sorting window as done by
+ * `partitionSort`.
  *
  * @example
  * ```ts

package/swizzle.d.ts

@@ -1,8 +1,7 @@
 import type { Transducer } from "./api.js";
 /**
- * Transducer which performs value reordering on inputs using provided
- * property order. Accepts arrays or objects as input, but always yields
- * arrays.
+ * Transducer which performs value reordering on inputs using provided property
+ * order. Accepts arrays or objects as input, but always yields arrays.
  *
  * @example
  * ```ts
@@ -16,7 +15,9 @@ import type { Transducer } from "./api.js";
  * // [ [ 3, 1 ] ]
  * ```
  *
- * {@link @thi.ng/arrays#swizzle}
+ * @remarks
+ * Also see
+ * [`swizzle()`](https://docs.thi.ng/umbrella/arrays/functions/swizzle.html)
  *
  * @param order - key order
  */

package/throttle-time.d.ts

@@ -1,15 +1,14 @@
 import type { Transducer } from "./api.js";
 /**
- * Time-based version of {@link (throttle:1)}. Ignores any new values in
- * the `delay` interval since the last accepted value.
+ * Time-based version of {@link throttle}. Ignores any new values in the `delay`
+ * interval since the last accepted value.
  *
  * @remarks
- * Only to be used in async contexts and NOT with {@link (transduce:1)}
- * directly.
+ * Only to be used in async contexts and NOT with {@link transduce} directly.
  *
  * Also see:
- * - {@link @thi.ng/rstream# | @thi.ng/rstream}
- * - {@link @thi.ng/csp# | @thi.ng/csp}.
+ * - [`thi.ng/rstream`](https://thi.ng/rstream)
+ * - [`thi.ng/csp`](https://thi.ng/csp).
  *
  * @param delay -
  */