Installation

npm i string-toolkit

Usage

// Creating a new instance.
const stringTools = new (require('string-toolkit'))();

// Can also be used without a new instance.
const stringTools = require('string-toolkit');

Example

const stringTools = require('string-toolkit');

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

Available functions

toProperCase(string[, boolean])

const output = stringTools.toProperCase('hey there!', true);

console.log(output); // 'Hey There!'

toChunks(string, number)

const output = stringTools.toChunks('hey there!', 3);

console.log(output); // [ 'hey', ' th', 'ere', '!' ]

scramble(string)

const output = stringTools.scramble('hey there!');

console.log(output); // 'rte! ehyhe'

mock(string)

const output = stringTools.mock('hey there!');

console.log(output); // 'HeY ThErE!'

emojify(string)

const output = stringTools.emojify('hey there!');

console.log(output);
// '🇭🇪🇾 🇹🇭🇪🇷🇪❗'

hasCustomEmoji(string)

const output = stringTools.hasCustomEmoji('hey there!');

console.log(output); // false

createProgressBar(number, number[, object])

const output = stringTools.createProgressBar(57, 100, {
  elapsedChar: '+',
  progressChar: '@',
  emptyChar: '~',
  barLength: 10
});

console.log(output); // '+++++@~~~~'

toAbbreviation(string)

const output = stringTools.toAbbreviation('hey there!');

console.log(output); // 'ht'

fakeToken()

const output = stringTools.fakeToken();

console.log(output);
// 'NDI0NTYyNzY1NTMzNzQ0MjY3MA==.Cz0j0.Zf6Tfo17wN27N8tnkoG164Q9'

decancer(string)

const output = stringTools.decancer('𝓱𝓮𝔂 𝓽𝓱𝓮𝓻𝓮!');

console.log(output); // 'hey there!'

shorten(string, number[, string])

const output = stringTools.shorten('bruh moment', 4, 'end');

console.log(output); // 'bruhend'

parseOptions(string[])

const str = 'bruh --moment what bro --search --big bruh moment';

const output = stringTools.parseOptions(str.split(' '));

console.log(output);
/*
  {
    options: {
      moment: 'what bro',
      big: 'bruh moment'
    },
    flags: [ 'search' ],
    contentNoOptions: 'bruh',
    contentNoFlags: 'bruh what bro bruh moment'
  }
 */