summaryrefslogtreecommitdiff
path: root/lib/someLimit.js
blob: 521c1165603100fc96446e1b2a1ee5f0aa04071f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
'use strict';

import createTester from './internal/createTester';
import eachOfLimit from './eachOfLimit';
import identity from 'lodash/identity';

/**
 * The same as `some` but runs a maximum of `limit` async operations at a time.
 *
 * @name someLimit
 * @static
 * @memberOf async
 * @see async.some
 * @alias anyLimit
 * @category Collection
 * @param {Array|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 the array
 * in parallel. 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 either `true` or `false` depending on the values of the async
 * tests. Invoked with (err, result).
 */
export default createTester(eachOfLimit, Boolean, identity);