Usage
var mapValuesAsync = require( '@stdlib/utils-async-map-values' );
mapValuesAsync( obj, [options,] transform, done )
Map values from one object
to a new object
having the same keys.
function transform( value, next ) {
setTimeout( onTimeout, value );
function onTimeout() {
next( null, value*2 );
}
}
function done( error, out ) {
if ( error ) {
throw error;
}
console.log( out );
// => { 'a': 2, 'b': 4 }
}
var obj = {
'a': 1,
'b': 2
};
mapValuesAsync( obj, transform, done );
The next
callback accepts two arguments: error
and value
. The second argument to the next
callback is the transformed property value. If a transform
function calls the next
callback with a truthy error argument, the function stops processing any additional own properties and calls the done
callback for error processing.
function transform( value, key, next ) {
setTimeout( onTimeout, value );
function onTimeout() {
if ( key === 'a' ) {
return next( new Error( 'beep' ) );
}
next( null, value );
}
}
function done( error ) {
if ( error ) {
console.error( error.message );
// => 'beep'
}
}
var obj = {
'a': 1,
'b': 2
};
mapValuesAsync( obj, transform, done );
The function accepts the following options
:
limit
: the maximum number of pending invocations at any one time. Default: infinity
.
series
: boolean
indicating whether to sequentially invoke the transform
function for each own property. If true
, the function sets options.limit=1
. Default: false
.
thisArg
: the execution context for fcn
.
By default, all properties are processed concurrently, which means that the function does not guarantee completion order. To process each property sequentially, set the series
option to true
.
function transform( value, next ) {
setTimeout( onTimeout, value );
function onTimeout() {
next( null, 'beep:'+value );
}
}
function done( error, out ) {
if ( error ) {
throw error;
}
console.log( out );
// => { 'a': 'beep:1', 'b': 'beep:2' }
}
var obj = {
'a': 1,
'b': 2
};
var opts = {
'series': true
};
mapValuesAsync( obj, opts, transform, done );
To limit the maximum number of pending function invocations, set the limit
option.
function transform( value, next ) {
setTimeout( onTimeout, value );
function onTimeout() {
next( null, 'beep:'+value );
}
}
function done( error, out ) {
if ( error ) {
throw error;
}
console.log( out );
// => { 'a': 'beep:1', 'b': 'beep:2', 'c': 'beep:3' }
}
var obj = {
'a': 1,
'b': 2,
'c': 3
};
var opts = {
'limit': 2
};
mapValuesAsync( obj, opts, transform, done );
To set the execution context of the transform
function, set the thisArg
option.
function transform( value, next ) {
this.count += 1;
setTimeout( onTimeout, value );
function onTimeout() {
next( null, 'beep:'+value );
}
}
var obj = {
'a': 1,
'b': 2,
'c': 3
};
var context = {
'count': 0
};
var opts = {
'thisArg': context
};
mapValuesAsync( obj, opts, transform, done );
function done( error, out ) {
if ( error ) {
throw error;
}
console.log( out );
// => { 'a': 'beep:1', 'b': 'beep:2', 'c': 'beep:3' }
console.log( context.count );
// => 3
}
When invoked, the transform
function is provided a maximum of four arguments:
value
: object value corresponding to key
.
key
: object key.
obj
: source object.
next
: a callback which should be called once the transform
function has finished processing a property value
.
The actual number of provided arguments depends on function length
. If the transform
function accepts two arguments, the transform
function is provided value
and next
. If the transform
function accepts three arguments, the transform
function is provided value
, key
, and next
. For every other transform
function signature, the transform
function is provided all four arguments.
function transform( value, key, obj, next ) {
console.log( 'obj: %s. %s: %d', JSON.stringify( obj ), key, value );
setTimeout( onTimeout, value );
function onTimeout() {
next( null, key+':'+value );
}
}
function done( error, out ) {
if ( error ) {
throw error;
}
console.log( out );
}
var obj = {
'a': 1,
'b': 2
};
mapValuesAsync( obj, transform, done );
/* => e.g.,
obj: {"a": 1, "b": 2}. a: 1
obj: {"a": 1, "b": 2}. b: 2
{ 'a': 'a:1', 'b': 'b:2' }
*/
mapValuesAsync.factory( [options,] transform )
Returns a function
which invokes a transform
function once for each own property.
function transform( value, next ) {
setTimeout( onTimeout, value );
function onTimeout() {
next( null, 'beep:'+value );
}
}
function done( error, out ) {
if ( error ) {
throw error;
}
console.log( out );
}
var f = mapValuesAsync.factory( transform );
var obj1 = {
'a': 1,
'b': 2
};
f( obj1, done );
// => { 'a': 'beep:1', 'b': 'beep:2' }
var obj2 = {
'c': 3,
'd': 4
};
f( obj2, done );
// => { 'c': 'beep:3', 'd': 'beep:4' }
The function accepts the same options
as mapValuesAsync()
.
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community

License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.