index.js (1754B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Invoke a function once for each element in a collection and update a collection in-place. 23 * 24 * @module @stdlib/utils/async/inmap 25 * 26 * @example 27 * var readFile = require( '@stdlib/fs/read-file' ); 28 * var inmapAsync = require( '@stdlib/utils/async/inmap' ); 29 * 30 * var files = [ 31 * './beep.js', 32 * './boop.js' 33 * ]; 34 * 35 * function done( error, results ) { 36 * if ( error ) { 37 * throw error; 38 * } 39 * console.log( results ); 40 * } 41 * 42 * function read( file, next ) { 43 * var opts = { 44 * 'encoding': 'utf8' 45 * }; 46 * readFile( file, opts, onFile ); 47 * 48 * function onFile( error, data ) { 49 * if ( error ) { 50 * error = new Error( 'unable to read file: '+file ); 51 * return next( error ); 52 * } 53 * next( null, data ); 54 * } 55 * } 56 * 57 * inmapAsync( files, read, done ); 58 */ 59 60 // MODULES // 61 62 var setReadOnly = require( './../../../define-nonenumerable-read-only-property' ); 63 var inmapAsync = require( './inmap.js' ); 64 var factory = require( './factory.js' ); 65 66 67 // MAIN // 68 69 setReadOnly( inmapAsync, 'factory', factory ); 70 71 72 // EXPORTS // 73 74 module.exports = inmapAsync;