forked from Mirrors/doipjs
99 lines
2.2 KiB
Markdown
99 lines
2.2 KiB
Markdown
# camelcase [](https://travis-ci.org/sindresorhus/camelcase)
|
|
|
|
> Convert a dash/dot/underscore/space separated string to camelCase or PascalCase: `foo-bar` → `fooBar`
|
|
|
|
---
|
|
|
|
<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>
|
|
|
|
---
|
|
|
|
## Install
|
|
|
|
```
|
|
$ npm install camelcase
|
|
```
|
|
|
|
|
|
## Usage
|
|
|
|
```js
|
|
const camelCase = require('camelcase');
|
|
|
|
camelCase('foo-bar');
|
|
//=> 'fooBar'
|
|
|
|
camelCase('foo_bar');
|
|
//=> 'fooBar'
|
|
|
|
camelCase('Foo-Bar');
|
|
//=> 'fooBar'
|
|
|
|
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`<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.
|
|
|
|
|
|
## 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
|
|
|
|
|
|
## License
|
|
|
|
MIT © [Sindre Sorhus](https://sindresorhus.com)
|