forked from PirateCare/Syllabus
49 lines
781 B
Markdown
49 lines
781 B
Markdown
|
# decamelize [](https://travis-ci.org/sindresorhus/decamelize)
|
||
|
|
|
||
|
|
> Convert a camelized string into a lowercased one with a custom separator<br>
|
||
|
|
> Example: `unicornRainbow` → `unicorn_rainbow`
|
||
|
|
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```
|
||
|
|
$ npm install --save decamelize
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
const decamelize = require('decamelize');
|
||
|
|
|
||
|
|
decamelize('unicornRainbow');
|
||
|
|
//=> 'unicorn_rainbow'
|
||
|
|
|
||
|
|
decamelize('unicornRainbow', '-');
|
||
|
|
//=> 'unicorn-rainbow'
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
### decamelize(input, [separator])
|
||
|
|
|
||
|
|
#### input
|
||
|
|
|
||
|
|
Type: `string`
|
||
|
|
|
||
|
|
#### separator
|
||
|
|
|
||
|
|
Type: `string`<br>
|
||
|
|
Default: `_`
|
||
|
|
|
||
|
|
|
||
|
|
## Related
|
||
|
|
|
||
|
|
See [`camelcase`](https://github.com/sindresorhus/camelcase) for the inverse.
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT © [Sindre Sorhus](https://sindresorhus.com)
|