Need help with camelcase?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

sindresorhus
466 Stars 58 Forks MIT License 78 Commits 1 Opened issues

Description

Convert a dash/dot/underscore/space separated string to camelCase: foo-bar → fooBar

Services available

!
?

Need anything else?

Contributors list

camelcase

Convert a dash/dot/underscore/space separated string to camelCase or PascalCase:

foo-bar
fooBar

Correctly handles Unicode strings.

Install

$ npm install camelcase

If you need to support Firefox, stay on version 5 as version 6 uses regex features not available in Firefox.

Usage

const camelCase = require('camelcase');

camelCase('foo-bar'); //=> 'fooBar'

camelCase('foo_bar'); //=> 'fooBar'

camelCase('Foo-Bar'); //=> 'fooBar'

camelCase('розовый_пушистый_единороги'); //=> 'розовыйПушистыйЕдинороги'

camelCase('Foo-Bar', {pascalCase: true}); //=> 'FooBar'

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

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

camelCase('fooBAR', {pascalCase: true, preserveConsecutiveUppercase: true})); //=> 'FooBAR'

camelCase('foo bar'); //=> 'fooBar'

console.log(process.argv[3]); //=> '--foo-bar' camelCase(process.argv[3]); //=> 'fooBar'

camelCase(['foo', 'bar']); //=> 'fooBar'

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

camelCase(['foo', 'BAR'], {pascalCase: true, preserveConsecutiveUppercase: true}) //=> 'FooBAR'

camelCase('lorem-ipsum', {locale: 'en-US'}); //=> 'loremIpsum'

API

camelCase(input, options?)

input

Type:

string | string[]

String to convert to camel case.

options

Type:

object
pascalCase

Type:

boolean
\ Default:
false

Uppercase the first character:

foo-bar
FooBar
preserveConsecutiveUppercase

Type:

boolean
\ Default:
false

Preserve the consecutive uppercase characters:

foo-BAR
FooBAR
.
locale

Type:

string | string[]
\ Default: The host environment’s current locale.

The locale parameter indicates the locale to be used to convert to upper/lower case according to any locale-specific case mappings. If multiple locales are given in an array, the best available locale is used.

const camelCase = require('camelcase');

camelCase('lorem-ipsum', {locale: 'en-US'}); //=> 'loremIpsum'

camelCase('lorem-ipsum', {locale: 'tr-TR'}); //=> 'loremİpsum'

camelCase('lorem-ipsum', {locale: ['en-US', 'en-GB']}); //=> 'loremIpsum'

camelCase('lorem-ipsum', {locale: ['tr', 'TR', 'tr-TR']}); //=> 'loremİpsum'

camelcase for enterprise

Available as part of the Tidelift Subscription.

The maintainers of camelcase 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.

Related

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.