# String Transform [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=String%20transform%20module%20from%20Glize%20library.&url=https://glize.js.org&via=GitHub&hashtags=Glize,JavaScript,ECMAScript,ES6)
[![Build Status](https://github.com/Datamart/string-transform/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/Datamart/string-transform/actions/workflows/npm-publish.yml) [![License](https://img.shields.io/:license-apache-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) [![NPM version](https://img.shields.io/npm/v/string-transform.svg?style=flat)](https://npmjs.org/package/string-transform) [![Website](https://img.shields.io/website-up-down-green-red/https/glize.js.org.svg?style=flat)](https://glize.js.org) [![NPM downloads](https://img.shields.io/npm/dm/string-transform.svg?style=flat)](https://npmjs.org/package/string-transform)

String transform module from Glize library.

## Usage

```bash
npm install string-transform --save
```

```js
import {
  capitalize,
  hash,
  toCamelCase,
  toKebabCase,
  toPascalCase,
  toSnakeCase,
} from 'string-transform';

/**
 * Transforms the first character of each word to uppercase; other
 * characters are unaffected.
 * @param {string} str The string to be transformed.
 * @return {string} Returns transformed string.
 */
console.log(capitalize('test string')); // Test String

/**
 * Converts <code>str</code> to hashed string.
 * @param {string} str The input string.
 * @return {string} Returns hashed string.
 */
console.log(hash('https://glize.js.org/')); // 4Q69R

/**
 * Converts the passed string into a string with the separator denoted by the 
 * next word capitalized (aka lower camel case).
 * @param {string} str The input string.
 * @return {string} A string convered into a string with the separator 
 * denoted by the next word capitalized.
 * @see https://en.wikipedia.org/wiki/Camel_case
 */
console.log(toCamelCase('to-camel-case')); // toCamelCase

/**
 * Converts the passed string into a string of capitalized words without 
 * separators (aka upper camel case).
 * @param {string} str The input string.
 * @return {string} A string convered into a string of capitalized words 
 * without separators.
 * @see https://en.wikipedia.org/wiki/PascalCase
 */
console.log(toPascalCase('to-pascal-case')); // ToPascalCase

/**
 * Converts the given string into a string with a single underscore as a separator.
 * @param {string} str The input string.
 * @return {string} A convered string.
 * @see https://en.wikipedia.org/wiki/Snake_case
 */
console.log(toSnakeCase('toSnakeCase')); // to_snake_case

/**
 * Converts the given string into a string with a single dash as a separator.
 * @param {string} str The input string.
 * @return {string} A convered string.
 */
console.log(toKebabCase('toKebabCase')); // to-kebab-case
```

For more information please visit [Glize project page](https://glize.js.org).