├── .editorconfig ├── .gitattributes ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.js ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 16 14 | steps: 15 | - uses: actions/checkout@v2 16 | - uses: actions/setup-node@v2 17 | with: 18 | node-version: ${{ matrix.node-version }} 19 | - run: npm install 20 | - run: npm test 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | export default function modifyKeys(object, transformer) { 2 | return Object.fromEntries(Object.entries(object).map(([key, value]) => [transformer(key), value])); 3 | } 4 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "modify-keys", 3 | "version": "2.0.0", 4 | "description": "Modify the keys of an object", 5 | "license": "MIT", 6 | "repository": "sindresorhus/modify-keys", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "exports": "./index.js", 15 | "engines": { 16 | "node": "^12.20.0 || ^14.13.1 || >=16.0.0" 17 | }, 18 | "scripts": { 19 | "test": "xo && ava" 20 | }, 21 | "files": [ 22 | "index.js" 23 | ], 24 | "keywords": [ 25 | "object", 26 | "assign", 27 | "extend", 28 | "properties", 29 | "keys", 30 | "key", 31 | "transform", 32 | "transformation", 33 | "map", 34 | "modify" 35 | ], 36 | "devDependencies": { 37 | "ava": "^3.15.0", 38 | "xo": "^0.45.0" 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # modify-keys 2 | 3 | > Modify the keys of an object 4 | 5 | ## Install 6 | 7 | ```sh 8 | npm install modify-keys 9 | ``` 10 | 11 | ## Usage 12 | 13 | ```js 14 | import modifyKeys from 'modify-keys'; 15 | 16 | modifyKeys({FOO: true, bAr: false}, (key, value) => key.toLowerCase()); 17 | //=> {foo: true, bar: false} 18 | ``` 19 | 20 | ## API 21 | 22 | ### modifyKeys(input, transformer) 23 | 24 | Modifies the keys and returns a new object. 25 | 26 | #### input 27 | 28 | Type: `object` 29 | 30 | #### transformer(key, value) 31 | 32 | Type: `Function` 33 | 34 | Receives the key and value for each item and is expected to return the new key. 35 | 36 | ## Related 37 | 38 | See [`modify-values`](https://github.com/sindresorhus/modify-values) for modifying the values of an object. 39 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import modifyKeys from './index.js'; 3 | 4 | test('main', t => { 5 | t.true(modifyKeys({FOO: true}, x => x.toLowerCase()).foo); 6 | }); 7 | --------------------------------------------------------------------------------