Varname

Convert strings between different variable naming formats.

Table of Contents

* Requirements
* Usage
* Contributing
* License

Requirements

This library requires the following to run:

* Node.js 20+

Usage

Install with npm:

``sh
npm install varname
`

Load the library into your code with a require call:

`js
const varname = require('varname');
`

$3

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.

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

$3

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.

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

$3

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

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

$3

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

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

$3

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.

`js
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