run-series
Advanced tools
run-series - npm Package Compare versions
Comparing version 1.0.0 to 1.0.1
| { | ||
| "name": "run-series", | ||
| "description": "Run an array of functions in series", | ||
| "version": "1.0.0", | ||
| "version": "1.0.1", | ||
| "author": { | ||
@@ -6,0 +6,0 @@ "name": "Feross Aboukhadijeh", |
@@ -52,43 +52,4 @@ # run-series [](https://travis-ci.org/feross/run-series) [](https://npmjs.org/package/run-series) | ||
| #### series.waterfall(tasks, [callback]) | ||
| Runs the `tasks` array of functions in series, **each passing their results to the next in | ||
| the array**. However, if any of the `tasks` pass an error to their own callback, the next | ||
| function is not executed, and the main `callback` is immediately called with the error. | ||
| ##### arguments | ||
| - `tasks` - An array of functions to run, each function is passed a | ||
| `callback(err, result1, result2, ...)` it must call on completion. The first argument is | ||
| an error (which can be `null`) and any further arguments will be passed as arguments in | ||
| order to the next task. | ||
| - `callback(err, [results])` - An optional callback to run once all the functions have | ||
| completed. This will be passed the results of the last task's callback. | ||
| ##### example | ||
| ```js | ||
| var series = require('run-series') | ||
| series.waterfall([ | ||
| function (callback) { | ||
| callback(null, 'one', 'two') | ||
| }, | ||
| function (arg1, arg2, callback) { | ||
| // arg1 now equals 'one' and arg2 now equals 'two' | ||
| callback(null, 'three') | ||
| }, | ||
| function (arg1, callback) { | ||
| // arg1 now equals 'three' | ||
| callback(null, 'done', 'wohoo') | ||
| } | ||
| ], function (err, result1, result2) { | ||
| // result1 now equals 'done' | ||
| // result2 now equals 'wohoo' | ||
| }) | ||
| ``` | ||
| This module is basically equavalent to | ||
| [`async.series`](https://github.com/caolan/async#seriestasks-callback) and | ||
| [`async.waterfall`](https://github.com/caolan/async#waterfalltasks-callback), but it's | ||
| [`async.series`](https://github.com/caolan/async#seriestasks-callback), but it's | ||
| handy to just have the functions you need instead of the kitchen sink. Modularity! | ||
@@ -100,4 +61,9 @@ Especially handy if you're serving to the browser and need to reduce your javascript | ||
| ## license | ||
| ### see also | ||
| - [run-waterfall](https://github.com/feross/run-waterfall) | ||
| - [run-parallel](https://github.com/feross/run-parallel) | ||
| ### license | ||
| MIT. Copyright (c) [Feross Aboukhadijeh](http://feross.org). |
New alerts
License Policy Violation
LicenseThis 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
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-1.19%
97651
- Number of lines in readme file
- decreased by-33.33%
68