1'use strict'; 2 3Object.defineProperty(exports, "__esModule", { 4 value: true 5}); 6exports.default = cargo; 7 8var _queue = require('./internal/queue.js'); 9 10var _queue2 = _interopRequireDefault(_queue); 11 12function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } 13 14/** 15 * Creates a `cargo` object with the specified payload. Tasks added to the 16 * cargo will be processed altogether (up to the `payload` limit). If the 17 * `worker` is in progress, the task is queued until it becomes available. Once 18 * the `worker` has completed some tasks, each callback of those tasks is 19 * called. Check out [these](https://camo.githubusercontent.com/6bbd36f4cf5b35a0f11a96dcd2e97711ffc2fb37/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f313637363837312f36383130382f62626330636662302d356632392d313165322d393734662d3333393763363464633835382e676966) [animations](https://camo.githubusercontent.com/f4810e00e1c5f5f8addbe3e9f49064fd5d102699/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f313637363837312f36383130312f38346339323036362d356632392d313165322d383134662d3964336430323431336266642e676966) 20 * for how `cargo` and `queue` work. 21 * 22 * While [`queue`]{@link module:ControlFlow.queue} passes only one task to one of a group of workers 23 * at a time, cargo passes an array of tasks to a single worker, repeating 24 * when the worker is finished. 25 * 26 * @name cargo 27 * @static 28 * @memberOf module:ControlFlow 29 * @method 30 * @see [async.queue]{@link module:ControlFlow.queue} 31 * @category Control Flow 32 * @param {AsyncFunction} worker - An asynchronous function for processing an array 33 * of queued tasks. Invoked with `(tasks, callback)`. 34 * @param {number} [payload=Infinity] - An optional `integer` for determining 35 * how many tasks should be processed per round; if omitted, the default is 36 * unlimited. 37 * @returns {module:ControlFlow.QueueObject} A cargo object to manage the tasks. Callbacks can 38 * attached as certain properties to listen for specific events during the 39 * lifecycle of the cargo and inner queue. 40 * @example 41 * 42 * // create a cargo object with payload 2 43 * var cargo = async.cargo(function(tasks, callback) { 44 * for (var i=0; i<tasks.length; i++) { 45 * console.log('hello ' + tasks[i].name); 46 * } 47 * callback(); 48 * }, 2); 49 * 50 * // add some items 51 * cargo.push({name: 'foo'}, function(err) { 52 * console.log('finished processing foo'); 53 * }); 54 * cargo.push({name: 'bar'}, function(err) { 55 * console.log('finished processing bar'); 56 * }); 57 * await cargo.push({name: 'baz'}); 58 * console.log('finished processing baz'); 59 */ 60function cargo(worker, payload) { 61 return (0, _queue2.default)(worker, 1, payload); 62} 63module.exports = exports['default'];