Installation

Easily install the package using the npm install command:

$ npm install textconvert

Setup

import * as convert from "textconvert";
// Or
const convert = require("textconvert");

Features

This package includes the following features at the moment:

• Clear

  Clear a string from punctuation and replaces it with a whitespace character or returns an array of strings.

  @param text String input to clear from punctuation.

  @param arrayOutput (Optional), boolean value to select whether to return an array of strings or a single string. Default value is true.

  convert.clear("Hello,world");
  // Returns => ["hello", "world"]
  
  convert.clear("Hello, world", false);
  // Returns => "hello world"

• Reverse

  Reverses all characters in a string.

  @param text A string to reverse.

  convert.reverse("Hello, world!");
  // Returns => "!dlrow ,olleH"

• Camel Case

  Convert a string from any convention to Camel Case convention.

  @param text A string to be converted to Camel Case.

  convert.camelCase("hello world");
  // Returns => "helloWorld"

• Pascal Case

  Convert a string from any convention to Pascal Case convention.

  @param text A string to be converted to Pascal Case.

  convert.pascalCase("hello world");
  // Returns => "HelloWorld"

• Snake Case

  Convert a string from any convention to Snake Case convention.

  @param text A string to be converted to Snake Case.

  convert.snakeCase("hello world");
  // Returns => "hello_world"
  convert.snakeCase("hello-world");
  // Returns => "hello_world"

• Kebab Case

  Convert a string from any convention to Kebab Case convention.

  @param text A string to be converted to Kebab Case.

  convert.kebabCase("hello world");
  // Returns => "hello-world"
  convert.kebabCase("helloWorld");
  // Returns => "hello-world"

• numbersToWords

  Get any number below 100 million converted to words.

  @param number Integer input to turn into text.

  convert.numbersToWords(1245);
  // Returns => "one thousand two hundred and forty-five"