https://github.com/floatdrop/each-done

each-async + async-done = each-done
https://github.com/floatdrop/each-done

Last synced: about 1 month ago
JSON representation

each-async + async-done = each-done

• Host: GitHub
• URL: https://github.com/floatdrop/each-done
• Owner: floatdrop
• Created: 2014-10-21T12:48:20.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-10-21T13:21:00.000Z (about 10 years ago)
• Last Synced: 2024-10-26T21:11:30.834Z (3 months ago)
• Language: JavaScript
• Size: 117 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# each-done [![Build Status](https://travis-ci.org/floatdrop/each-done.svg?branch=master)](https://travis-ci.org/floatdrop/each-done)

> Async concurrent iterator (async forEach)

Inspired by [eachAsync()](https://github.com/sindresorhus/each-async), but with [async-done](https://github.com/phated/async-done) inside.

## Install

```sh

$ npm install --save each-done

```

## Usage

```js

var each = require('each-done');

each(['foo','bar','baz'], function (item, index, done) {

	console.log(item, index);

	done();

}, function (error) {

	console.log('finished');

});

//=> foo 0

//=> bar 1

//=> baz 2

//=> finished

```

## API

### eachAsync(array, callback, finishedCallback)

#### array

The array you want to iterate.

#### callback(item, index, done)

A function which is called for each item in the array with the following arguments:

- `item`: the current item in the array

- `index`: the current index

- `done([error])`: call this when you're done with an optional error. Supplying anything other than `undefined`/`null` will stop the iteration.

Note that order is not guaranteed since each item is handled concurrently.

You can return Promise or Stream from callback function instead of calling `done` argument - then callback will be reloved as soon as Stream emits `end` or Promise will be resolved.

#### finishedCallback(error)

A function which is called when the iteration is finished or on the first error. First argument is the error passed from `done()` in the `callback`.

## License

MIT © [Vsevolod Strukchinsky]([email protected])