Nanananananananana.. Pat Man!

    decamelize
    TypeScript icon, indicating that this package has built-in type declarations

    6.0.0 • Public • Published

    decamelize

    Convert a camelized string into a lowercased one with a custom separator
    Example: unicornRainbowunicorn_rainbow

    If you use this on untrusted user input, don't forget to limit the length to something reasonable.

    Install

    npm install decamelize

    Usage

    import decamelize from 'decamelize';
    
    decamelize('unicornRainbow');
    //=> 'unicorn_rainbow'
    
    decamelize('unicornRainbow', {separator: '-'});
    //=> 'unicorn-rainbow'
    
    decamelize('testGUILabel', {preserveConsecutiveUppercase: true});
    //=> 'test_GUI_label'
    
    decamelize('testGUILabel', {preserveConsecutiveUppercase: false});
    //=> 'test_gui_label'

    API

    decamelize(input, options?)

    input

    Type: string

    options

    Type: object

    separator

    Type: string
    Default: '_'

    Character or string inserted to separate words in string.

    import decamelize from 'decamelize';
    
    decamelize('unicornRainbow');
    //=> 'unicorn_rainbow'
    
    decamelize('unicornRainbow', {separator: '-'});
    //=> 'unicorn-rainbow'
    preserveConsecutiveUppercase

    Type: boolean
    Default: false

    Preserve sequences of uppercase characters.

    import decamelize from 'decamelize';
    
    decamelize('testGUILabel');
    //=> 'test_gui_label'
    
    decamelize('testGUILabel', {preserveConsecutiveUppercase: true});
    //=> 'test_GUI_label'

    Related

    See camelcase for the inverse.


    Get professional support for this package with a Tidelift subscription
    Tidelift helps make open source sustainable for maintainers while giving companies
    assurances about security, maintenance, and licensing for their dependencies.

    Install

    npm i decamelize

    DownloadsWeekly Downloads

    22,471,884

    Version

    6.0.0

    License

    MIT

    Unpacked Size

    6.84 kB

    Total Files

    5

    Last publish

    Collaborators

    • sindresorhus