2019-09-18 08:11:16 +00:00
# camelcase [![Build Status](https://travis-ci.org/sindresorhus/camelcase.svg?branch=master)](https://travis-ci.org/sindresorhus/camelcase)
2019-11-07 13:11:05 +00:00
> Convert a dash/dot/underscore/space separated string to camelCase or PascalCase: `foo-bar` → `fooBar`
2019-09-18 08:11:16 +00:00
2019-11-07 13:11:05 +00:00
---
< div align = "center" >
< b >
< a href = "https://tidelift.com/subscription/pkg/npm-camelcase?utm_source=npm-camelcase&utm_medium=referral&utm_campaign=readme" > Get professional support for 'camelcase' with a Tidelift subscription< / a >
< / b >
< br >
< sub >
Tidelift helps make open source sustainable for maintainers while giving companies< br > assurances about security, maintenance, and licensing for their dependencies.
< / sub >
< / div >
---
2019-09-18 08:11:16 +00:00
## Install
```
2019-11-07 13:11:05 +00:00
$ npm install camelcase
2019-09-18 08:11:16 +00:00
```
## Usage
```js
const camelCase = require('camelcase');
camelCase('foo-bar');
//=> 'fooBar'
camelCase('foo_bar');
//=> 'fooBar'
camelCase('Foo-Bar');
//=> 'fooBar'
2019-11-07 13:11:05 +00:00
camelCase('Foo-Bar', {pascalCase: true});
//=> 'FooBar'
2019-09-18 08:11:16 +00:00
2019-11-07 13:11:05 +00:00
camelCase('--foo.bar', {pascalCase: false});
2019-09-18 08:11:16 +00:00
//=> 'fooBar'
camelCase('foo bar');
//=> 'fooBar'
console.log(process.argv[3]);
//=> '--foo-bar'
camelCase(process.argv[3]);
//=> 'fooBar'
2019-11-07 13:11:05 +00:00
camelCase(['foo', 'bar']);
2019-09-18 08:11:16 +00:00
//=> 'fooBar'
2019-11-07 13:11:05 +00:00
camelCase(['__foo__', '--bar'], {pascalCase: true});
//=> 'FooBar'
2019-09-18 08:11:16 +00:00
```
2019-11-07 13:11:05 +00:00
## API
### camelCase(input, [options])
#### input
Type: `string` `string[]`
String to convert to camel case.
#### options
Type: `Object`
##### pascalCase
Type: `boolean` < br >
Default: `false`
Uppercase the first character: `foo-bar` → `FooBar`
## Security
To report a security vulnerability, please use the [Tidelift security contact ](https://tidelift.com/security ). Tidelift will coordinate the fix and disclosure.
2019-09-18 08:11:16 +00:00
## 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
2019-11-07 13:11:05 +00:00
- [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
2019-09-18 08:11:16 +00:00
## License
2019-11-07 13:11:05 +00:00
MIT © [Sindre Sorhus ](https://sindresorhus.com )