Add Either, right and Left, min, reduce and sort, and some doc updates

astuanax · Jun 15, 2019 · 3cbd611 · 3cbd611
1 parent ec5a146
commit 3cbd611
Show file tree

Hide file tree

Showing 111 changed files with 10,698 additions and 1,704 deletions.
diff --git a/docs.json b/docs.json
diff --git a/docs/Either.Left.html b/docs/Either.Left.html
diff --git a/docs/Either.Right.html b/docs/Either.Right.html
diff --git a/docs/Either.html b/docs/Either.html
diff --git a/docs/Either_Left.html b/docs/Either_Left.html
diff --git a/docs/Either_Right.html b/docs/Either_Right.html
diff --git a/docs/Just.html b/docs/Just.html
diff --git a/docs/Left.html b/docs/Left.html
diff --git a/docs/Maybe.html b/docs/Maybe.html
diff --git a/docs/Maybe_Just.html b/docs/Maybe_Just.html
diff --git a/docs/Maybe_Nothing.html b/docs/Maybe_Nothing.html
diff --git a/docs/Nothing.html b/docs/Nothing.html
diff --git a/docs/Right.html b/docs/Right.html
diff --git a/docs/addIndex.js.html b/docs/addIndex.js.html
diff --git a/docs/adjust.js.html b/docs/adjust.js.html
diff --git a/docs/adjustWith.js.html b/docs/adjustWith.js.html
diff --git a/docs/all.js.html b/docs/all.js.html
diff --git a/docs/allPass.js.html b/docs/allPass.js.html
diff --git a/docs/always.js.html b/docs/always.js.html
diff --git a/docs/and.js.html b/docs/and.js.html
diff --git a/docs/any.js.html b/docs/any.js.html
diff --git a/docs/anyPass.js.html b/docs/anyPass.js.html
diff --git a/docs/ap.js.html b/docs/ap.js.html
diff --git a/docs/aperture.js.html b/docs/aperture.js.html
diff --git a/docs/append.js.html b/docs/append.js.html
diff --git a/docs/apply.js.html b/docs/apply.js.html
diff --git a/docs/array_fold.js.html b/docs/array_fold.js.html
diff --git a/docs/array_map.js.html b/docs/array_map.js.html
diff --git a/docs/array_to.js.html b/docs/array_to.js.html
diff --git a/docs/array_union.js.html b/docs/array_union.js.html
diff --git a/docs/binary.js.html b/docs/binary.js.html
diff --git a/docs/bind.js.html b/docs/bind.js.html
diff --git a/docs/boolean_F.js.html b/docs/boolean_F.js.html
diff --git a/docs/boolean_T.js.html b/docs/boolean_T.js.html
diff --git a/docs/call.js.html b/docs/call.js.html
diff --git a/docs/complement.js.html b/docs/complement.js.html
diff --git a/docs/compose.js.html b/docs/compose.js.html
diff --git a/docs/concat.js.html b/docs/concat.js.html
diff --git a/docs/cond.js.html b/docs/cond.js.html
diff --git a/docs/curry.js.html b/docs/curry.js.html
diff --git a/docs/date_diffDate.js.html b/docs/date_diffDate.js.html
diff --git a/docs/date_formatDateTime.js.html b/docs/date_formatDateTime.js.html
diff --git a/docs/date_getWeek.js.html b/docs/date_getWeek.js.html
diff --git a/docs/date_toDay.js.html b/docs/date_toDay.js.html
diff --git a/docs/date_toHour.js.html b/docs/date_toHour.js.html
diff --git a/docs/date_toMinutes.js.html b/docs/date_toMinutes.js.html
diff --git a/docs/date_toSeconds.js.html b/docs/date_toSeconds.js.html
diff --git a/docs/defaultTo.js.html b/docs/defaultTo.js.html
diff --git a/docs/empty.js.html b/docs/empty.js.html
diff --git a/docs/equals.js.html b/docs/equals.js.html
diff --git a/docs/exists.js.html b/docs/exists.js.html
diff --git a/docs/filter.js.html b/docs/filter.js.html
diff --git a/docs/findIndex.js.html b/docs/findIndex.js.html
diff --git a/docs/first.js.html b/docs/first.js.html
diff --git a/docs/flatMap.js.html b/docs/flatMap.js.html
diff --git a/docs/fold.js.html b/docs/fold.js.html
diff --git a/docs/global.html b/docs/global.html
diff --git a/docs/identical.js.html b/docs/identical.js.html
diff --git a/docs/identity.js.html b/docs/identity.js.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/is.js.html b/docs/is.js.html
diff --git a/docs/isEmpty.js.html b/docs/isEmpty.js.html
diff --git a/docs/keys.js.html b/docs/keys.js.html
diff --git a/docs/last.js.html b/docs/last.js.html
diff --git a/docs/lift.js.html b/docs/lift.js.html
diff --git a/docs/map.js.html b/docs/map.js.html
diff --git a/docs/max.js.html b/docs/max.js.html
diff --git a/docs/min.js.html b/docs/min.js.html
diff --git a/docs/monads_Either.js.html b/docs/monads_Either.js.html
diff --git a/docs/monads_Just.js.html b/docs/monads_Just.js.html
diff --git a/docs/monads_Left.js.html b/docs/monads_Left.js.html
diff --git a/docs/monads_Maybe.js.html b/docs/monads_Maybe.js.html
diff --git a/docs/monads_Nothing.js.html b/docs/monads_Nothing.js.html
diff --git a/docs/monads_Right.js.html b/docs/monads_Right.js.html
diff --git a/docs/not.js.html b/docs/not.js.html
diff --git a/docs/number_add.js.html b/docs/number_add.js.html
diff --git a/docs/number_divide.js.html b/docs/number_divide.js.html
diff --git a/docs/number_isNan.js.html b/docs/number_isNan.js.html
diff --git a/docs/object_path.js.html b/docs/object_path.js.html
diff --git a/docs/object_pick.js.html b/docs/object_pick.js.html
diff --git a/docs/object_prop.js.html b/docs/object_prop.js.html
diff --git a/docs/object_values.js.html b/docs/object_values.js.html
diff --git a/docs/or.js.html b/docs/or.js.html
diff --git a/docs/reduce.js.html b/docs/reduce.js.html
diff --git a/docs/sort.js.html b/docs/sort.js.html
diff --git a/docs/truthy.js.html b/docs/truthy.js.html
diff --git a/docs/type.js.html b/docs/type.js.html
diff --git a/docs/zip.js.html b/docs/zip.js.html
diff --git a/docs/zipObj.js.html b/docs/zipObj.js.html
diff --git a/docs/zipWith.js.html b/docs/zipWith.js.html
diff --git a/lib/fun.js b/lib/fun.js
diff --git a/lib/fun.js.map b/lib/fun.js.map
diff --git a/lib/fun.min.js b/lib/fun.min.js
diff --git a/lib/fun.min.js.map b/lib/fun.min.js.map
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "fun.js",
   "sideEffects": false,
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Functional tools for javascript development",
   "main": "lib/fun.js",
   "module": "src/index.js",

diff --git a/src/fold.js b/src/fold.js
@@ -4,13 +4,11 @@
  * @function fold
  * @description Returns a single item by iterating over an array like object and call a function on each item
  * @since v1.0.2
- * @sig ((a, b, c, a) → a) → a → [b] → a
  * @param {Function} cb receives 4 values: the accumulator, the item, the index, and the initial value.
- * @param {*} a is the initial value
- * @param {*} [b] the array like item to iterate over
- * @return {*} a is the accumulated value
+ * @param {*} init - the the initial value
+ * @param {Array|Object} a the array like item to iterate over
+ * @return {*} The accumulated value
  **/
-
 import curry from './curry'
 import arrayFold from './array/fold'
 import objectFold from './object/fold'
@@ -21,20 +19,5 @@ export default curry(function fold (cb, init, a) {
     'Object': objectFold,
     'Array': arrayFold
   }
-  // if (a.next) {
-  //   return iterableFold(cb, init, a)
-  // }
-  // if (type(Symbol) !== 'undefined' && a[Symbol.iterator]) {
-  //   return iterableFold(cb, init, a[Symbol.iterator]())
-  // }
   return typeMap[type(a)](cb, init, a)
 })
-
-// function iterableFold (cb, acc, gen) {
-//   let step = gen.next()
-//   while (!step.done) {
-//     acc = cb(acc, step.value)
-//     step = gen.next()
-//   }
-//   return acc
-// }
diff --git a/src/index.js b/src/index.js
@@ -1,199 +1,3 @@
-// export { default as __ } from './__';
-export { default as aperture } from './aperture'
-// export { default as applySpec } from './applySpec'
-// export { default as applyTo } from './applyTo'
-// export { default as ascend } from './ascend'
-// export { default as assoc } from './assoc'
-// export { default as assocPath } from './assocPath'
-// export { default as clamp } from './clamp'
-// export { default as clone } from './clone'
-// export { default as comparator } from './comparator'
-// export { default as composeK } from './composeK'
-// export { default as composeP } from './composeP'
-// export { default as composeWith } from './composeWith'
-// export { default as construct } from './construct'
-// export { default as constructN } from './constructN'
-// export { default as contains } from './contains'
-// export { default as converge } from './converge'
-// export { default as countBy } from './countBy'
-// export { default as dec } from './dec'
-// export { default as descend } from './descend'
-// export { default as difference } from './difference'
-// export { default as differenceWith } from './differenceWith'
-// export { default as dissoc } from './dissoc'
-// export { default as dissocPath } from './dissocPath'
-// export { default as drop } from './drop'
-// export { default as dropLast } from './dropLast'
-// export { default as dropLastWhile } from './dropLastWhile'
-// export { default as dropRepeats } from './dropRepeats'
-// export { default as dropRepeatsWith } from './dropRepeatsWith'
-// export { default as dropWhile } from './dropWhile'
-// export { default as either } from './either'
-// export { default as endsWith } from './endsWith'
-// export { default as eqBy } from './eqBy'
-// export { default as eqProps } from './eqProps'
-// export { default as evolve } from './evolve'
-// export { default as find } from './find'
-// export { default as findLast } from './findLast'
-// export { default as findLastIndex } from './findLastIndex'
-// export { default as flatten } from './flatten'
-// export { default as flip } from './flip'
-// export { default as forEach } from './forEach'
-// export { default as forEachObjIndexed } from './forEachObjIndexed'
-// export { default as fromPairs } from './fromPairs'
-// export { default as groupBy } from './groupBy'
-// export { default as groupWith } from './groupWith'
-// export { default as gt } from './gt'
-// export { default as gte } from './gte'
-// export { default as hasPath } from './hasPath'
-// export { default as head } from './head'
-// export { default as ifElse } from './ifElse'
-// export { default as inc } from './inc'
-// export { default as includes } from './includes'
-// export { default as indexBy } from './indexBy'
-// export { default as indexOf } from './indexOf'
-// export { default as init } from './init'
-// export { default as innerJoin } from './innerJoin'
-// export { default as insert } from './insert'
-// export { default as insertAll } from './insertAll'
-// export { default as intersection } from './intersection'
-// export { default as intersperse } from './intersperse'
-// export { default as into } from './into'
-// export { default as invert } from './invert'
-// export { default as invertObj } from './invertObj'
-// export { default as invoker } from './invoker'
-// export { default as join } from './join'
-// export { default as juxt } from './juxt'
-// export { default as lastIndexOf } from './lastIndexOf'
-// export { default as length } from './length'
-// export { default as lens } from './lens'
-// export { default as lensIndex } from './lensIndex'
-// export { default as lensPath } from './lensPath'
-// export { default as lensProp } from './lensProp'
-// export { default as liftN } from './liftN'
-// export { default as lt } from './lt'
-// export { default as lte } from './lte'
-// export { default as mapAccum } from './mapAccum'
-// export { default as mapAccumRight } from './mapAccumRight'
-// export { default as mapObjIndexed } from './mapObjIndexed'
-// export { default as match } from './match'
-// export { default as mathMod } from './mathMod'
-// export { default as maxBy } from './maxBy'
-// export { default as mean } from './mean'
-// export { default as median } from './median'
-// export { default as memoizeWith } from './memoizeWith'
-// export { default as mergeAll } from './mergeAll'
-// export { default as mergeDeepLeft } from './mergeDeepLeft'
-// export { default as mergeDeepRight } from './mergeDeepRight'
-// export { default as mergeDeepWith } from './mergeDeepWith'
-// export { default as mergeDeepWithKey } from './mergeDeepWithKey'
-// export { default as mergeLeft } from './mergeLeft'
-// export { default as mergeRight } from './mergeRight'
-// export { default as mergeWith } from './mergeWith'
-// export { default as mergeWithKey } from './mergeWithKey'
-// export { default as min } from './min'
-// export { default as minBy } from './minBy'
-// export { default as modulo } from './modulo'
-// export { default as move } from './move'
-// export { default as nAry } from './nAry'
-// export { default as negate } from './negate'
-// export { default as none } from './none'
-// export { default as nth } from './nth'
-// export { default as nthArg } from './nthArg'
-// export { default as o } from './o'
-// export { default as objOf } from './objOf'
-// export { default as of } from './of'
-// export { default as once } from './once'
-// export { default as otherwise } from './otherwise'
-// export { default as over } from './over'
-// export { default as pair } from './pair'
-// export { default as partial } from './partial'
-// export { default as partialRight } from './partialRight'
-// export { default as partition } from './partition'
-// export { default as pathEq } from './pathEq'
-// export { default as pathOr } from './pathOr'
-// export { default as pathSatisfies } from './pathSatisfies'
-// export { default as pickAll } from './pickAll'
-// export { default as pickBy } from './pickBy'
-// export { default as pipe } from './pipe'
-// export { default as pipeK } from './pipeK'
-// export { default as pipeP } from './pipeP'
-// export { default as pipeWith } from './pipeWith'
-// export { default as pluck } from './pluck'
-// export { default as prepend } from './prepend'
-// export { default as product } from './product'
-// export { default as project } from './project'
-// export { default as propEq } from './propEq'
-// export { default as propIs } from './propIs'
-// export { default as propOr } from './propOr'
-// export { default as props } from './props'
-// export { default as propSatisfies } from './propSatisfies'
-// export { default as range } from './range'
-// export { default as reduceBy } from './reduceBy'
-// export { default as reduced } from './reduced'
-// export { default as reduceRight } from './reduceRight'
-// export { default as reduceWhile } from './reduceWhile'
-// export { default as reject } from './reject'
-// export { default as remove } from './remove'
-// export { default as repeat } from './repeat'
-// export { default as replace } from './replace'
-// export { default as reverse } from './reverse'
-// export { default as scan } from './scan'
-// export { default as sequence } from './sequence'
-// export { default as set } from './set'
-// export { default as slice } from './slice'
-// export { default as sort } from './sort'
-// export { default as sortBy } from './sortBy'
-// export { default as sortWith } from './sortWith'
-// export { default as split } from './split'
-// export { default as splitAt } from './splitAt'
-// export { default as splitEvery } from './splitEvery'
-// export { default as splitWhen } from './splitWhen'
-// export { default as startsWith } from './startsWith'
-// export { default as subtract } from './subtract'
-// export { default as symmetricDifference } from './symmetricDifference'
-// export { default as symmetricDifferenceWith } from './symmetricDifferenceWith'
-// export { default as tail } from './tail'
-// export { default as take } from './take'
-// export { default as takeLast } from './takeLast'
-// export { default as takeLastWhile } from './takeLastWhile'
-// export { default as takeWhile } from './takeWhile'
-// export { default as tap } from './tap'
-// export { default as test } from './test'
-// export { default as then } from './then'
-// export { default as thunkify } from './thunkify'
-// export { default as times } from './times'
-// export { default as toLower } from './toLower'
-// export { default as toPairs } from './toPairs'
-// export { default as toPairsIn } from './toPairsIn'
-// export { default as toString } from './toString'
-// export { default as toUpper } from './toUpper'
-// export { default as transduce } from './transduce'
-// export { default as transpose } from './transpose'
-// export { default as traverse } from './traverse'
-// export { default as trim } from './trim'
-// export { default as tryCatch } from './tryCatch'
-// export { default as unapply } from './unapply'
-// export { default as unary } from './unary'
-// export { default as uncurryN } from './uncurryN'
-// export { default as unfold } from './unfold'
-// export { default as unionWith } from './unionWith'
-// export { default as uniq } from './uniq'
-// export { default as uniqBy } from './uniqBy'
-// export { default as uniqWith } from './uniqWith'
-// export { default as unless } from './unless'
-// export { default as unnest } from './unnest'
-// export { default as until } from './until'
-// export { default as update } from './update'
-// export { default as useWith } from './useWith'
-// export { default as valuesIn } from './valuesIn'
-// export { default as view } from './view'
-// export { default as when } from './when'
-// export { default as where } from './where'
-// export { default as whereEq } from './whereEq'
-// export { default as without } from './without'
-// export { default as xprod } from './xprod'
-export { default as zipObj } from './zipObj'
 export { default as add } from './number/add'
 export { default as addIndex } from './addIndex'
 export { default as adjust } from './adjust'
@@ -205,6 +9,7 @@ export { default as and } from './and'
 export { default as any } from './any'
 export { default as anyPass } from './anyPass'
 export { default as ap } from './ap'
+export { default as aperture } from './aperture'
 export { default as append } from './append'
 export { default as apply } from './apply'
 export { default as binary } from './binary'
@@ -219,6 +24,9 @@ export { default as curry } from './curry'
 export { default as defaultTo } from './defaultTo'
 export { default as diffDate } from './date/diffDate'
 export { default as divide } from './number/divide'
+export { default as Either } from './monads/Either'
+export { default as Left } from './monads/Left'
+export { default as Right } from './monads/Right'
 export { default as empty } from './empty'
 export { default as equals } from './equals'
 export { default as exists } from './exists'
@@ -257,6 +65,7 @@ export { default as map } from './map'
 export { default as max } from './max'
 export { default as Maybe } from './monads/Maybe'
 export { default as merge } from './object/merge'
+export { default as min } from './min'
 export { default as multiply } from './number/multiply'
 export { default as not } from './not'
 export { default as Nothing } from './monads/Nothing'
@@ -265,6 +74,8 @@ export { default as or } from './or'
 export { default as path } from './object/path'
 export { default as pick } from './object/pick'
 export { default as prop } from './object/prop'
+export { default as reduce } from './reduce'
+export { default as sort } from './sort'
 export { default as sum } from './number/sum'
 export { default as T } from './boolean/T'
 export { default as toDay } from './date/toDay'
@@ -276,4 +87,5 @@ export { default as type } from './type'
 export { default as union } from './array/union'
 export { default as values } from './object/values'
 export { default as zip } from './zip'
+export { default as zipObj } from './zipObj'
 export { default as zipWith } from './zipWith'
diff --git a/src/min.js b/src/min.js
@@ -0,0 +1,15 @@
+/**
+ * Returns the smallest of the 2 arguments provided
+ *
+ * @function min
+ * @desc Returns the smallest of the 2 arguments provided
+ * @since v1.0.4
+ * @param {*} a
+ * @param {*} b
+ * @return {*}
+ **/
+import curry from './curry'
+
+export default curry(function min (a, b) {
+  return b < a ? b : a
+})