https://github.com/sindresorhus/camelcase

Convert a dash/dot/underscore/space separated string to camelCase: foo-bar → fooBar
https://github.com/sindresorhus/camelcase

Last synced: 28 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/sindresorhus/camelcase
• Owner: sindresorhus
• License: mit
• Created: 2014-10-12T10:58:21.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2023-09-29T06:30:04.000Z (about 1 year ago)
• Last Synced: 2024-04-13T21:25:39.344Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 77.1 KB
• Stars: 659
• Watchers: 14
• Forks: 100
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome-development - camelcase - Convert a dash/dot/underscore/space separated string to camelCase: foo-bar → fooBar. (Packages / Text)
• awesome-nodejs-cn - camelcase - 将破折号/点号/下划线/空格分隔的字符串转换为驼峰式,案例：foo-bar→fooBar. (包 / 文本)
• awesome-nodejs - camelcase - Convert a dash/dot/underscore/space separated string to camelCase: foo-bar → fooBar. (Repository / Text/String)
• awesome-nodejs-cn - camelcase - **star:662** 将以破折号/点/下划线/空格分隔的字符串转换为camelCase: foo-bar→fooBar (包 / 文本)
• awesome-nodejs - camelcase - Convert a dash/dot/underscore/space separated string to camelCase: foo-bar → fooBar. (Packages / Text)
• awesome-nodejs - camelcase - Convert a dash/dot/underscore/space separated string to camelCase: foo-bar → fooBar - ★ 260 (Text)
• awesome-node - camelcase - Convert a dash/dot/underscore/space separated string to camelCase: foo-bar → fooBar. (Packages / Text)
• awesome-nodejs-cn - camelcase - 将破折号/点号/下划线/空格分隔的字符串转换为驼峰式,案例：foo-bar→fooBar. (目录 / 文本处理)

README

        
# camelcase

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

Correctly handles Unicode strings.

If you use this on untrusted user input, don't forget to limit the length to something reasonable.

## Install

```sh

npm install camelcase

```

## Usage

```js

import camelCase from 'camelcase';

camelCase('foo-bar');

//=> 'fooBar'

camelCase('foo_bar');

//=> 'fooBar'

camelCase('Foo-Bar');

//=> 'fooBar'

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

//=> 'розовыйПушистыйЕдинорог'

camelCase('foo bar');

//=> 'fooBar'

console.log(process.argv[3]);

//=> '--foo-bar'

camelCase(process.argv[3]);

//=> 'fooBar'

camelCase(['foo', 'bar']);

//=> 'fooBar'

camelCase(['__foo__', '--bar']);

//=> 'fooBar'

```

## API

### camelCase(input, options?)

#### input

Type: `string | string[]`

The string to convert to camel case.

#### options

Type: `object`

##### pascalCase

Type: `boolean`\

Default: `false`

Uppercase the first character: `foo-bar` → `FooBar`

```js

import camelCase from 'camelcase';

camelCase('foo-bar', {pascalCase: true});

//=> 'FooBar'

camelCase('foo-bar', {pascalCase: false});

//=> 'fooBar'

```

##### preserveConsecutiveUppercase

Type: `boolean`\

Default: `false`

Preserve consecutive uppercase characters: `foo-BAR` → `FooBAR`

```js

import camelCase from 'camelcase';

camelCase('foo-BAR', {preserveConsecutiveUppercase: true});

//=> 'fooBAR'

camelCase('foo-BAR', {preserveConsecutiveUppercase: false});

//=> 'fooBar'

````

##### locale

Type: `false | 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.

```js

import camelCase from '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'

```

Setting `locale: false` ignores the platform locale and uses the [Unicode Default Case Conversion](https://unicode-org.github.io/icu/userguide/transforms/casemappings.html#simple-single-character-case-mapping) algorithm:

```js

import camelCase from 'camelcase';

// On a platform with `tr-TR`.

camelCase('lorem-ipsum');

//=> 'loremİpsum'

camelCase('lorem-ipsum', {locale: false});

//=> 'loremIpsum'

```

## Related

- [decamelize](https://github.com/sindresorhus/decamelize) - The inverse of this module

- [titleize](https://github.com/sindresorhus/titleize) - Capitalize every word in string

- [humanize-string](https://github.com/sindresorhus/humanize-string) - Convert a camelized/dasherized/underscored string into a humanized one

- [camelcase-keys](https://github.com/sindresorhus/camelcase-keys) - Convert object keys to camel case