# lkt-string-tools

> A collection of functions for working with strings

Latest version **1.1.0** (published 2025-03-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install lkt-string-tools
pnpm add lkt-string-tools
yarn add lkt-string-tools
bun add lkt-string-tools
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2025-03-01 |
| First published | 2022-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=18 |
| Dependencies | 0 |
| Unpacked size | 23.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Antonio Ibáñez |
| Maintainers | lekrat |
| Keywords | lkt, lkt-web-tech, ts, typescript, js, javascript |

## Links

- npm: https://www.npmjs.com/package/lkt-string-tools
- npm.io page: https://npm.io/package/lkt-string-tools

## Recent versions

- 1.1.0 (latest) — 2025-03-01
- 1.0.8 — 2025-01-17
- 1.0.7 — 2024-11-06
- 1.0.6 — 2024-08-31
- 1.0.5 — 2024-02-19
- 1.0.4 — 2024-01-19
- 1.0.3 — 2022-09-19
- 1.0.2 — 2022-09-14
- 1.0.1 — 2022-09-14

## README

# LKT String Tools



## Functions: Generators

### generateRandomString

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

### stripTags

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: `<a><b><c>` (only tags in lowercase) |

#### Usage

```js
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

| 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

### replaceAll

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!"
```

### replaceSingleWhiteSpaces

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!"
```

### trim

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

### isFilled

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
}
```

### isBase64Image

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

### kebabCaseToCamelCase

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'))
```

### ucfirst

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'))
```

### formatNumber

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

### isString

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'))
```

### isEmail

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'))
```

### toString

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))
```

### cloneString

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

### decodeUrl

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'))
```

### getUrlSlug

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

### utf8Encode

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'))
```

### utf8Decode

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'))
```

---
_Source: https://npm.io/package/lkt-string-tools · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._