> For the complete documentation index, see [llms.txt](https://alhorm-projects.gitbook.io/sprut/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://alhorm-projects.gitbook.io/sprut/modules/string.md).

# Модуль String

Данный модуль используется для работы со строками. Импортирование модуля:

```csharp
using "String"
```

Функции модуля:

### String(str) -> dict

На вход функция принимает строку и возвращает словарь, состоящий из функций и свойств для работы с переданной строкой.

```javascript
text = String("My text")
```

### split(separator) -> array

Разделяет строку на множество строк по переданному разделителю и возвращает массив из этих строк.

```javascript
string = String("word1, word2, word3")
words = string.split(", ") // ["word1", "word2", "word3"]
```

### findIndex(str) -> int

Возвращает индекс первого попавшегося символа, который был передан. Если была передана стока, ищет её фрагмент в исходной строке. Если ничего не находит, возвращает -1.

```javascript
text = String("My text")
index_t = text.findIndex("t") // 3
```

### findStr(str) -> string | int

Возвращает первый попавшийся фрагмент переданной строки. Если ничего не находит, возвращает -1.

```javascript
text = String("My text")
char_x = text.findStr("x") // "x"
```

### upper() -> string

Переводит исходную строку в верхний регистр и возвращает её.

```javascript
text = String("My text")
upper_text = text.upper() // "MY TEXT"
```

### lower() -> string

Переводит исходную строку в нижний регистр и возвращает её.

```javascript
text = String("MY TEXT")
upper_text = text.lower() // "my text"
```

### trim() -> string

Удаляет все пробелы по бокам исходной строки и возвращает её.

```javascript
string = String("     spaces     ")
no_spaces = string.trim() // "spaces"
```

### length -> int

Данное свойство возвращает длину исходной строки.

```javascript
text = String("My text")
len = text.length // 7
```

### text -> string

Данное свойство возвращает исходную строку.

```javascript
string = String("My text")
src = string.text // "My text"
```