8000 GitHub - stdlib-js/utils-map-values at 6f3399ebf7855419f37a0e9bb14d380e970f6c75
[go: up one dir, main page]

Skip to content

Map values from one object to a new object having the same keys.

License

Notifications You must be signed in to change notification settings

stdlib-js/utils-map-values

Repository files navigation

mapValues

NPM version Build Status Coverage Status

Map values from one object to a new object having the same keys.

Installation

npm install @stdlib/utils-map-values

Alternatively,

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

Usage

var mapValues = require( '@stdlib/utils-map-values' );

mapValues( obj, transform )

Map values from one object to a new object having the same keys.

function transform( value, key ) {
    return key + value;
}

var obj1 = {
    'a': 1,
    'b': 2
};

var obj2 = mapValues( obj1, transform );
// returns { 'a': 'a1', 'b': 'b2' }

The transform function is provided three arguments:

  • value: object value corresponding to key
  • key: object key
  • obj: the input object

Notes

  • Key iteration order is not guaranteed, as object key enumeration is not specified according to the ECMAScript specification. In practice, however, most engines use insertion order to sort an object's keys, thus allowing for deterministic return values.
  • The function only maps values assigned to own properties. Hence, the function does not map values for inherited properties.
  • The function shallow copies key values.

Examples

var mapValues = require( '@stdlib/utils-map-values' );

function transform( value, key ) {
    return key + ':' + value;
}

var obj1 = {
    'a': 'beep',
    'b': 'boop',
    'c': 'foo',
    'd': 'bar'
};

var obj2 = mapValues( obj1, transfor
A372
m );

console.dir( obj2 );
// => { 'a': 'a:beep', 'b': 'b:boop', 'c': 'c:foo', 'd': 'd:bar' }

See Also

  • @stdlib/utils-map-keys: map keys from one object to a new object having the same values.
  • @stdlib/utils-omit-by: return a partial object copy excluding properties for which a predicate (function) returns a truthy value.
  • @stdlib/utils-pick-by: return a partial object copy containing properties for which a predicate (function) returns a truthy value.

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2023. The Stdlib Authors.

0