apr-waterfall - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

index.js

 const each = require('apr-engine-each');
 
+/**
+ * <a id="waterfall"></a>
+ * Runs the `tasks` array of functions in series, each passing their results to the next in the array.
+ *
+ * [![](https://img.shields.io/npm/v/apr-waterfall.svg?style=flat-square)](https://www.npmjs.com/package/apr-waterfall) [![](https://img.shields.io/npm/l/apr-waterfall.svg?style=flat-square)](https://www.npmjs.com/package/apr-waterfall)
+ *
+ * @kind function
+ * @name waterfall
+ * @param {Array<Function>|Object} tasks
+ * @param {Any} [initial]
+ * @returns {Promise}
+ *
+ * @example
+ * import waterfall from 'apr-waterfall';
+ *
+ * const then = (v) => new Promise((resolve) => resolve(v));
+ *
+ * const output = await waterfall([
+ *   async () => await then(1),
+ *   async (v) => await then(v + 2),
+ *   async (v) => await then(v + 3)
+ * ]);
+ *
+ * // output = 6
+ */
 module.exports = (input, initial) => {
@@ -4,0 +29,0 @@ let last = initial;

package.json

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

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

2705

increased by293.74%

Number of package files

3

increased by50%

Lines of code

43

increased by138.89%

Number of medium quality alerts

1

decreased by-50%

Number of lines in readme file

32

increased byInfinity%

No dependency changes