LKT String Tools

Functions: Generators

$3

Returns a random string

| Arg | Type | Default | Description |
|--------|---------|---------|-----------------------------|
| length | integer | 10 | Length of the random string |

#### Usage

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

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

Functions: HTML

$3

Removes HTML tags from input except if defined in allowed

| Arg | Type | Default | Description |
|---------|--------|---------|--------------------------------------------------------------------|
| input | string | | String to be cleaned |
| allowed | string | | The format is like following: (only tags in lowercase) |

#### Usage

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

const str1 = stripTags('Hello world', ''); // Returns "Hello world"
const str2 = stripTags('Hello world', ''); // Returns "Hello world"
`

$3

Convert input to HTML entities

| Arg | Type | Default | Description |
|---------|--------|---------|-------------------------|
| input | string | | String to be converted |

#### Usage

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

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

Functions: replacements

$3

Replaces all occurrences of search in target with replacement

| Arg | Type | Default | Description |
|-------------|--------|---------|--------------------------------------------------|
| target | string | | String which will be used to replace occurrences |
| search | string | | Search pattern |
| replacement | string | | Replacement |

#### Usage

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

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

$3

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

| Arg | Type | Default | Description |
|-------------|--------|---------|--------------------------------------------------|
| target | string | | String which will be used to replace occurrences |
| replacement | string | | Replacement |

#### Usage

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

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

$3

Removes starting and ending whitespaces from target

| Arg | Type | Default | Description |
|--------|----------|---------|----------------------|
| target | string | | String to be trimmed |
| value | string | '' | Search string |

#### Usage

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

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

Functions: status

$3

Checks if a string has content of it's empty

| Arg | Type | Default | Description |
|---------|--------|---------|-----------------|
| target | string | | String to check |

#### Usage

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

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

$3

Checks if a string is base64 encoded image

| Arg | Type | Default | Description |
|---------|--------|---------|-----------------|
| target | string | | String to check |

#### Usage

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

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

Functions: text style

$3

Convert from kebab case to camel case

| Arg | Type | Default | Description |
|---------|--------|---------|-------------------|
| target | string | | String to convert |

#### Usage

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

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

$3

Converts first letter to uppercase

| Arg | Type | Default | Description |
|---------|--------|---------|-------------------|
| target | string | | String to convert |

#### Usage

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

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

$3

Format a number

| Arg | Type | Default | Description |
|----------------------|---------|---------|------------------------------------------------------------|
| number | Number | | Number to format |
| decimals | integer | | Amount of decimals |
| decimalPoint | string | | Decimal point separator |
| thousandsSeparator | string | | Thousands point separator |
| removeDecimalsIfZero | boolean | true | Prevents returning results like "123.00" and returns "123" |

#### Usage

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

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

Functions: typing

$3

Checks if a given var is string

| Arg | Type | Default | Description |
|-----------|---------|---------|---------------------------|
| target | any | | Var to check |

#### Usage

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

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

$3

Checks if a given string content has email format

| Arg | Type | Default | Description |
|--------|--------|---------|-----------------|
| target | string | | String to check |

#### Usage

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

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

$3

Cast to string

| Arg | Type | Default | Description |
|--------|---------|---------|---------------------------|
| target | any | | Data to convert to string |

#### Usage

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

console.log(toString(20))
`

$3

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

| Arg | Type | Default | Description |
|--------|--------|---------|-----------------|
| target | string | | String to clone |

#### Usage

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

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

Functions: url

$3

Decodes and url encoded string

| Arg | Type | Default | Description |
|--------|--------|---------|------------------|
| target | string | | String to decode |

#### Usage

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

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

$3

Removes invalid chars to retrieve a nice url slug

| Arg | Type | Default | Description |
|--------|--------|---------|-----------------|
| target | string | | String to clean |

#### Usage

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

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

Functions: UTF

$3

Encodes to UTF8

| Arg | Type | Default | Description |
|--------|--------|---------|------------------|
| target | string | | String to encode |

#### Usage

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

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

$3

Decodes from UTF8

| Arg | Type | Default | Description |
|--------|--------|---------|------------------|
| target | string | | String to decode |

#### Usage

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

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