rubico 2.2.1 → 2.2.3

package/transform.js

@@ -21,23 +21,32 @@ const _transform = function (collection, transducer, initialValue) {
  *
  * @synopsis
  * ```coffeescript [specscript]
- * type Reducer = (result any, item any)=>(result any)
- * type Transducer = Reducer=>Reducer
- * type Transformable = Array|String|Set|TypedArray|{ concat: function }|{ write: function }|Object
  * type Foldable = Iterable|AsyncIterable|Object<value any>
  *
- * initialValue Transformable|((foldable Foldable)=>Promise|Transformable)
+ * type Reducer = (
+ *   accumulator any,
+ *   value any,
+ *   indexOrKey? number|string,
+ *   collection? Foldable,
+ * )=>(nextAccumulator Promise|any)
+ *
+ * type Transducer = Reducer=>Reducer
+ *
+ * type Transformable =
+ *   Array|String|Set|TypedArray|{ concat: function }|{ write: function }|Object
+ *
+ * type TransformableResolver = (collection Foldable)=>Promise|Transformable
  *
  * transform(
- *   foldable Foldable,
+ *   collection Foldable,
  *   transducer Transducer,
- *   initialValue? Transformable|(Foldable=>Promise|Transformable),
+ *   initialValue? Transformable|TransformableResolver,
  * ) -> result Promise|Transformable
  *
  * transform(
  *   transducer Transducer,
- *   initialValue? Transformable|(Foldable=>Promise|Transformable),
- * )(foldable Foldable) -> result Promise|Transformable
+ *   initialValue? Transformable|TransformableResolver,
+ * )(collection Foldable) -> result Promise|Transformable
  * ```
  *
  * @description
@@ -58,9 +67,9 @@ const _transform = function (collection, transducer, initialValue) {
  *
  * const isOdd = number => number % 2 == 1
  *
- * const squaredOdds = pipe([
- *   filter(isOdd),
- *   map(square),
+ * const squaredOdds = compose([
+ *   Transducer.filter(isOdd),
+ *   Transducer.map(square),
  * ])
  *
  * // transform arrays into arrays
@@ -96,7 +105,7 @@ const _transform = function (collection, transducer, initialValue) {
  *   },
  * }
  *
- * transform(map(square), Stdout)([1, 2, 3, 4, 5])
+ * transform(Transducer.map(square), Stdout)([1, 2, 3, 4, 5])
  * // 1
  * // 4
  * // 9
@@ -124,8 +133,10 @@ const _transform = function (collection, transducer, initialValue) {
  * }
  *
  * transform(
- *   map(pipe([square, toString])), process.stdout,
- * )(streamRandomInts()) // 9216576529289484980147613249169774446246768649...
+ *   streamRandomInts(),
+ *   Transducer.map(pipe([square, toString])),
+ *   process.stdout,
+ * ) // 9216576529289484980147613249169774446246768649...
  * ```
  *
  * @execution series