time-to-botec/squiggle/node_modules/@stdlib/utils/map-keys/lib/map_keys.js
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

82 lines
2.2 KiB
JavaScript

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
// MODULES //
var isFunction = require( '@stdlib/assert/is-function' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
// MAIN //
/**
* Maps keys from one object to a new object having the same values.
*
* ## Notes
*
* - Iteration order is **not** guaranteed.
* - We need to cache an object value to prevent the edge case where, during the invocation of the transform function, the value corresponding to a particular key is swapped for some other value. For some, that might be a feature; here, we take the stance that one should be less clever.
*
*
* @param {Object} obj - source object
* @param {Function} transform - transform function
* @throws {TypeError} first argument must be an object
* @throws {TypeError} second argument must be a function
* @returns {Object} new object
*
* @example
* function transform( key, value ) {
* return key + value;
* }
*
* var obj1 = {
* 'a': 1,
* 'b': 2
* };
*
* var obj2 = mapKeys( obj1, transform );
* // returns { 'a1': 1, 'b2': 2 }
*/
function mapKeys( obj, transform ) {
var out;
var key;
var v;
if ( typeof obj !== 'object' || obj === null ) {
throw new TypeError( 'invalid argument. First argument must be an object. Value: `'+obj+'`.' );
}
if ( !isFunction( transform ) ) {
throw new TypeError( 'invalid argument. Second argument must be a function. Value: `'+transform+'`.' );
}
out = {};
for ( key in obj ) {
if ( hasOwnProp( obj, key ) ) {
v = obj[ key ];
key = transform( key, v, obj );
out[ key ] = v;
}
}
return out;
}
// EXPORTS //
module.exports = mapKeys;