lkt-string-tools v1.0.5

LKT String Tools

Functions: Generators

generateRandomString

Returns a random string

Usage

import {generateRandomString} from "lkt-string-tools";

const str1 = generateRandomString();
const str2 = generateRandomString(14);

Functions: HTML

stripTags

Removes HTML tags from input except if defined in allowed

Usage

import {stripTags} from "lkt-string-tools";

const str1 = stripTags('<span>Hello world</span>', ''); // Returns "Hello world"
const str2 = stripTags('<span>Hello world</span>', '<span>'); // Returns "<span>Hello world</span>"

htmlEntities

Convert input to HTML entities

Usage

import {htmlEntities} from "lkt-string-tools";

const str1 = htmlEntities('lorem ipsum dolor sit amet');

Functions: replacements

replaceAll

Replaces all occurrences of search in target with replacement

Usage

import {replaceAll} from "lkt-string-tools";

const str1 = replaceAll('hey you!', 'h', 'H'); // Returns "Hey you!"

replaceSingleWhiteSpaces

Replaces all whitespaces which only has one occurrence at a time in target with replacement

Usage

import {replaceSingleWhiteSpaces} from "lkt-string-tools";

const str1 = replaceSingleWhiteSpaces('hey you!', '_'); // Returns: "hey_you!"

trim

Removes starting and ending whitespaces from target

Usage

import {trim} from "lkt-string-tools";

const str1 = trim('   lorem ipsum   ') // Returns: "lorem ipsum"

Functions: status

isFilled

Checks if a string has content of it's empty

Usage

import {isFilled} from "lkt-string-tools";

if (isFilled('lorem')) {
    //do something
}

isBase64Image

Checks if a string is base64 encoded image

Usage

import {isBase64Image} from "lkt-string-tools";

if (isBase64Image('lorem')) {
    //do something
}

Functions: text style

kebabCaseToCamelCase

Convert from kebab case to camel case

Usage

import {kebabCaseToCamelCase} from "lkt-string-tools";

console.log(kebabCaseToCamelCase('lorem-ipsum-dolor-sit-amet'))

ucfirst

Converts first letter to uppercase

Usage

import {ucfirst} from "lkt-string-tools";

console.log(ucfirst('lorem ipsum'))

formatNumber

Format a number

Usage

import {formatNumber} from "lkt-string-tools";

console.log(formatNumber(20, 2, '.', ',')) // 20.00
console.log(formatNumber(2000, 4, '.', ','))// 2,000.0000

Functions: typing

isString

Checks if a given var is string

Usage

import {isString} from "lkt-string-tools";

console.log(isString('lorem-ipsum-dolor-sit-amet'))

isEmail

Checks if a given string content has email format

Usage

import {isEmail} from "lkt-string-tools";

console.log(isEmail('lorem ipsum'))

toString

Cast to string

Usage

import {toString} from "lkt-string-tools";

console.log(toString(20))

cloneString

Creates a copy of the string without the reference to the original var.

Usage

import {cloneString} from "lkt-string-tools";

console.log(cloneString('my awesome string'))

Functions: url

decodeUrl

Decodes and url encoded string

Usage

import {decodeUrl} from "lkt-string-tools";

console.log(decodeUrl('lorem-ipsum-dolor-sit-amet'))

getUrlSlug

Removes invalid chars to retrieve a nice url slug

Usage

import {getUrlSlug} from "lkt-string-tools";

console.log(getUrlSlug('lorem ipsum'))

Functions: UTF

utf8Encode

Encodes to UTF8

Usage

import {utf8Encode} from "lkt-string-tools";

console.log(utf8Encode('lorem-ipsum-dolor-sit-amet'))

utf8Decode

Decodes from UTF8

Usage

import {utf8Decode} from "lkt-string-tools";

console.log(utf8Decode('lorem ipsum'))