pnpm
Version:
A fast implementation of npm install
68 lines (38 loc) • 1.15 kB
Markdown
# camelcase-keys [](https://travis-ci.org/sindresorhus/camelcase-keys)
> Convert object keys to camelCase using [`camelcase`](https://github.com/sindresorhus/camelcase)
## Install
```
$ npm install --save camelcase-keys
```
## Usage
```js
const camelcaseKeys = require('camelcase-keys');
camelcaseKeys({'foo-bar': true});
//=> {fooBar: true}
camelcaseKeys({'foo-bar': true, nested: {unicorn_rainbow: true}}, {deep: true});
//=> {fooBar: true, nested: {unicornRainbow: true}}
```
```js
const camelcaseKeys = require('camelcase-keys');
const argv = require('minimist')(process.argv.slice(2));
//=> {_: [], 'foo-bar': true}
camelcaseKeys(argv);
//=> {_: [], fooBar: true}
```
## API
### camelcaseKeys(input, [options])
#### input
Type: `Object`
Object to camelCase.
#### options
Type: `Object`
##### exclude
Type: `string[]` `RegExp[]`<br>
Default: `[]`
Exclude keys from being camelCased.
##### deep
Type: `boolean`<br>
Default: `false`
Recurse nested objects and objects in arrays.
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)