camelcase-keys

What is camelcase-keys?

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.

What are camelcase-keys's main functionalities?

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}

Other packages similar to camelcase-keys

humps

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.

snakecase-keys

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.

change-case-object

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

camelcase-keys

Convert object keys to camel case using camelcase

Install

npm install camelcase-keys

Usage

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}]

import {parseArgs} from 'node:util';
import camelcaseKeys from 'camelcase-keys';

const commandLineArguments = parseArgs();
//=> {_: [], 'foo-bar': true}

camelcaseKeys(commandLineArguments);
//=> {_: [], fooBar: true}

API

camelcaseKeys(input, options?)

input

Type: Record<string, unknown> | ReadonlyArray<Record<string, unknown>>

A plain object or array of plain objects to camel-case.

options

Type: object

exclude

Type: Array<string | RegExp>
Default: []

Exclude keys from being camel-cased.

deep

Type: boolean
Default: false

Recurse nested objects and objects in arrays.

import camelcaseKeys from 'camelcase-keys';

const object = {
	'foo-bar': true,
	nested: {
		unicorn_rainbow: true
	}
};

camelcaseKeys(object, {deep: true});
//=> {fooBar: true, nested: {unicornRainbow: true}}

camelcaseKeys(object, {deep: false});
//=> {fooBar: true, nested: {unicorn_rainbow: true}}

pascalCase

Type: boolean
Default: false

Uppercase the first character: bye-bye → ByeBye

import camelcaseKeys from 'camelcase-keys';

camelcaseKeys({'foo-bar': true}, {pascalCase: true});
//=> {FooBar: true}

camelcaseKeys({'foo-bar': true}, {pascalCase: false});
//=> {fooBar: true}

preserveConsecutiveUppercase

Type: boolean
Default: false

Preserve consecutive uppercase characters: foo-BAR → FooBAR

import camelcaseKeys from 'camelcase-keys';

camelcaseKeys({'foo-BAR': true}, {preserveConsecutiveUppercase: true});
//=> {fooBAR: true}

camelcaseKeys({'foo-BAR': true}, {preserveConsecutiveUppercase: false});
//=> {fooBar: true}

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'.

import camelcaseKeys from 'camelcase-keys';

const object = {
	a_b: 1,
	a_c: {
		c_d: 1,
		c_e: {
			e_f: 1
		}
	}
};

camelcaseKeys(object, {
	deep: true,
	stopPaths: [
		'a_c.c_e'
	]
}),
/*
{
	aB: 1,
	aC: {
		cD: 1,
		cE: {
			e_f: 1
		}
	}
}
*/

Related

• decamelize-keys - The inverse of this package
• snakecase-keys
• kebabcase-keys