53 lines
1.7 KiB
Markdown
53 lines
1.7 KiB
Markdown
|
# tiny-each-async
|
||
|
|
|
||
|
|
Asynchronous iterator function similar to (and inspired by) [async.each](https://github.com/caolan/async#eacharr-iterator-callback), with support for concurrency limit and item index.
|
||
|
|
|
||
|
|
[](http://travis-ci.org/alessioalex/tiny-each-async)
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
### each(array, [limit], iterator, [callback])
|
||
|
|
|
||
|
|
Arguments:
|
||
|
|
|
||
|
|
- array - An array of items to iterate through.
|
||
|
|
- [limit] - An (optional) integer for determining how many `iterator` functions should be run in parallel.
|
||
|
|
- iterator(item, [index], callback) - A function to be applied to each item in the array. When it has finished processing the item then the `callback` function should be called (in case of a failure with the `error` argument, otherwise none).
|
||
|
|
- callback(err) - An optional callback function that gets called when either all `iterator` functions have finished or one of them has returned an error.
|
||
|
|
|
||
|
|
### Example
|
||
|
|
|
||
|
|
```js
|
||
|
|
var eachAsync = require('tiny-each-async');
|
||
|
|
var timeouts = [300, 100, 2000];
|
||
|
|
|
||
|
|
eachAsync(['file1', 'file2', 'file3'], function(item, index, next) {
|
||
|
|
setTimeout(function() {
|
||
|
|
console.log(item, index, timeouts[index]);
|
||
|
|
next();
|
||
|
|
}, timeouts[index]);
|
||
|
|
}, function(err) {
|
||
|
|
return err ? console.error(err.stack) : console.log('all done');
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
For more examples checkout the [/examples](/examples) folder.
|
||
|
|
|
||
|
|
## FAQ
|
||
|
|
|
||
|
|
- Why the name?
|
||
|
|
|
||
|
|
Other possible names were already taken, and the actual source code is tiny.
|
||
|
|
|
||
|
|
- Why create another async library?
|
||
|
|
|
||
|
|
Because doing your own thing is fun.
|
||
|
|
|
||
|
|
- What if my iterator function is sync, but I want it && the callback to be async?
|
||
|
|
|
||
|
|
Then you might want to use [dezalgo](https://github.com/npm/dezalgo).
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
[MIT](http://alessioalex.mit-license.org/)
|