Niche Portobello Mushroom

    varname

    4.1.1 • Public • Published

    Varname

    Convert strings between different variable naming formats.

    Table of Contents

    Requirements

    This library requires the following to run:

    Usage

    Install with npm:

    npm install varname

    Load the library into your code with a require call:

    const varname = require('varname');

    varname.camelback( name )

    Convert a variable name to camelBack format (capitalize the first letter of all but the first word).
    name: (string) The variable name to convert.
    return: (string) Returns the converted variable name.

    varname.camelback('foo_bar_baz'); // 'fooBarBaz'

    varname.camelcase( name )

    Convert a variable name to CamelCase format (capitalize the first letter of each word).
    name: (string) The variable name to convert.
    return: (string) Returns the converted variable name.

    varname.camelcase('foo_bar_baz'); // 'FooBarBaz'

    varname.dash( name )

    Convert a variable name to dash format.
    name: (string) The variable name to convert.
    return: (string) Returns the converted variable name.

    varname.dash('FooBarBaz'); // 'foo-bar-baz'

    varname.underscore( name )

    Convert a variable name to underscore format.
    name: (string) The variable name to convert.
    return: (string) Returns the converted variable name.

    varname.underscore('FooBarBaz'); // 'foo_bar_baz'

    varname.split( name )

    Split a string into separate variable parts. This allows you to write your own format converters easily. name: (string) The variable name to split.
    return: (array) Returns an array of parts.

    varname.split('fooBarBaz');
    varname.split('FooBarBaz');
    varname.split('FOOBarBAZ');
    varname.split('foo-bar-baz');
    varname.split('foo_bar_baz');
    varname.split('♥~foo|bar|baz~♥');
    // all return ['foo', 'bar', 'baz']

    Contributing

    The contributing guide is available here. All contributors must follow this library's code of conduct.

    License

    Licensed under the MIT license.
    Copyright © 2015, Rowan Manning

    Install

    npm i varname

    DownloadsWeekly Downloads

    12,929

    Version

    4.1.1

    License

    MIT

    Unpacked Size

    7.45 kB

    Total Files

    5

    Last publish

    Collaborators

    • rowanmanning