Convert object keys to camel case
npm install @lafourche/camelcase-keys> Convert object keys to camel case using camelcase
``
$ npm install camelcase-keys
`js
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}}}
camelcaseKeys({a_b: 1, a_c: {c_d: 1, c_e: {e_f: 1}}}, {deep: true, stopKeys: ['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}}
`
`js
const camelcaseKeys = require('camelcase-keys');
const argv = require('minimist')(process.argv.slice(2));
//=> {_: [], 'foo-bar': true}
camelcaseKeys(argv);
//=> {_: [], fooBar: true}
`
#### input
Type: object | object[]
An object or array of objects to camel-case.
#### options
Type: object
##### exclude
Type: Array\[]
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'.
`js`
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
}
}
}
*/
##### stopKeys
Type: string[]\[]
Default:
Exclude children at the given object keys from being camel-cased.
`js`
camelcaseKeys({
a_b: 1,
a_c: {
c_d: 1,
foo_bar: {
foo_bar_a: 1
}
},
a_d: 1,
foo_bar: {
foo_bar_b: 1
}
}, {
deep: true,
stopKeys: [
'foo_bar'
]
}),
/*
{
aB: 1,
aC: {
cD: 1,
fooBar: {
foo_bar_a: 1
}
},
aD: 1,
fooBar: {
foo_bar_b: 1
}
}
*/
##### deep
Type: boolean\false
Default:
Recurse nested objects and objects in arrays.
##### pascalCase
Type: boolean\false
Default:
Uppercase the first character as in bye-bye → ByeBye`.
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.