Skip to content

docs(mapSeries): add example #2108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
whoalin1 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(mapSeries): add example #2108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions lib/mapSeries.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,29 @@ import awaitify from './internal/awaitify.js'
* functions have finished, or an error occurs. Results is an array of the
* transformed items from the `coll`. Invoked with (err, results).
* @returns {Promise} a promise, if no callback is passed
* @example
*
* // One item at a time. Results stay in input order.
* const ids = [1, 2, 3];
*
* function fetchItem(id, callback) {
* setTimeout(() => {
* callback(null, { id });
* }, 100);
* }
*
* async.mapSeries(ids, fetchItem, (err, results) => {
* if (err) throw err;
* console.log(results);
* // [ { id: 1 }, { id: 2 }, { id: 3 } ]
* });
*
* // Omit the callback and mapSeries returns a Promise.
* const results = await async.mapSeries(ids, async (id) => {
* return { id };
* });
* console.log(results);
* // [ { id: 1 }, { id: 2 }, { id: 3 } ]
*/
function mapSeries (coll, iteratee, callback) {
return _map(eachOfSeries, coll, iteratee, callback)
Expand Down