Morph MORPH
SIGN IN SIGN UP
caolan / async UNCLAIMED

Async utilities for node and the browser

28184 0 0 JavaScript
Normal View History Raw
be explicit (#1769)
2021-11-16 19:34:17 +01:00
import _map from './internal/map.js'
import eachOf from './eachOf.js'
import awaitify from './internal/awaitify.js'
Fix implementations (test green lights)
2015-12-23 18:29:52 -05:00
jsdoc-style documentation for 'collection' methods Converted documentation from README to jsdoc-style for respective methods. Currently, only done for 'collection' methods. jsdoc-style documentation - fixed 'collection' methods documentation Only the base functions now contain an example, while the `series` and `limit` versions simply contain a reference to the base function. Fixed styling issue and misspelled tag.
2016-03-29 04:09:31 -07:00
/**
* Produces a new collection of values by mapping each value in `coll` through
* the `iteratee` function. The `iteratee` is called with an item from `coll`
Fix(docs): use plural `callbacks` word in `lib/map.js` (#1765)
2021-10-04 17:18:30 -05:00
* and a callback for when it has finished processing. Each of these callbacks
jsdoc-style documentation for 'collection' methods Converted documentation from README to jsdoc-style for respective methods. Currently, only done for 'collection' methods. jsdoc-style documentation - fixed 'collection' methods documentation Only the base functions now contain an example, while the `series` and `limit` versions simply contain a reference to the base function. Fixed styling issue and misspelled tag.
2016-03-29 04:09:31 -07:00
* takes 2 arguments: an `error`, and the transformed item from `coll`. If
* `iteratee` passes an error to its callback, the main `callback` (for the
* `map` function) is immediately called with the error.
*
* Note, that since this function applies the `iteratee` to each item in
* parallel, there is no guarantee that the `iteratee` functions will complete
* in order. However, the results array will be in the same order as the
* original `coll`.
*
have map always return arrays
2016-05-31 16:36:09 -07:00
* If `map` is passed an Object, the results will be an Array. The results
* will roughly be in the order of the original Objects' keys (but this can
[#1348] initial groupBy implementation (#1364) * initial groupBy implementation
2017-02-27 00:05:05 -05:00
* vary across JavaScript engines).
have map always return arrays
2016-05-31 16:36:09 -07:00
*
jsdoc-style documentation for 'collection' methods Converted documentation from README to jsdoc-style for respective methods. Currently, only done for 'collection' methods. jsdoc-style documentation - fixed 'collection' methods documentation Only the base functions now contain an example, while the `series` and `limit` versions simply contain a reference to the base function. Fixed styling issue and misspelled tag.
2016-03-29 04:09:31 -07:00
* @name map
* @static
jsdocs: using proxy modules as categories, modifying minami theme jsdocs: style fix in outputted html jsdoc: added documentation to support script
2016-06-29 01:35:29 -04:00
* @memberOf module:Collections
Initial jsdoc documentation (using minami template)
2016-06-29 01:30:17 -04:00
* @method
jsdoc-style documentation for 'collection' methods Converted documentation from README to jsdoc-style for respective methods. Currently, only done for 'collection' methods. jsdoc-style documentation - fixed 'collection' methods documentation Only the base functions now contain an example, while the `series` and `limit` versions simply contain a reference to the base function. Fixed styling issue and misspelled tag.
2016-03-29 04:09:31 -07:00
* @category Collection
[wip] initial async generator support (#1560) feat: initial async generator support
2018-08-05 13:35:58 -07:00
* @param {Array|Iterable|AsyncIterable|Object} coll - A collection to iterate over.
use the AsyncFunction type in all docs :sweat:
2017-04-01 15:05:52 -07:00
* @param {AsyncFunction} iteratee - An async function to apply to each item in
* `coll`.
* The iteratee should complete with the transformed item.
* Invoked with (item, callback).
jsdoc-style documentation for 'collection' methods Converted documentation from README to jsdoc-style for respective methods. Currently, only done for 'collection' methods. jsdoc-style documentation - fixed 'collection' methods documentation Only the base functions now contain an example, while the `series` and `limit` versions simply contain a reference to the base function. Fixed styling issue and misspelled tag.
2016-03-29 04:09:31 -07:00
* @param {Function} [callback] - A callback which is called when all `iteratee`
have map always return arrays
2016-05-31 16:36:09 -07:00
* functions have finished, or an error occurs. Results is an Array of the
jsdoc-style documentation for 'collection' methods Converted documentation from README to jsdoc-style for respective methods. Currently, only done for 'collection' methods. jsdoc-style documentation - fixed 'collection' methods documentation Only the base functions now contain an example, while the `series` and `limit` versions simply contain a reference to the base function. Fixed styling issue and misspelled tag.
2016-03-29 04:09:31 -07:00
* transformed items from the `coll`. Invoked with (err, results).
feat: await-able Async methods (#1572) * make each and family awaitable * dont pretend they're AsyncFunctions * check errors * ensure function name is preserved somehow * awaitable concat * awaitable detect * awaitable every/filter * awaitable groupBy * awaitable map/mapValues * awaitable reduce * awaitable reject * awaitable some * awaitable transform * awaitable times * awaitable auto * awaitable compose/seq * awaitable whilst/until (lol) * awaitable forever * awaitable parallel/race * awaitable retry * awaitable series (lol) * awaitable tryEach * awaitable waterfall (lol) * lint * cleanup, remove noop and unused internal functions
2018-09-30 17:00:10 -07:00
* @returns {Promise} a promise, if no callback is passed
jsdoc-style documentation for 'collection' methods Converted documentation from README to jsdoc-style for respective methods. Currently, only done for 'collection' methods. jsdoc-style documentation - fixed 'collection' methods documentation Only the base functions now contain an example, while the `series` and `limit` versions simply contain a reference to the base function. Fixed styling issue and misspelled tag.
2016-03-29 04:09:31 -07:00
* @example
*
Enhance examples for Collections methods. (#1726) * Enhance examples for Collections methods. * Update collection example code, avoiding usage of IIFE on async/await examples * Convert examples on async.auto, async.series, and async.parallel to samples using Promises and async/await Co-authored-by: Roman Balayan <roman.balayan@paymaya.com>
2021-08-06 06:58:10 +08:00
* // file1.txt is a file that is 1000 bytes in size
* // file2.txt is a file that is 2000 bytes in size
* // file3.txt is a file that is 3000 bytes in size
* // file4.txt does not exist
*
* const fileList = ['file1.txt','file2.txt','file3.txt'];
* const withMissingFileList = ['file1.txt','file2.txt','file4.txt'];
*
* // asynchronous function that returns the file size in bytes
* function getFileSizeInBytes(file, callback) {
* fs.stat(file, function(err, stat) {
* if (err) {
* return callback(err);
* }
* callback(null, stat.size);
* });
* }
*
* // Using callbacks
* async.map(fileList, getFileSizeInBytes, function(err, results) {
* if (err) {
* console.log(err);
* } else {
* console.log(results);
* // results is now an array of the file size in bytes for each file, e.g.
* // [ 1000, 2000, 3000]
* }
* });
*
* // Error Handling
* async.map(withMissingFileList, getFileSizeInBytes, function(err, results) {
* if (err) {
* console.log(err);
* // [ Error: ENOENT: no such file or directory ]
* } else {
* console.log(results);
* }
* });
*
* // Using Promises
* async.map(fileList, getFileSizeInBytes)
* .then( results => {
* console.log(results);
* // results is now an array of the file size in bytes for each file, e.g.
* // [ 1000, 2000, 3000]
* }).catch( err => {
* console.log(err);
* });
*
* // Error Handling
* async.map(withMissingFileList, getFileSizeInBytes)
* .then( results => {
* console.log(results);
* }).catch( err => {
* console.log(err);
* // [ Error: ENOENT: no such file or directory ]
jsdoc-style documentation for 'collection' methods Converted documentation from README to jsdoc-style for respective methods. Currently, only done for 'collection' methods. jsdoc-style documentation - fixed 'collection' methods documentation Only the base functions now contain an example, while the `series` and `limit` versions simply contain a reference to the base function. Fixed styling issue and misspelled tag.
2016-03-29 04:09:31 -07:00
* });
Enhance examples for Collections methods. (#1726) * Enhance examples for Collections methods. * Update collection example code, avoiding usage of IIFE on async/await examples * Convert examples on async.auto, async.series, and async.parallel to samples using Promises and async/await Co-authored-by: Roman Balayan <roman.balayan@paymaya.com>
2021-08-06 06:58:10 +08:00
*
* // Using async/await
* async () => {
* try {
* let results = await async.map(fileList, getFileSizeInBytes);
* console.log(results);
* // results is now an array of the file size in bytes for each file, e.g.
* // [ 1000, 2000, 3000]
* }
* catch (err) {
* console.log(err);
* }
* }
*
* // Error Handling
* async () => {
* try {
* let results = await async.map(withMissingFileList, getFileSizeInBytes);
* console.log(results);
* }
* catch (err) {
* console.log(err);
* // [ Error: ENOENT: no such file or directory ]
* }
* }
*
jsdoc-style documentation for 'collection' methods Converted documentation from README to jsdoc-style for respective methods. Currently, only done for 'collection' methods. jsdoc-style documentation - fixed 'collection' methods documentation Only the base functions now contain an example, while the `series` and `limit` versions simply contain a reference to the base function. Fixed styling issue and misspelled tag.
2016-03-29 04:09:31 -07:00
*/
feat: await-able Async methods (#1572) * make each and family awaitable * dont pretend they're AsyncFunctions * check errors * ensure function name is preserved somehow * awaitable concat * awaitable detect * awaitable every/filter * awaitable groupBy * awaitable map/mapValues * awaitable reduce * awaitable reject * awaitable some * awaitable transform * awaitable times * awaitable auto * awaitable compose/seq * awaitable whilst/until (lol) * awaitable forever * awaitable parallel/race * awaitable retry * awaitable series (lol) * awaitable tryEach * awaitable waterfall (lol) * lint * cleanup, remove noop and unused internal functions
2018-09-30 17:00:10 -07:00
function map (coll, iteratee, callback) {
return _map(eachOf, coll, iteratee, callback)
}
export default awaitify(map, 3);
Reference in New Issue Copy Permalink