60 lines
1.2 KiB
TypeScript
60 lines
1.2 KiB
TypeScript
|
declare namespace decamelize {
|
||
|
|
interface Options {
|
||
|
|
/**
|
||
|
|
Character or string inserted to separate words in `string`.
|
||
|
|
|
||
|
|
@default '_'
|
||
|
|
|
||
|
|
@example
|
||
|
|
```
|
||
|
|
import decamelize = require('decamelize');
|
||
|
|
|
||
|
|
decamelize('unicornRainbow');
|
||
|
|
//=> 'unicorn_rainbow'
|
||
|
|
|
||
|
|
decamelize('unicornRainbow', {separator: '-'});
|
||
|
|
//=> 'unicorn-rainbow'
|
||
|
|
```
|
||
|
|
*/
|
||
|
|
readonly separator?: string;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Preserve sequences of uppercase characters.
|
||
|
|
|
||
|
|
@default false
|
||
|
|
|
||
|
|
@example
|
||
|
|
```
|
||
|
|
import decamelize = require('decamelize');
|
||
|
|
|
||
|
|
decamelize('testGUILabel');
|
||
|
|
//=> 'test_gui_label'
|
||
|
|
|
||
|
|
decamelize('testGUILabel', {preserveConsecutiveUppercase: true});
|
||
|
|
//=> 'test_GUI_label'
|
||
|
|
```
|
||
|
|
*/
|
||
|
|
readonly preserveConsecutiveUppercase?: boolean;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
Convert a camelized string into a lowercased one with a custom separator: `unicornRainbow` → `unicorn_rainbow`.
|
||
|
|
|
||
|
|
@param string - The camelcase string to decamelize.
|
||
|
|
|
||
|
|
@example
|
||
|
|
```
|
||
|
|
import decamelize = require('decamelize');
|
||
|
|
|
||
|
|
decamelize('unicornRainbow');
|
||
|
|
//=> 'unicorn_rainbow'
|
||
|
|
|
||
|
|
decamelize('unicornRainbow', {separator: '-'});
|
||
|
|
//=> 'unicorn-rainbow'
|
||
|
|
```
|
||
|
|
*/
|
||
|
|
declare function decamelize(string: string, options?: decamelize.Options): string;
|
||
|
|
|
||
|
|
export = decamelize;
|