decamelize
- Version 6.0.1
- Published
- 6.97 kB
- No dependencies
- MIT license
Install
npm i decamelize
yarn add decamelize
pnpm add decamelize
Overview
Convert a camelized string into a lowercased one with a custom separator: unicornRainbow → unicorn_rainbow
Index
Functions
Type Aliases
Functions
function decamelize
decamelize: (string: string, options?: Options) => string;
Convert a camelized string into a lowercased one with a custom separator:
unicornRainbow
→unicorn_rainbow
.Parameter string
The camelcase string to decamelize.
Example 1
import decamelize from 'decamelize';decamelize('unicornRainbow');//=> 'unicorn_rainbow'decamelize('unicornRainbow', {separator: '-'});//=> 'unicorn-rainbow'
Type Aliases
type Options
type Options = { /** The character or string used to separate words.
@default '_'
@example ``` import decamelize from 'decamelize';
decamelize('unicornRainbow'); //=> 'unicorn_rainbow'
decamelize('unicornRainbow', {separator: '-'}); //=> 'unicorn-rainbow' ``` */ readonly separator?: string;
/** Preserve sequences of uppercase characters.
@default false
@example ``` import decamelize from 'decamelize';
decamelize('testGUILabel'); //=> 'test_gui_label'
decamelize('testGUILabel', {preserveConsecutiveUppercase: true}); //=> 'test_GUI_label' ``` */ readonly preserveConsecutiveUppercase?: boolean;};
Package Files (1)
Dependencies (0)
No dependencies.
Dev Dependencies (3)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/decamelize
.
- Markdown[](https://www.jsdocs.io/package/decamelize)
- HTML<a href="https://www.jsdocs.io/package/decamelize"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3323 ms. - Missing or incorrect documentation? Open an issue for this package.