async/lib/detectLimit.js at gh-pages · againksy/async

Repository navigation

import identity from 'lodash/identity';

import createTester from './internal/createTester';

import doParallelLimit from './internal/doParallelLimit';

import findGetResult from './internal/findGetResult';

/**

* The same as [`detect`]{@link module:Collections.detect} but runs a maximum of `limit` async operations at a

* time.

* @name detectLimit

* @static

* @memberOf module:Collections

* @method

* @see [async.detect]{@link module:Collections.detect}

* @alias findLimit

* @category Collections

* @param {Array|Iterable|Object} coll - A collection to iterate over.

* @param {number} limit - The maximum number of async operations at a time.

* @param {Function} iteratee - A truth test to apply to each item in `coll`.

* The iteratee is passed a `callback(err, truthValue)` which must be called

* with a boolean argument once it has completed. Invoked with (item, callback).

* @param {Function} [callback] - A callback which is called as soon as any

* iteratee returns `true`, or after all the `iteratee` functions have finished.

* Result will be the first item in the array that passes the truth test

* (iteratee) or the value `undefined` if none passed. Invoked with

* (err, result).

export default doParallelLimit(createTester(identity, findGetResult));