feat: Alias flatten() -> flat()

koraa · koraa · commit 2abad3f4cc72 · 2019-12-23T19:10:58.000+01:00
diff --git a/src/sequence.js b/src/sequence.js
@@ -1233,7 +1233,12 @@ const takeWithFallback = curry('takeWithFallback', (seq, no, fallback) => pipe(
  *
  * `list(takeWhile([1,2,3,4,5,6...], x => x < 4))` yields `[1,2,3]`
  *
+ * # Version History
+ *
+ * - 2.0.0 Add alias flatten()
+ *
  * @function
+ * @alias flatten
  * @param {Sequence} seq Any sequence for which iter() is defined
  * @param {Function} fn The predicate function
  * @returns {Iterator}
@@ -1301,6 +1306,8 @@ function* flat(seq) {
   }
 }
 
+const flatten = flat;
+
 /**
  * Concatenate any number of sequences.
  * This is just a variadic alias for `flat()`
@@ -1905,6 +1912,7 @@ module.exports = {
   takeUntilVal,
   takeDef,
   flat,
+  flatten,
   concat,
   prepend,
   append,
