Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

camelcase-keys

Package Overview
Dependencies
4
Maintainers
1
Versions
23
Issues
File Explorer

Advanced tools

camelcase-keys

Convert object keys to camel case

    8.0.1latest

Version published
Maintainers
1
Weekly downloads
15,419,035
decreased by-5.03%

Weekly downloads

Changelog

Source

  • Improve type definition (#92) 264cc70

https://github.com/sindresorhus/camelcase-keys/compare/v8.0.0...v8.0.1

Readme

Source

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

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

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.

Keywords

FAQs

What is camelcase-keys?

Convert object keys to camel case

Is camelcase-keys popular?

The npm package camelcase-keys receives a total of 14,746,906 weekly downloads. As such, camelcase-keys popularity was classified as popular.

Is camelcase-keys well maintained?

We found that camelcase-keys demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 22 Jun 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc