camelcase-keys
Advanced tools
Package description
The camelcase-keys npm package is designed to convert object keys to camel case. It can be used to transform keys in objects, arrays of objects, and deeply nested objects. This is particularly useful when dealing with APIs that return data in snake_case or other formats and you want to convert the keys to camelCase to maintain JavaScript naming conventions.
Convert object keys to camel case
Converts the keys of a single object to camel case. For example, {'foo_bar': true} would become {'fooBar': true}.
{"foo_bar": true}Convert array of objects
Converts the keys of every object in an array to camel case. For example, [{'foo_bar': true}, {'bar_baz': false}] would become [{'fooBar': true}, {'barBaz': false}].
[{"foo_bar": true}, {"bar_baz": false}]Deep key conversion
Converts keys to camel case recursively for deeply nested objects. For example, {'foo_bar': {'inner_key': 'value', 'another_key': {'deep_key': 'deep_value'}}} would become {'fooBar': {'innerKey': 'value', 'anotherKey': {'deepKey': 'deepValue'}}}.
{"foo_bar": {"inner_key": "value", "another_key": {"deep_key": "deep_value"}}}Exclude keys from being camelCased
Allows certain keys to be excluded from being converted to camel case. For example, {'foo_bar': true, 'do_not_change': false} with 'do_not_change' as an excluded key would result in {'fooBar': true, 'do_not_change': false}.
{"foo_bar": true, "do_not_change": false}The humps package is similar to camelcase-keys and provides functions for converting between camelCase and snake_case. It also offers the ability to decamelize keys, which camelcase-keys does not.
As the name suggests, snakecase-keys is designed to convert object keys to snake_case. It is the opposite of camelcase-keys, which converts keys to camelCase.
This package offers a variety of case transformations for object keys, including camelCase, snake_case, and others. It provides more general case conversion functionality compared to camelcase-keys, which focuses specifically on camelCasing.
Readme
Convert object keys to camel case using
camelcase
npm install camelcase-keys
import camelcaseKeys from '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}}
import {parseArgs} from 'node:utils';
import camelcaseKeys from 'camelcase-keys';
const commandLineArguments = parseArgs();
//=> {_: [], 'foo-bar': true}
camelcaseKeys(commandLineArguments);
//=> {_: [], fooBar: true}
Type: object | object[]
An object or array of objects to camel-case.
Type: object
Type: Array<string | RegExp>
Default: []
Exclude keys from being camel-cased.
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
}
}
}
*/
Type: boolean
Default: false
Recurse nested objects and objects in arrays.
Type: boolean
Default: false
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.
FAQs
Convert object keys to camel case
The npm package camelcase-keys receives a total of 13,599,962 weekly downloads. As such, camelcase-keys popularity was classified as popular.
We found that camelcase-keys demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.