camelcase-keys (7.0.2)
Installation
registry=npm install camelcase-keys@7.0.2"camelcase-keys": "7.0.2"About this package
camelcase-keys
Convert object keys to camel case using
camelcase
Install
$ npm install camelcase-keys
Usage
const camelcaseKeys = require('camelcase-keys');
// Convert an object
camelcaseKeys({'foo-bar': true});
//=> {fooBar: true}
// Convert an array of objects
camelcaseKeys([{'foo-bar': true}, {'bar-foo': false}]);
//=> [{fooBar: true}, {barFoo: false}]
camelcaseKeys({'foo-bar': true, nested: {unicorn_rainbow: true}}, {deep: true});
//=> {fooBar: true, nested: {unicornRainbow: true}}
camelcaseKeys({a_b: 1, a_c: {c_d: 1, c_e: {e_f: 1}}}, {deep: true, stopPaths: ['a_c.c_e']}),
//=> {aB: 1, aC: {cD: 1, cE: {e_f: 1}}}
// Convert object keys to pascal case
camelcaseKeys({'foo-bar': true, nested: {unicorn_rainbow: true}}, {deep: true, pascalCase: true});
//=> {FooBar: true, Nested: {UnicornRainbow: true}}
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[]
An object or array of objects to camel-case.
options
Type: object
exclude
Type: Array<string | RegExp>
Default: []
Exclude keys from being camel-cased.
stopPaths
Type: string[]
Default: []
Exclude children at the given object paths in dot-notation from being camel-cased. For example, with an object like {a: {b: '🦄'}}, the object path to reach the unicorn is 'a.b'.
camelcaseKeys({
a_b: 1,
a_c: {
c_d: 1,
c_e: {
e_f: 1
}
}
}, {
deep: true,
stopPaths: [
'a_c.c_e'
]
}),
/*
{
aB: 1,
aC: {
cD: 1,
cE: {
e_f: 1
}
}
}
*/
deep
Type: boolean
Default: false
Recurse nested objects and objects in arrays.
pascalCase
Type: boolean
Default: false
Uppercase the first character as in bye-bye → ByeBye.
camelcase-keys for enterprise
Available as part of the Tidelift Subscription.
The maintainers of camelcase-keys and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.
Related
Dependencies
Dependencies
| ID | Version |
|---|---|
| camelcase | ^6.3.0 |
| map-obj | ^4.1.0 |
| quick-lru | ^5.1.1 |
| type-fest | ^1.2.1 |
Development Dependencies
| ID | Version |
|---|---|
| ava | ^2.4.0 |
| matcha | ^0.7.0 |
| tsd | ^0.17.0 |
| typescript | ^4.3.5 |
| xo | ^0.36.1 |