camelcase-keys

Convert object keys to camel case using camelcase

Install

1npm install camelcase-keys

Usage

1import camelcaseKeys from 'camelcase-keys';
2
3// Convert an object
4camelcaseKeys({'foo-bar': true});
5//=> {fooBar: true}
6
7// Convert an array of objects
8camelcaseKeys([{'foo-bar': true}, {'bar-foo': false}]);
9//=> [{fooBar: true}, {barFoo: false}]

1import {parseArgs} from 'node:util';
2import camelcaseKeys from 'camelcase-keys';
3
4const commandLineArguments = parseArgs();
5//=> {_: [], 'foo-bar': true}
6
7camelcaseKeys(commandLineArguments);
8//=> {_: [], 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.

1import camelcaseKeys from 'camelcase-keys';
2
3const object = {
4	'foo-bar': true,
5	nested: {
6		unicorn_rainbow: true
7	}
8};
9
10camelcaseKeys(object, {deep: true});
11//=> {fooBar: true, nested: {unicornRainbow: true}}
12
13camelcaseKeys(object, {deep: false});
14//=> {fooBar: true, nested: {unicorn_rainbow: true}}

pascalCase

Type: boolean
Default: false

Uppercase the first character: bye-bye → ByeBye

1import camelcaseKeys from 'camelcase-keys';
2
3camelcaseKeys({'foo-bar': true}, {pascalCase: true});
4//=> {FooBar: true}
5
6camelcaseKeys({'foo-bar': true}, {pascalCase: false});
7//=> {fooBar: true}

preserveConsecutiveUppercase

Type: boolean
Default: false

Preserve consecutive uppercase characters: foo-BAR → FooBAR

1import camelcaseKeys from 'camelcase-keys';
2
3camelcaseKeys({'foo-BAR': true}, {preserveConsecutiveUppercase: true});
4//=> {fooBAR: true}
5
6camelcaseKeys({'foo-BAR': true}, {preserveConsecutiveUppercase: false});
7//=> {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'.

1import camelcaseKeys from 'camelcase-keys';
2
3const object = {
4	a_b: 1,
5	a_c: {
6		c_d: 1,
7		c_e: {
8			e_f: 1
9		}
10	}
11};
12
13camelcaseKeys(object, {
14	deep: true,
15	stopPaths: [
16		'a_c.c_e'
17	]
18}),
19/*
20{
21	aB: 1,
22	aC: {
23		cD: 1,
24		cE: {
25			e_f: 1
26		}
27	}
28}
29*/

Related

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