@js-ninja/list/readme/README.ru.md

A library for simplified work with arrays and DOM collections in JavaScript.

# Библиотека List

Библиотека List предоставляет класс для управления массивом или DOM-коллекцией.

## Установка

Вы можете установить библиотеку List с помощью npm или yarn, выполнив следующую команду::

```bash
npm install @js-ninja/list
```

или

```bash
yarn add @js-ninja/list
```

## Использование

Чтобы использовать библиотеку, вам необходимо импортировать класс List. Пример импорта выглядит следующим образом:

```javascript
import List from "list-library";
```

### Метод each

Метод `each` позволяет оптимизированно перебирать массив или DOM-коллекцию. Он принимает следующие параметры:

-   `arr` - массив, NodeList или HTMLCollection, которые нужно перебрать.
-   `cb` - функция, которая вызывается для каждого элемента. Она принимает следующие параметры:
    -   `item` - элемент списка.
    -   `index` - индекс элемента.
    -   `arr` - список.
-   `breakOn` (необязательный) - индекс элемента, на котором функция завершит работу.

Пример использования метода `each`:

```javascript
const arr = [1, 2, 3, 4, 5];

List.each(arr, (item, index) => {
    console.log(item); // Выводит каждый элемент массива
});
```

### Метод filter

Метод `filter` позволяет оптимизированно фильтровать массив или DOM-коллекцию. Он принимает следующие параметры:

-   `arr` - массив, NodeList или HTMLCollection, который нужно отфильтровать.
-   `cb` - функция, которая вызывается для каждого элемента. Она принимает следующие параметры:
    -   `item` - элемент списка.
    -   `index` - индекс элемента.
    -   `arr` - список.
-   Возвращает отфильтрованный массив.

Пример использования метода `filter`:

```javascript
const arr = [1, 2, 3, 4, 5];

const filtered = List.filter(arr, (item) => item % 2 === 0);

console.log(filtered); // Выводит [2, 4]
```

### Метод map

Метод `map` позволяет оптимизированно преобразовывать массив или DOM-коллекцию. Он принимает следующие параметры:

-   `arr` - массив, NodeList или HTMLCollection, который нужно преобразовать.
-   `cb` - функция преобразования для каждого элемента. Она принимает следующие параметры:
    -   `item` - элемент исходного списка.
    -   `index` - индекс элемента.
    -   `array` - исходный список.
-   Возвращает результирующий массив.

Пример использования метода `map`:

```javascript
const arr = [1, 2, 3, 4, 5];

const doubled = List.map(arr, (item) => item * 2);

console.log(doubled); // Выводит [2, 4, 6, 8, 10]
```

## Лицензия

Библиотека List распространяется под лицензией [MIT License](/LICENSE).