js-fns - npm Package Compare versions

Comparing version 2.4.0 to 2.5.0

chunk/index.js

@@ -12,2 +12,10 @@ 'use strict'
  *
+ * @example
+ * Group the array elements into chunks of 2:
+ * ```ts
+ * chunk([1, 2, 3, 4, 5, 6, 7], 2)
+ * //=> [[1, 2], [3, 4], [5, 6], [7]]
+ * ```
+ *
+ * @category Array
  * @public
@@ -14,0 +22,0 @@ */

cloneDeep/index.js

@@ -11,2 +11,3 @@ 'use strict'
  *
+ * @category Common
  * @public
@@ -13,0 +14,0 @@ */

debounce/index.js

@@ -12,2 +12,3 @@ 'use strict'
  *
+ * @category Function
  * @public
@@ -14,0 +15,0 @@ */

difference/index.js

@@ -12,2 +12,3 @@ 'use strict'
  *
+ * @category Array
  * @public
@@ -14,0 +15,0 @@ */

drop/index.js

@@ -12,2 +12,3 @@ 'use strict'
  *
+ * @category Array
  * @public
@@ -14,0 +15,0 @@ */

find/index.js

@@ -12,2 +12,3 @@ 'use strict'
  *
+ * @category Array
  * @public
@@ -14,0 +15,0 @@ */

findIndex/index.js

@@ -12,2 +12,3 @@ 'use strict'
  *
+ * @category Array
  * @public
@@ -14,0 +15,0 @@ */

findLast/index.js

@@ -12,2 +12,3 @@ 'use strict'
  *
+ * @category Array
  * @public
@@ -14,0 +15,0 @@ */

findLastIndex/index.js

@@ -12,2 +12,3 @@ 'use strict'
  *
+ * @category Array
  * @public
@@ -14,0 +15,0 @@ */

first/index.js

@@ -11,2 +11,3 @@ 'use strict'
  *
+ * @category Array
  * @public
@@ -13,0 +14,0 @@ */

flatten/index.js

@@ -11,2 +11,3 @@ 'use strict'
  *
+ * @category Array
  * @public
@@ -13,0 +14,0 @@ */

group/index.js

@@ -26,2 +26,3 @@ 'use strict'
 /**
+ * @category Array
  * @internal
@@ -28,0 +29,0 @@ */

index.js

 'use strict'
 
+var _exportNames = {
+  chunk: true,
+  cloneDeep: true,
+  debounce: true,
+  difference: true,
+  drop: true,
+  entries: true,
+  find: true,
+  findIndex: true,
+  findLast: true,
+  findLastIndex: true,
+  first: true,
+  flatten: true,
+  flow: true,
+  fromEntries: true,
+  group: true,
+  intersection: true,
+  last: true,
+  map: true,
+  omit: true,
+  pick: true,
+  reduce: true,
+  remove: true,
+  sample: true,
+  sweep: true,
+  take: true,
+  throttle: true,
+  times: true,
+  truthy: true,
+  union: true,
+  uniq: true,
+  zip: true,
+}
 Object.defineProperty(exports, 'chunk', {
@@ -33,3 +66,3 @@ enumerable: true,
 })
-Object.defineProperty(exports, 'find', {
+Object.defineProperty(exports, 'entries', {
   enumerable: true,
@@ -40,3 +73,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'findIndex', {
+Object.defineProperty(exports, 'find', {
   enumerable: true,
@@ -47,3 +80,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'findLast', {
+Object.defineProperty(exports, 'findIndex', {
   enumerable: true,
@@ -54,3 +87,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'findLastIndex', {
+Object.defineProperty(exports, 'findLast', {
   enumerable: true,
@@ -61,3 +94,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'first', {
+Object.defineProperty(exports, 'findLastIndex', {
   enumerable: true,
@@ -68,3 +101,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'flatten', {
+Object.defineProperty(exports, 'first', {
   enumerable: true,
@@ -75,3 +108,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'group', {
+Object.defineProperty(exports, 'flatten', {
   enumerable: true,
@@ -82,3 +115,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'intersection', {
+Object.defineProperty(exports, 'flow', {
   enumerable: true,
@@ -89,3 +122,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'last', {
+Object.defineProperty(exports, 'fromEntries', {
   enumerable: true,
@@ -96,3 +129,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'omit', {
+Object.defineProperty(exports, 'group', {
   enumerable: true,
@@ -103,3 +136,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'pick', {
+Object.defineProperty(exports, 'intersection', {
   enumerable: true,
@@ -110,3 +143,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'remove', {
+Object.defineProperty(exports, 'last', {
   enumerable: true,
@@ -117,3 +150,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'sample', {
+Object.defineProperty(exports, 'map', {
   enumerable: true,
@@ -124,3 +157,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'sweep', {
+Object.defineProperty(exports, 'omit', {
   enumerable: true,
@@ -131,3 +164,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'take', {
+Object.defineProperty(exports, 'pick', {
   enumerable: true,
@@ -138,3 +171,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'throttle', {
+Object.defineProperty(exports, 'reduce', {
   enumerable: true,
@@ -145,3 +178,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'truthy', {
+Object.defineProperty(exports, 'remove', {
   enumerable: true,
@@ -152,3 +185,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'union', {
+Object.defineProperty(exports, 'sample', {
   enumerable: true,
@@ -159,3 +192,3 @@ get: function get() {
 })
-Object.defineProperty(exports, 'uniq', {
+Object.defineProperty(exports, 'sweep', {
   enumerable: true,
@@ -166,49 +199,446 @@ get: function get() {
 })
+Object.defineProperty(exports, 'take', {
+  enumerable: true,
+  get: function get() {
+    return _index25.default
+  },
+})
+Object.defineProperty(exports, 'throttle', {
+  enumerable: true,
+  get: function get() {
+    return _index26.default
+  },
+})
+Object.defineProperty(exports, 'times', {
+  enumerable: true,
+  get: function get() {
+    return _index27.default
+  },
+})
+Object.defineProperty(exports, 'truthy', {
+  enumerable: true,
+  get: function get() {
+    return _index28.default
+  },
+})
+Object.defineProperty(exports, 'union', {
+  enumerable: true,
+  get: function get() {
+    return _index29.default
+  },
+})
+Object.defineProperty(exports, 'uniq', {
+  enumerable: true,
+  get: function get() {
+    return _index30.default
+  },
+})
+Object.defineProperty(exports, 'zip', {
+  enumerable: true,
+  get: function get() {
+    return _index31.default
+  },
+})
 
 var _index = require('./chunk/index.js')
 
+Object.keys(_index).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index[key]
+    },
+  })
+})
+
 var _index2 = require('./cloneDeep/index.js')
 
+Object.keys(_index2).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index2[key]
+    },
+  })
+})
+
 var _index3 = require('./debounce/index.js')
 
+Object.keys(_index3).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index3[key]
+    },
+  })
+})
+
 var _index4 = require('./difference/index.js')
 
+Object.keys(_index4).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index4[key]
+    },
+  })
+})
+
 var _index5 = require('./drop/index.js')
 
-var _index6 = require('./find/index.js')
+Object.keys(_index5).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index5[key]
+    },
+  })
+})
 
-var _index7 = require('./findIndex/index.js')
+var _index6 = require('./entries/index.js')
 
-var _index8 = require('./findLast/index.js')
+Object.keys(_index6).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index6[key]
+    },
+  })
+})
 
-var _index9 = require('./findLastIndex/index.js')
+var _index7 = require('./find/index.js')
 
-var _index10 = require('./first/index.js')
+Object.keys(_index7).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index7[key]
+    },
+  })
+})
 
-var _index11 = require('./flatten/index.js')
+var _index8 = require('./findIndex/index.js')
 
-var _index12 = require('./group/index.js')
+Object.keys(_index8).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index8[key]
+    },
+  })
+})
 
-var _index13 = require('./intersection/index.js')
+var _index9 = require('./findLast/index.js')
 
-var _index14 = require('./last/index.js')
+Object.keys(_index9).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index9[key]
+    },
+  })
+})
 
-var _index15 = require('./omit/index.js')
+var _index10 = require('./findLastIndex/index.js')
 
-var _index16 = require('./pick/index.js')
+Object.keys(_index10).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index10[key]
+    },
+  })
+})
 
-var _index17 = require('./remove/index.js')
+var _index11 = require('./first/index.js')
 
-var _index18 = require('./sample/index.js')
+Object.keys(_index11).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index11[key]
+    },
+  })
+})
 
-var _index19 = require('./sweep/index.js')
+var _index12 = require('./flatten/index.js')
 
-var _index20 = require('./take/index.js')
+Object.keys(_index12).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index12[key]
+    },
+  })
+})
 
-var _index21 = require('./throttle/index.js')
+var _index13 = require('./flow/index.js')
 
-var _index22 = require('./truthy/index.js')
+Object.keys(_index13).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index13[key]
+    },
+  })
+})
 
-var _index23 = require('./union/index.js')
+var _index14 = require('./fromEntries/index.js')
 
-var _index24 = require('./uniq/index.js')
+Object.keys(_index14).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index14[key]
+    },
+  })
+})
+
+var _index15 = require('./group/index.js')
+
+Object.keys(_index15).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index15[key]
+    },
+  })
+})
+
+var _index16 = require('./intersection/index.js')
+
+Object.keys(_index16).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index16[key]
+    },
+  })
+})
+
+var _index17 = require('./last/index.js')
+
+Object.keys(_index17).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index17[key]
+    },
+  })
+})
+
+var _index18 = require('./map/index.js')
+
+Object.keys(_index18).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index18[key]
+    },
+  })
+})
+
+var _index19 = require('./omit/index.js')
+
+Object.keys(_index19).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index19[key]
+    },
+  })
+})
+
+var _index20 = require('./pick/index.js')
+
+Object.keys(_index20).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index20[key]
+    },
+  })
+})
+
+var _index21 = require('./reduce/index.js')
+
+Object.keys(_index21).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index21[key]
+    },
+  })
+})
+
+var _index22 = require('./remove/index.js')
+
+Object.keys(_index22).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index22[key]
+    },
+  })
+})
+
+var _index23 = require('./sample/index.js')
+
+Object.keys(_index23).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index23[key]
+    },
+  })
+})
+
+var _index24 = require('./sweep/index.js')
+
+Object.keys(_index24).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index24[key]
+    },
+  })
+})
+
+var _index25 = require('./take/index.js')
+
+Object.keys(_index25).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index25[key]
+    },
+  })
+})
+
+var _index26 = require('./throttle/index.js')
+
+Object.keys(_index26).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index26[key]
+    },
+  })
+})
+
+var _index27 = require('./times/index.js')
+
+Object.keys(_index27).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index27[key]
+    },
+  })
+})
+
+var _index28 = require('./truthy/index.js')
+
+Object.keys(_index28).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index28[key]
+    },
+  })
+})
+
+var _index29 = require('./union/index.js')
+
+Object.keys(_index29).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index29[key]
+    },
+  })
+})
+
+var _index30 = require('./uniq/index.js')
+
+Object.keys(_index30).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index30[key]
+    },
+  })
+})
+
+var _index31 = require('./zip/index.js')
+
+Object.keys(_index31).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index31[key]
+    },
+  })
+})

intersection/index.js

@@ -31,2 +31,3 @@ 'use strict'
 /**
+ * @category Array
  * @internal
@@ -33,0 +34,0 @@ */

last/index.js

@@ -11,2 +11,3 @@ 'use strict'
  *
+ * @category Array
  * @public
@@ -13,0 +14,0 @@ */

omit/index.js

@@ -29,2 +29,3 @@ 'use strict'
  *
+ * @category Object
  * @public
@@ -31,0 +32,0 @@ */

package.json

 {
   "name": "js-fns",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Modern JavaScript utility library focused on the build size",
@@ -18,5 +18,7 @@ "main": "./index.js",
     "@babel/core": "^7.9.6",
+    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.10.1",
+    "@babel/plugin-proposal-optional-chaining": "^7.10.1",
     "@babel/preset-env": "^7.4.5",
     "@babel/preset-typescript": "^7.9.0",
-    "@microsoft/api-extractor": "^7.8.2",
+    "@js-fns/docs": "^0.1.2",
     "@types/jest": "25",
@@ -29,2 +31,3 @@ "@types/node": "^12.0.4",
     "babel-preset-power-assert": "^3.0.0",
+    "firebase-admin": "^8.12.1",
     "jest": "26",
@@ -44,2 +47,4 @@ "karma": "^4.2.0",
     "sinon": "^7.3.2",
+    "ts-node": "^8.10.2",
+    "typedoc": "^0.17.0-3",
     "typescript": "3.9",
@@ -46,0 +51,0 @@ "webpack": "^4.37.0"

pick/index.js

@@ -6,3 +6,3 @@ 'use strict'
 /**
- * Picks the given fields from the provided object
+ * Picks the given fields from the provided object.
  *
@@ -13,2 +13,3 @@ * @param object - The object to pick fields from
  *
+ * @category Object
  * @public
@@ -15,0 +16,0 @@ */

remove/index.js

@@ -11,8 +11,9 @@ 'use strict'
  *
+ * @category Array
  * @public
  */
 function remove(array, element) {
-  return array.filter(function (i) {
-    return i !== element
+  return array.filter(function (el) {
+    return el !== element
   })
 }

sample/index.js

@@ -11,2 +11,3 @@ 'use strict'
  *
+ * @category Array
  * @public
@@ -13,0 +14,0 @@ */

sweep/index.js

@@ -11,2 +11,3 @@ 'use strict'
  *
+ * @category Array
  * @public
@@ -13,0 +14,0 @@ */

take/index.js

@@ -6,3 +6,3 @@ 'use strict'
 /**
- * Creates a copy of an array with the given number of elements starting from the beginning
+ * Creates a copy of an array with the given number of elements starting from the beginning.
  *
@@ -13,2 +13,3 @@ * @param array - The array to copy elements from
  *
+ * @category Array
  * @public
@@ -15,0 +16,0 @@ */

throttle/index.js

@@ -12,2 +12,3 @@ 'use strict'
  *
+ * @category Function
  * @public
@@ -14,0 +15,0 @@ */

truthy/index.js

@@ -11,2 +11,3 @@ 'use strict'
  *
+ * @category Array
  * @public
@@ -13,0 +14,0 @@ */

union/index.js

@@ -6,3 +6,3 @@ 'use strict'
 /**
- * Creates a new array with all unique elements from the given arrays
+ * Creates a new array with all unique elements from the given arrays.
  *
@@ -12,2 +12,3 @@ * @param arrays - The array of arrays of elements to get unique elements from
  *
+ * @category Array
  * @public
@@ -14,0 +15,0 @@ */

uniq/index.js

@@ -33,2 +33,3 @@ 'use strict'
 /**
+ * @category Array
  * @internal
@@ -35,0 +36,0 @@ */

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

85803

increased by79.08%

Number of package files

100

increased by28.21%

Lines of code

2917

increased by87.35%

Worsened metrics

Dev dependency count

33

increased by17.86%

No dependency changes