@thi.ng/transducers 8.3.26 → 8.3.28

package/CHANGELOG.md

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

package/README.md

@@ -59,7 +59,7 @@ This project is part of the
 
 ## About
 
-Lightweight transducer implementations for ES6 / TypeScript
+Lightweight transducer implementations for ES6 / TypeScript.
 
 This library provides altogether ~130 transducers, reducers, sequence
 generators (ES6 generators/iterators) and additional supporting

package/cat.d.ts

@@ -1,20 +1,20 @@
 import type { Nullable } from "@thi.ng/api";
 import type { Transducer } from "./api.js";
 /**
- * Transducer to concatenate iterable values. Iterates over each input
- * and emits individual values down stream, therefore removing one level
- * of nesting from the input.
+ * Transducer to concatenate iterable values. Iterates over each input and emits
+ * individual values down stream, therefore removing one level of nesting from
+ * the input.
  *
  * @remarks
- * If, during processing, the transducer is given a wrapped reduced
- * input iterable, it will still be processed as normal, but then
- * immediately triggers early termination by wrapping its own result in
- * {@link reduced}. E.g. this behavior allows a {@link (mapcat:1)} user
- * functions to benefit from reduced results.
+ * If, during processing, the transducer is given a wrapped reduced input
+ * iterable, it will still be processed as normal, but then immediately triggers
+ * early termination by wrapping its own result in {@link reduced}. E.g. this
+ * behavior allows a {@link mapcat} user functions to benefit from reduced
+ * results.
  *
  * Also see:
  * - {@link concat}
- * - {@link (mapcat:1)}
+ * - {@link mapcat}
  *
  * @example
  * ```ts

package/cat.js

@@ -1,20 +1,20 @@
 import { compR } from "./compr.js";
 import { ensureReduced, isReduced, unreduced } from "./reduced.js";
 /**
- * Transducer to concatenate iterable values. Iterates over each input
- * and emits individual values down stream, therefore removing one level
- * of nesting from the input.
+ * Transducer to concatenate iterable values. Iterates over each input and emits
+ * individual values down stream, therefore removing one level of nesting from
+ * the input.
  *
  * @remarks
- * If, during processing, the transducer is given a wrapped reduced
- * input iterable, it will still be processed as normal, but then
- * immediately triggers early termination by wrapping its own result in
- * {@link reduced}. E.g. this behavior allows a {@link (mapcat:1)} user
- * functions to benefit from reduced results.
+ * If, during processing, the transducer is given a wrapped reduced input
+ * iterable, it will still be processed as normal, but then immediately triggers
+ * early termination by wrapping its own result in {@link reduced}. E.g. this
+ * behavior allows a {@link mapcat} user functions to benefit from reduced
+ * results.
  *
  * Also see:
  * - {@link concat}
- * - {@link (mapcat:1)}
+ * - {@link mapcat}
  *
  * @example
  * ```ts

package/choices.d.ts

@@ -1,8 +1,8 @@
 import type { IRandom } from "@thi.ng/random";
 /**
- * Returns an infinite iterator of random choices and their (optional)
- * weights. If `weights` is given, it must have at least the same size
- * as `choices`. If omitted, each choice will have same probability.
+ * Returns an infinite iterator of random choices and their (optional) weights.
+ * If `weights` is given, it must have at least the same size as `choices`. If
+ * omitted, each choice will have same probability.
  *
  * @example
  * ```ts
@@ -10,7 +10,7 @@ import type { IRandom } from "@thi.ng/random";
  * // Map { 'c' => 132, 'a' => 545, 'b' => 251, 'd' => 72 }
  * ```
  *
- * {@link @thi.ng/random#weightedRandom}
+ * [`weightedRandom()`](https://docs.thi.ng/umbrella/random/functions/weightedRandom.html)
  *
  * @param choices -
  * @param weights -

package/choices.js

@@ -3,9 +3,9 @@ import { SYSTEM } from "@thi.ng/random/system";
 import { weightedRandom } from "@thi.ng/random/weighted-random";
 import { repeatedly } from "./repeatedly.js";
 /**
- * Returns an infinite iterator of random choices and their (optional)
- * weights. If `weights` is given, it must have at least the same size
- * as `choices`. If omitted, each choice will have same probability.
+ * Returns an infinite iterator of random choices and their (optional) weights.
+ * If `weights` is given, it must have at least the same size as `choices`. If
+ * omitted, each choice will have same probability.
  *
  * @example
  * ```ts
@@ -13,7 +13,7 @@ import { repeatedly } from "./repeatedly.js";
  * // Map { 'c' => 132, 'a' => 545, 'b' => 251, 'd' => 72 }
  * ```
  *
- * {@link @thi.ng/random#weightedRandom}
+ * [`weightedRandom()`](https://docs.thi.ng/umbrella/random/functions/weightedRandom.html)
  *
  * @param choices -
  * @param weights -

package/conj.d.ts

@@ -1,6 +1,6 @@
 import type { Reducer } from "./api.js";
 /**
- * Reducer. Like {@link (push:1)}, but for ES6 Sets.
+ * Reducer. Like {@link push}, but for ES6 Sets.
  */
 export declare function conj<T>(): Reducer<Set<T>, T>;
 export declare function conj<T>(xs: Iterable<T>): Set<T>;

package/converge.d.ts

@@ -1,18 +1,18 @@
 import type { Predicate2 } from "@thi.ng/api";
 import type { Transducer } from "./api.js";
 /**
- * Transducer which for each input `x` (apart from the very first one)
- * applies given predicate `pred` to previous input and `x`. Only passes
- * values downstream as long as the predicate returns a falsy result.
- * Once the result is truthy, `x` is considered converged and the
- * transformation is terminated (by emitting a {@link reduced} value).
+ * Transducer which for each input `x` (apart from the very first one) applies
+ * given predicate `pred` to previous input and `x`. Only passes values
+ * downstream as long as the predicate returns a falsy result. Once the result
+ * is truthy, `x` is considered converged and the transformation is terminated
+ * (by emitting a {@link reduced} value).
  *
  * @remarks
- * This can be used to limit processing of inputs only as long as
- * there're noticeable changes (according to the predicate) and then
- * stop the transducer pipeline once results have converged.
+ * This can be used to limit processing of inputs only as long as there're
+ * noticeable changes (according to the predicate) and then stop the transducer
+ * pipeline once results have converged.
  *
- * See also: {@link (takeWhile:1)}
+ * See also: {@link takeWhile}
  *
  * @example
  * ```ts

package/curve.d.ts

@@ -1,17 +1,17 @@
 /**
- * Iterator producing an exponential curve (with adjustable curvature)
- * between `start` and `end` values over `num` steps. This is the
- * exponential equivalent of {@link line}.
+ * Iterator producing an exponential curve (with adjustable curvature) between
+ * `start` and `end` values over `num` steps. This is the exponential equivalent
+ * of {@link line}.
  *
  * @remarks
- * Since `start` is the first value emitted, the `end` value is only
- * reached in the `num+1`th step.
+ * Since `start` is the first value emitted, the `end` value is only reached in
+ * the `num+1`th step.
  *
- * The curvature can be controlled via the logarithmic `rate` param.
- * Recommended range [0.0001 - 10000] (curved -> linear). Default: 0.1
+ * The curvature can be controlled via the logarithmic `rate` param. Recommended
+ * range [0.0001 - 10000] (curved -> linear). Default: 0.1
  *
  * Similar functionality (w/ more options) is availble here:
- * {@link @thi.ng/dsp#curve}.
+ * [`curve()`](https://docs.thi.ng/umbrella/dsp/functions/curve.html).
  *
  * @example
  * ```ts

package/curve.js

@@ -1,17 +1,17 @@
 /**
- * Iterator producing an exponential curve (with adjustable curvature)
- * between `start` and `end` values over `num` steps. This is the
- * exponential equivalent of {@link line}.
+ * Iterator producing an exponential curve (with adjustable curvature) between
+ * `start` and `end` values over `num` steps. This is the exponential equivalent
+ * of {@link line}.
  *
  * @remarks
- * Since `start` is the first value emitted, the `end` value is only
- * reached in the `num+1`th step.
+ * Since `start` is the first value emitted, the `end` value is only reached in
+ * the `num+1`th step.
  *
- * The curvature can be controlled via the logarithmic `rate` param.
- * Recommended range [0.0001 - 10000] (curved -> linear). Default: 0.1
+ * The curvature can be controlled via the logarithmic `rate` param. Recommended
+ * range [0.0001 - 10000] (curved -> linear). Default: 0.1
  *
  * Similar functionality (w/ more options) is availble here:
- * {@link @thi.ng/dsp#curve}.
+ * [`curve()`](https://docs.thi.ng/umbrella/dsp/functions/curve.html).
  *
  * @example
  * ```ts

package/deep-transform.d.ts

@@ -1,11 +1,11 @@
 import type { TransformSpec } from "./api.js";
 /**
- * Higher-order deep object transformer used by {@link (mapDeep:1)}.
- * Accepts a nested `spec` array reflecting same key structure as the
- * object to be mapped, but with functions or sub-specs as their values.
- * Returns a new function, which when called, recursively applies nested
- * transformers in post-order traversal (child transformers are run
- * first) and returns the result of the root transformer.
+ * Higher-order deep object transformer used by {@link mapDeep}. Accepts a
+ * nested `spec` array reflecting same key structure as the object to be mapped,
+ * but with functions or sub-specs as their values. Returns a new function,
+ * which when called, recursively applies nested transformers in post-order
+ * traversal (child transformers are run first) and returns the result of the
+ * root transformer.
  *
  * @remarks
  * The transform specs are given as arrays in this format:
@@ -14,9 +14,8 @@ import type { TransformSpec } from "./api.js";
  * [tx-function, { key1: [tx-function, {...}], key2: tx-fn }]
  * ```
  *
- * If a key in the spec has no further sub maps, its transform function
- * can be given directly without having to wrap it into the usual array
- * structure.
+ * If a key in the spec has no further sub maps, its transform function can be
+ * given directly without having to wrap it into the usual array structure.
  *
  * @example
  * ```ts

package/deep-transform.js

@@ -1,11 +1,11 @@
 import { isFunction } from "@thi.ng/checks/is-function";
 /**
- * Higher-order deep object transformer used by {@link (mapDeep:1)}.
- * Accepts a nested `spec` array reflecting same key structure as the
- * object to be mapped, but with functions or sub-specs as their values.
- * Returns a new function, which when called, recursively applies nested
- * transformers in post-order traversal (child transformers are run
- * first) and returns the result of the root transformer.
+ * Higher-order deep object transformer used by {@link mapDeep}. Accepts a
+ * nested `spec` array reflecting same key structure as the object to be mapped,
+ * but with functions or sub-specs as their values. Returns a new function,
+ * which when called, recursively applies nested transformers in post-order
+ * traversal (child transformers are run first) and returns the result of the
+ * root transformer.
  *
  * @remarks
  * The transform specs are given as arrays in this format:
@@ -14,9 +14,8 @@ import { isFunction } from "@thi.ng/checks/is-function";
  * [tx-function, { key1: [tx-function, {...}], key2: tx-fn }]
  * ```
  *
- * If a key in the spec has no further sub maps, its transform function
- * can be given directly without having to wrap it into the usual array
- * structure.
+ * If a key in the spec has no further sub maps, its transform function can be
+ * given directly without having to wrap it into the usual array structure.
  *
  * @example
  * ```ts

package/delayed.d.ts

@@ -1,11 +1,10 @@
 import type { Transducer } from "./api.js";
 /**
- * Yields transducer which wraps incoming values in promises, which each
- * resolve after specified delay time (in ms).
+ * Yields transducer which wraps incoming values in promises, which each resolve
+ * after specified delay time (in ms).
  *
  * @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.
  *
  * @param t -
  */

package/delayed.js

@@ -1,12 +1,11 @@
 import { delayed as _delayed } from "@thi.ng/compose/delayed";
 import { map } from "./map.js";
 /**
- * Yields transducer which wraps incoming values in promises, which each
- * resolve after specified delay time (in ms).
+ * Yields transducer which wraps incoming values in promises, which each resolve
+ * after specified delay time (in ms).
  *
  * @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.
  *
  * @param t -
  */

package/fill.d.ts

@@ -1,9 +1,9 @@
 import type { NumericArray } from "@thi.ng/api";
 import type { Reducer } from "./api.js";
 /**
- * Reducer which starts filling array with results from given `start`
- * index (default: 0). Use {@link (fillN:1)} for typed array targets
- * (same impl, but provides correct result type).
+ * Reducer which starts filling array with results from given `start` index
+ * (default: 0). Use {@link fillN} for typed array targets (same impl, but
+ * provides correct result type).
  *
  * @param start -
  */
@@ -11,8 +11,7 @@ export declare function fill<T>(start?: number): Reducer<T[], T>;
 export declare function fill<T>(xs: Iterable<T>): T[];
 export declare function fill<T>(start: number, xs: Iterable<T>): T[];
 /**
- * Like {@link (fill:1)} reducer, but for numeric arrays (incl. typed
- * arrays).
+ * Like {@link fill} reducer, but for numeric arrays (incl. typed arrays).
  *
  * @param start -
  */

package/filter-fuzzy.d.ts

@@ -11,14 +11,16 @@ export interface FilterFuzzyOpts<A, B> {
     equiv: Predicate2<any>;
 }
 /**
- * Returns transducer which calls {@link @thi.ng/arrays#fuzzyMatch} for
- * each value and discards all non-matching values.
+ * Returns transducer which calls
+ * [`fuzzyMatch()`](https://docs.thi.ng/umbrella/arrays/functions/fuzzyMatch.html)
+ * for each value and discards all non-matching values.
  *
  * @remarks
- * The `key` option function can be used to extract/produce the actual
- * value used for the search. The `equiv` option predicate can be used
- * to customize item equality checking. Uses {@link @thi.ng/equiv#equiv}
- * by default.
+ * The `key` option function can be used to extract/produce the actual value
+ * used for the search. The `equiv` option predicate can be used to customize
+ * item equality checking. Uses
+ * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) by
+ * default.
  *
  * @example
  * ```ts

package/group-binary.d.ts

@@ -1,19 +1,18 @@
 import type { Fn, Fn0, IObjectOf } from "@thi.ng/api";
 import type { Reducer } from "./api.js";
 /**
- * Creates a bottom-up, unbalanced binary tree of desired depth and
- * choice of data structures. Any value can be indexed, as long as a
- * numeric representation (key) can be obtained. This numeric key is
- * produced by the supplied `key` function. IMPORTANT: the returned
- * values MUST be unsigned and less than the provided bit length (i.e.
- * `0 .. (2^bits) - 1` range).
+ * Creates a bottom-up, unbalanced binary tree of desired depth and choice of
+ * data structures. Any value can be indexed, as long as a numeric
+ * representation (key) can be obtained. This numeric key is produced by the
+ * supplied `key` function. IMPORTANT: the returned values MUST be unsigned and
+ * less than the provided bit length (i.e. `0 .. (2^bits) - 1` range).
  *
- * By default the tree is constructed using plain objects for branches,
- * with left branches stored as "l" and right ones as "r". The original
- * values are stored at the lowest tree level using a customizable
- * nested reducer. By default leaves are collected in arrays (using the
- * {@link (push:1)} reducer), but any suitable reducer can be used (e.g.
- * {@link (conj:1)} to collect values into sets).
+ * By default the tree is constructed using plain objects for branches, with
+ * left branches stored as "l" and right ones as "r". The original values are
+ * stored at the lowest tree level using a customizable nested reducer. By
+ * default leaves are collected in arrays (using the {@link push} reducer), but
+ * any suitable reducer can be used (e.g. {@link conj} to collect values into
+ * sets).
  *
  * Index by lowest 4-bits of ID value:
  *
@@ -48,7 +47,7 @@ import type { Reducer } from "./api.js";
  * // [ [ 6 ], [ 7 ] ]
  * ```
  *
- * Using {@link (frequencies:1)} as leaf reducer:
+ * Using {@link frequencies} as leaf reducer:
  *
  * @example
  * ```ts
@@ -68,8 +67,7 @@ import type { Reducer } from "./api.js";
  *
  * @param bits - index range (always from 0)
  * @param key - key function
- * @param branch - function to create a new branch container (object or
- * array)
+ * @param branch - function to create a new branch container (object or array)
  * @param leaf - reducer for leaf collection
  * @param left - key for storing left branches (e.g. `0` for arrays)
  * @param right - key for storing right branches (e.g. `1` for arrays)

package/group-binary.js

@@ -2,19 +2,18 @@ import { groupByObj } from "./group-by-obj.js";
 import { push } from "./push.js";
 const branchPred = (key, b, l, r) => (x) => key(x) & b ? r : l;
 /**
- * Creates a bottom-up, unbalanced binary tree of desired depth and
- * choice of data structures. Any value can be indexed, as long as a
- * numeric representation (key) can be obtained. This numeric key is
- * produced by the supplied `key` function. IMPORTANT: the returned
- * values MUST be unsigned and less than the provided bit length (i.e.
- * `0 .. (2^bits) - 1` range).
+ * Creates a bottom-up, unbalanced binary tree of desired depth and choice of
+ * data structures. Any value can be indexed, as long as a numeric
+ * representation (key) can be obtained. This numeric key is produced by the
+ * supplied `key` function. IMPORTANT: the returned values MUST be unsigned and
+ * less than the provided bit length (i.e. `0 .. (2^bits) - 1` range).
  *
- * By default the tree is constructed using plain objects for branches,
- * with left branches stored as "l" and right ones as "r". The original
- * values are stored at the lowest tree level using a customizable
- * nested reducer. By default leaves are collected in arrays (using the
- * {@link (push:1)} reducer), but any suitable reducer can be used (e.g.
- * {@link (conj:1)} to collect values into sets).
+ * By default the tree is constructed using plain objects for branches, with
+ * left branches stored as "l" and right ones as "r". The original values are
+ * stored at the lowest tree level using a customizable nested reducer. By
+ * default leaves are collected in arrays (using the {@link push} reducer), but
+ * any suitable reducer can be used (e.g. {@link conj} to collect values into
+ * sets).
  *
  * Index by lowest 4-bits of ID value:
  *
@@ -49,7 +48,7 @@ const branchPred = (key, b, l, r) => (x) => key(x) & b ? r : l;
  * // [ [ 6 ], [ 7 ] ]
  * ```
  *
- * Using {@link (frequencies:1)} as leaf reducer:
+ * Using {@link frequencies} as leaf reducer:
  *
  * @example
  * ```ts
@@ -69,8 +68,7 @@ const branchPred = (key, b, l, r) => (x) => key(x) & b ? r : l;
  *
  * @param bits - index range (always from 0)
  * @param key - key function
- * @param branch - function to create a new branch container (object or
- * array)
+ * @param branch - function to create a new branch container (object or array)
  * @param leaf - reducer for leaf collection
  * @param left - key for storing left branches (e.g. `0` for arrays)
  * @param right - key for storing right branches (e.g. `1` for arrays)

package/interpolate-hermite.d.ts

@@ -1,21 +1,21 @@
 import type { Transducer } from "./api.js";
 /**
- * Pre-configured version of {@link (interpolate:1)} for numeric values
- * and using cubic hermite interpolation.
+ * Pre-configured version of {@link interpolate} for numeric values and using
+ * cubic hermite interpolation.
  *
  * @remarks
  * The number of samples per interval is configurable. No values will be
  * produced if there're less than 4 inputs.
  *
- * Note: Due to the nature of hermite interpolation, the very first and
- * last input are only used to compute the curve tangents, but will not
- * appear in the output. Use the {@link extendSides} iterator to
- * transform the input so that these values are duplicated and so are
- * used as part of an interpolation interval.
+ * Note: Due to the nature of hermite interpolation, the very first and last
+ * input are only used to compute the curve tangents, but will not appear in the
+ * output. Use the {@link extendSides} iterator to transform the input so that
+ * these values are duplicated and so are used as part of an interpolation
+ * interval.
  *
  * See also:
- * - {@link (interpolate:1)}
- * - {@link (interpolateLinear:1)}
+ * - {@link interpolate}
+ * - {@link interpolateLinear}
  * - {@link extendSides}
  *
  * @param n -

package/interpolate-linear.d.ts

@@ -1,15 +1,15 @@
 import type { Transducer } from "./api.js";
 /**
- * Pre-configured version of {@link (interpolate:1)} for numeric values
- * and using pairwise linear interpolation.
+ * Pre-configured version of {@link interpolate} for numeric values and using
+ * pairwise linear interpolation.
  *
  * @remarks
  * The number of samples per interval is configurable. No values will be
  * produced if there're less than 2 inputs.
  *
  * See also:
- * - {@link (interpolate:1)}
- * - {@link (interpolateHermite:1)}
+ * - {@link interpolate}
+ * - {@link interpolateHermite}
  *
  * @param n -
  */

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/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