@stdlib/utils-map-values
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

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

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, transform );

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-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/utils-map-values

Homepage

stdlib.io

Weekly Downloads

13

Version

0.2.1

License

Apache-2.0

Unpacked Size

30.7 kB

Total Files

11

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser