QuickStart

Easy ways to get jsConvert onto your website.

Introduction

jsConvert is a simple library to convert string between cases (camelCase, snake_case, PascalCase, dot.case, path/case, text case, Sentence case, Header Case, UPPERCASE, lowercase).

Use for both Node.JS and Browser. Available on NPM.

Installation

1. GitHub

jsConvert is available on GitHub.
git clone https://github.com/huynhsamha/js-convert-case.git

2. Download

You can download dist folder directly here here.

3. NPM

You can also install package by NPM here.
+ Use npm:
npm install --save js-convert-case
+ Use yarn:
yarn add js-convert-case

4. CDN

You also can use CDN for NPM such as unpkg or jsDelivr.
+ Use unpkg:
<script src="https://unpkg.com/js-convert-case/dist/js-convert-case.min.js"></script>
+ Use jsDelivr:
<script src="https://cdn.jsdelivr.net/js-convert-case/dist/js-convert-case.min.js"></script>

Usage

1. Node.JS

+ Syntax require:
const jsConvert = require('js-convert-case');
// or
const { toCamelCase, toDotCase, upperKeys, snakeKeys } = require('js-convert-case');
+ Syntax import:
import js-convert-case from 'js-convert-case';
// or
import { toPascalCase, toPathCase, lowerKeys, camelKeys } from 'js-convert-case';

2. Browser

After file js-convert-case.min.js is loaded, object jsConvert will be exported globally into window object.
console.log(window.jsConvert);
console.log(jsConvert);

Examples

1. Convert string


    jsConvert.toCamelCase('param-case'); // paramCase
    jsConvert.toSnakeCase('param-case'); // param_case
    jsConvert.toPascalCase('param-case'); // ParamCase
    jsConvert.toDotCase('param-case'); // param.case
    jsConvert.toPathCase('param-case'); // param/case
    jsConvert.toTextCase('param-case'); // param case
    jsConvert.toSentenceCase('param-case'); // Param case
    jsConvert.toHeaderCase('param-case'); // Param Case
    jsConvert.toLowerCase('param-case'); // param-case
    jsConvert.toUpperCase('param-case'); // PARAM-CASE

2. Convert keys in object


    const obj = {
        camelCase: 1,
        UPPERCASE: 2,
        lowercase: 3,
        snake_case: 4,
        PascalCase: 5,
        'Title Case': 6,
        'dot.case': 7,
        'param-case': 8,
        'Sentence case': 9,
        'path/case': 10,
        'Header-Case': 11
    };

    jsConvert.lowerKeys(obj);
    jsConvert.upperKeys(obj);
    jsConvert.camelKeys(obj);
    jsConvert.snakeKeys(obj);
    jsConvert.pascalKeys(obj);

3. Recursive convert in object


    jsConvert.upperKeys(obj, { recursive: true });
    jsConvert.lowerKeys(obj, { recursive: true });
    jsConvert.snakeKeys(obj, { recursive: true });
    jsConvert.camelKeys(obj, { recursive: true });
    jsConvert.pascalKeys(obj, { recursive: true });