Awesome
rename-keys
Modify the names of the own enumerable properties (keys) of an object.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
Install
Install with npm:
$ npm install --save rename-keys
Usage
var renameKeys = require('rename-keys');
API
Params
object
{Object}: The object with keys to rename.fn
{Function}: Renaming function to use on each key in the object.returns
{Object}: Returns a new object with renamed keys.
Example
var obj = renameKeys({a: 1, b: 2, c: 3}, function(key, val) {
return '--' + key;
});
console.log(obj);
//=> { '--a': 1, '--b': 2, '--c': 3}
Rename based on value
var obj = renameKeys({a: 1, b: 2, c: 3}, function(key, val) {
return val > 1 ? ('++' + key) : ('--' + key);
});
console.log(obj);
//=> {'--a': 1, '++b': 2, '++c': 3};
About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Contributors
Commits | Contributor |
---|---|
15 | jonschlinkert |
5 | doowb |
2 | stellard |
1 | kof |
1 | robinbullocks4rb |
1 | palanik |
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Author
Jon Schlinkert
License
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on October 13, 2017.