Docs and version bump

README.md

@@ -144,3 +144,16 @@ Example: `{ a: { b: { c: 1 } } } => { 'a.b.c' : 1 }`.
 ## Math
 ### greaterThanOne
 `number -> bool` Returns true if number is greater than one.
+
+## Algebras or composable/recursive data types
+
+## map
+`map :: (a -> b) -> [a] -> [b]`
+Maps a function over an iterable. Works by default for Arrays and Plain Objects.
+
+## deepMap
+`deepMap :: (a -> b) -> [a] -> [b]`
+Maps a function over a recursive iterable. Works by default for nested Arrays, nested Plain Objects and mixed
+nested Arrays and Plain Objects. Also works for any other iterable data type as long as
+two other values are sent: a mapping function, and a type checker (See the
+unit tests for deepMap).

package.json

@@ -1,6 +1,6 @@
 {
   "name": "futil-js",
-  "version": "1.7.3",
+  "version": "1.8.3",
   "description": "F(unctional) util(ities). Resistance is futile.",
   "main": "lib/futil-js.js",
   "scripts": {

src/index.js

@@ -22,6 +22,7 @@ export const flowMap = (...fns) => _.map(_.flow(...fns))
 // Algebras
 // --------
 const isTraversable = x => _.isArray(x) || _.isPlainObject(x)
+// A generic map that works for plain objects and arrays
 export const map = _.curry((f, x) => (_.isArray(x) ? _.map : _.mapValues)(f, x))
 // Map for any recursive algebraic data structure
 // defaults in multidimensional arrays and recursive plain objects