apr-for-each - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

index.js

 const each = require('apr-engine-each');
 
+/**
+ * <a id="for-each"></a>
+ * Applies the function `iteratee` to each item in `coll`, in parallel.
+ *
+ * [![](https://img.shields.io/npm/v/apr-for-each.svg?style=flat-square)](https://www.npmjs.com/package/apr-for-each) [![](https://img.shields.io/npm/l/apr-for-each.svg?style=flat-square)](https://www.npmjs.com/package/apr-for-each)
+ *
+ * @kind function
+ * @name for-each
+ * @param {Array|Object|Iterable} input
+ * @param {Function} iteratee
+ * @returns {Promise}
+ *
+ * @example
+ * import awaitify from 'apr-awaitify';
+ * import forEach from 'apr-for-each';
+ *
+ * const writeFile = awaitify(fs.writeFile);
+ * const files = [
+ *   '/home/.vimrc',
+ *   '/home/.zshrc'
+ * ];
+ *
+ * await forEach(files, async (file) =>
+ *   await writeFile(file, 'boom')
+ * );
+ */
 module.exports = (input, fn, opts) => {
@@ -4,0 +30,0 @@ return each({

limit.js

 const defaults = require('lodash.defaults');
 const each = require('apr-engine-each');
 
+/**
+ * @kind function
+ * @name limit
+ * @memberof for-each
+ * @param {Array|Object|Iterable} input
+ * @param {Number} limit
+ * @param {Function} iteratee
+ * @returns {Promise}
+ */
 module.exports = (input, limit, fn, opts) => {
@@ -5,0 +14,0 @@ return each({

package.json

 {
   "name": "apr-for-each",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "homepage": "https://github.com/ramitos/apr/tree/master/packages/for-each",
@@ -5,0 +5,0 @@ "license": "MIT",

series.js

 const limit = require('./limit');
 
+/**
+ * @kind function
+ * @name series
+ * @memberof for-each
+ * @param {Array|Object|Iterable} input
+ * @param {Function} iteratee
+ * @returns {Promise}
+ */
 module.exports = (input, fn, opts) => {
   return limit(input, 1, fn, opts);
 };

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4405

increased by326.84%

Number of package files

5

increased by25%

Lines of code

68

increased by172%

Number of medium quality alerts

1

decreased by-50%

Number of lines in readme file

52

increased byInfinity%

No dependency changes