string-toolkit's Introduction

string-toolkit

Installation

npm i string-toolkit --save

Usage

const stringToolsRequire = require("string-toolkit");
const stringTools = new stringToolsRequire();

Example

const stringToolsRequire = require("string-toolkit");
const stringTools = new stringToolsRequire();

console.log(stringTools.toProperCase("hey there!"));

Available functions

Function	Example usage	Params	Output
toProperCase(String, Boolean)	`toProperCase("hey there!", true)`	1- String (Required) 2- Boolean (Optional)	`"Hey There!"`
toChunks(String, Number)	`toChunks("hey there!", 3)`	1- String (Required) 2- Number (Required)	`[ 'hey', ' th', 'ere', '!' ]`
scramble(String)	`scramble("hey there!")`	1- String (Required)	`"rte! ehyhe"`
mock(String)	`mock("hey there!")`	1- String (Required)	`"hEy tHeRe!"`
emojify(String)	`emojify("hey there!")`	1- String (Required)	`":regional_indicator_h::regional_indicator_e::regional_indicator_y: :regional_indicator_t::regional_indicator_h::regional_indicator_e::regional_indicator_r::regional_indicator_e::exclamation:"`
hasCustomEmoji(String)	`hasCustomEmoji("hey there!")`	1- String (Required)	`"No custom emoji detected"`
createProgressBar(Number, Number, Object)	`createProgressBar(57, 100, { elapsedChar: "+", progressChar: "@", emptyChar: "~" })`	1- Number (Required) 2- Number (Required) 3- Object (Optional)	`"+++++++++++++++++++++++++++++@~~~~~~~~~~~~~~~~~~~~"`
toAbbreviation(String)	`toAbbreviation("hey there!")`	1- String (Required)	`"ht"`
fakeToken()	`fakeToken()`	No parameters	`NDYxOTU5NjQ2NzY4NzU5ODEyNA==.itPxe4.X2B1p3kjQqcpPNxnm30XwX7q4N`