foreachasync

WebJar for foreachasync

License	Apache-2.0
GroupId	org.webjars.npm
ArtifactId	foreachasync
Last Version	3.0.0
Release Date	Feb 14, 2018
Type	jar
Description	foreachasync WebJar for foreachasync
Project URL	http://webjars.org
Source Code Management	https://github.com/FuturesJS/forEachAsync

Download foreachasync

Filename	Size
foreachasync-3.0.0.pom
foreachasync-3.0.0.jar	10 KB
foreachasync-3.0.0-sources.jar	22 bytes
foreachasync-3.0.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/foreachasync/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>foreachasync</artifactId>
    <version>3.0.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/foreachasync/
implementation 'org.webjars.npm:foreachasync:3.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/foreachasync/
implementation ("org.webjars.npm:foreachasync:3.0.0")

Apache Buildr

'org.webjars.npm:foreachasync:jar:3.0.0'

Apache Ivy

<dependency org="org.webjars.npm" name="foreachasync" rev="3.0.0">
  <artifact name="foreachasync" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='foreachasync', version='3.0.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "foreachasync" % "3.0.0"

Leiningen

[org.webjars.npm/foreachasync "3.0.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

forEachAsync

Analogous to [].forEach, but handles items asynchronously with a final callback passed to then.

This is the most essential piece of the ArrayAsync package.

For cases where you want to loop through batches of items at once (as opposed to strictly one-by-one as forEachAsync does), check out forAllAsync and lateral.

For cases where you want to loop through all items at once and we able to know when they're all done see join

v5.x

We jumped from 3.x to 5.x because I'm considering creating a backwards-and-forwards compatible 4.x that uses AngularJS-style function introspection to allow for having the next param. Straight up, that's probably a bad idea and waste of time so I hope I don't actually do it.

Screencast

http://youtu.be/O7egvEz4scA

Usage

  // EXAMPLE ASYNC FUNCTION

  function getPicsAsync(animal) {
    var flickerApi = "http://api.flickr.com/services/feeds/photos_public.gne?tagmode=any&format=json&tags=" + animal;

    return requestAsync({ url: flickerApi });
  }

  forEachAsync(['dogs', 'cats', 'octocats'], function (element) {
    return getPicsAsync(element);
  }).then(function () {
    // then after all of the elements have been handled
    // the final callback fires to let you know it's all done
    console.log('All requests have finished');
  });

Supplying your own Promises Implementation

If native ES6 promises are not available, then you should supply your own Promises/A+ implementation like so:

  forEachAsync = forEachAsync.create(window.Promise || require('bluebird'));

Browser Installation

You can install from bower:

bower install --save [email protected]

Or download the raw file from https://raw.github.com/FuturesJS/forEachAsync/master/forEachAsync.js:

wget https://raw.github.com/FuturesJS/forEachAsync/master/forEachAsync.js

(function () {
  'use strict';

  var forEachAsync = window.forEachAsync
    ;

  // do stuff ...
}());

Note: If you need both 3.x/4.x and 5.x version of forEachAsync in the browser... good luck with that...

Node Installation

npm install --save [email protected]

API

forEachAsync(array, callback[, thisArg])

Parameters

• array Array of elements to iterate over
• callback Function to execute for each element, takes 4 arguments
  • element a single element of the aforementioned array
  • index the index of the current element
  • array the same array mentioned above
• thisArg Object to use as this when executing callback

forEachAsync#then(done)

Parameters

• then is in the return value of forEachAsync and accepts a final done callback.
  • done called after forEachAsync is complete, takes no arguments

Internal API

forEachAsync.__BREAK

This is used internally for the purposes of the ArrayAsync library.

Please don't break stuff; use ArrayAsync.someAsync or ArrayAsync.everyAsync instead.

Versions

Version
3.0.0 Feb 14, 2018