|
|
# camelcase [![Build Status](https://travis-ci.org/sindresorhus/camelcase.svg?branch=master)](https://travis-ci.org/sindresorhus/camelcase)
|
|
|
|
|
|
> Convert a dash/dot/underscore/space separated string to camelCase or PascalCase: `foo-bar` → `fooBar`
|
|
|
|
|
|
Correctly handles Unicode strings.
|
|
|
|
|
|
## Install
|
|
|
|
|
|
```
|
|
|
$ npm install camelcase
|
|
|
```
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
```js
|
|
|
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');
|
|
|
//=> 'fooBar'
|
|
|
|
|
|
console.log(process.argv[3]);
|
|
|
//=> '--foo-bar'
|
|
|
camelCase(process.argv[3]);
|
|
|
//=> 'fooBar'
|
|
|
|
|
|
camelCase(['foo', 'bar']);
|
|
|
//=> 'fooBar'
|
|
|
|
|
|
camelCase(['__foo__', '--bar'], {pascalCase: true});
|
|
|
//=> 'FooBar'
|
|
|
```
|
|
|
|
|
|
## 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`
|
|
|
|
|
|
## 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.](https://tidelift.com/subscription/pkg/npm-camelcase?utm_source=npm-camelcase&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
|
|
|
|
|
|
## Related
|
|
|
|
|
|
- [decamelize](https://github.com/sindresorhus/decamelize) - The inverse of this module
|
|
|
- [uppercamelcase](https://github.com/SamVerschueren/uppercamelcase) - Like this module, but to PascalCase instead of camelCase
|
|
|
- [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
|