@rogolev/value 0.0.3 → 0.0.4

package/src/helpers/array/array_merge.mjs

@@ -0,0 +1,95 @@
+import array from '../array.mjs';
+import empty from '../empty.mjs';
+import is_array from '../is_array.mjs';
+import is_int from '../is_int.mjs';
+import is_list from '../is_list.mjs';
+
+/**
+ * Объединяет несколько массивов в один.
+ *
+ * ### Описание
+ *
+ * Функция `array_merge` используется для объединения нескольких массивов в один.
+ * Она поддерживает как обычные массивы, так и ассоциативные массивы (объекты с ключами и значениями).
+ *
+ * ### Параметры
+ *
+ * - `...arrays` (object): Массивы, которые необходимо объединить.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает новый массив, содержащий элементы всех переданных массивов.
+ * Если все переданные массивы являются обычными массивами, результатом будет обычный массив.
+ * Если хотя бы один из переданных массивов является ассоциативным массивом, результатом будет ассоциативный массив.
+ *
+ * ### Примеры использования
+ *
+ * 1. Объединение обычных массивов:
+ *
+ *    ```js
+ *    const array1 = [1, 2, 3];
+ *    const array2 = [4, 5, 6];
+ *    const result = array_merge(array1, array2);
+ *    console.log(result); // [1, 2, 3, 4, 5, 6]
+ *    ```
+ *
+ * 2. Объединение ассоциативных массивов:
+ *
+ *    ```js
+ *    const array1 = { a: 1, b: 2 };
+ *    const array2 = { c: 3, d: 4 };
+ *    const result = array_merge(array1, array2);
+ *    console.log(result); // { a: 1, b: 2, c: 3, d: 4 }
+ *    ```
+ *
+ * 3. Объединение обычных и ассоциативных массивов:
+ *
+ *    ```js
+ *    const array1 = [1, 2, 3];
+ *    const array2 = { a: 4, b: 5 };
+ *    const result = array_merge(array1, array2);
+ *    console.log(result); // { 0: 1, 1: 2, 2: 3, a: 4, b: 5 }
+ *    ```
+ *
+ * 4. Обработка значений, не являющихся массивами:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_merge('not an array');
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "arrays" должен быть массивом.
+ *    }
+ *    ```
+ *
+ * @param {...object} arrays Массивы, которые необходимо объединить.
+ * @returns {object} Возвращает новый массив, содержащий элементы всех переданных массивов.
+ * @throws {TypeError} Если хотя бы один из параметров не является массивом.
+ */
+export default function array_merge(...arrays) {
+    if (!arrays.every((arr) => is_array(arr))) {
+        throw new TypeError('Параметр "arrays" должен быть массивом.');
+    }
+
+    if (empty(arrays)) {
+        return [];
+    }
+
+    if (arrays.every((arr) => is_list(arr))) {
+        return [].concat(...arrays);
+    }
+
+    const result = array({});
+    let index = 0;
+
+    for (const arr of arrays) {
+        for (const [k, v] of Object.entries(arr)) {
+            if (is_int(Number(k))) {
+                result[index++] = v;
+            } else {
+                result[k] = v;
+            }
+        }
+    }
+
+    return result;
+}

package/src/helpers/array/array_merge_recursive.mjs

@@ -0,0 +1,153 @@
+import array from '../array.mjs';
+import empty from '../empty.mjs';
+import is_array from '../is_array.mjs';
+import is_int from '../is_int.mjs';
+import is_list from '../is_list.mjs';
+import is_null from '../is_null.mjs';
+
+/**
+ * Объединяет несколько массивов рекурсивно.
+ *
+ * ### Описание
+ *
+ * Функция `array_merge_recursive` используется для рекурсивного объединения нескольких массивов в один.
+ * Она поддерживает как обычные массивы, так и ассоциативные массивы (объекты с ключами и значениями).
+ *
+ * ### Параметры
+ *
+ * - `...arrays` (object): Массивы, которые необходимо объединить.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает новый массив, содержащий элементы всех переданных массивов.
+ * Если все переданные массивы являются обычными массивами, результатом будет обычный массив.
+ * Если хотя бы один из переданных массивов является ассоциативным массивом, результатом будет ассоциативный массив.
+ *
+ * ### Примеры использования
+ *
+ * 1. Объединение обычных массивов:
+ *
+ *    ```js
+ *    const array1 = [1, 2, 3];
+ *    const array2 = [4, 5, 6];
+ *    const result = array_merge_recursive(array1, array2);
+ *    console.log(result); // [1, 2, 3, 4, 5, 6]
+ *    ```
+ *
+ * 2. Объединение ассоциативных массивов:
+ *
+ *    ```js
+ *    const array1 = { a: 1, b: 2 };
+ *    const array2 = { b: 3, c: 4 };
+ *    const result = array_merge_recursive(array1, array2);
+ *    console.log(result); // { a: 1, b: [2, 3], c: 4 }
+ *    ```
+ *
+ * 3. Объединение обычных и ассоциативных массивов:
+ *
+ *    ```js
+ *    const array1 = [1, 2, 3];
+ *    const array2 = { a: 4, b: 5 };
+ *    const result = array_merge_recursive(array1, array2);
+ *    console.log(result); // { 0: 1, 1: 2, 2: 3, a: 4, b: 5 }
+ *    ```
+ *
+ * 4. Объединение вложенных массивов:
+ *
+ *    ```js
+ *    const array1 = { a: { b: 1 } };
+ *    const array2 = { a: { c: 2 } };
+ *    const result = array_merge_recursive(array1, array2);
+ *    console.log(result); // { a: { b: 1, c: 2 } }
+ *    ```
+ *
+ * 5. Объединение массивов с одинаковыми ключами:
+ *
+ *    ```js
+ *    const array1 = { a: { b: 1 } };
+ *    const array2 = { a: { b: 2 } };
+ *    const result = array_merge_recursive(array1, array2);
+ *    console.log(result); // { a: { b: [1, 2] } }
+ *    ```
+ *
+ * 6. Обработка значений, не являющихся массивами:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_merge_recursive('not an array');
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "arrays" должен быть массивом.
+ *    }
+ *    ```
+ *
+ * @param {...object} arrays Массивы, которые необходимо объединить.
+ * @returns {object} Возвращает новый массив, содержащий элементы всех переданных массивов.
+ * @throws {TypeError} Если хотя бы один из параметров не является массивом.
+ */
+export default function array_merge_recursive(...arrays) {
+    if (!arrays.every((arr) => is_array(arr))) {
+        throw new TypeError('Параметр "arrays" должен быть массивом.');
+    }
+
+    if (empty(arrays)) {
+        return [];
+    }
+
+    const result = arrays.every((arr) => is_list(arr)) ? [] : array({});
+
+    // Текущий индекс в массиве
+    let index = 0;
+
+    // Индекс первого массива с числовым ключом, записанный в результат.
+    let first_array_index = null;
+
+    // Перебираем переданные массивы.
+    for (const arr of arrays) {
+        for (const [k, v] of Object.entries(arr)) {
+            // Значение не является массивом, записываем его в результат и продолжаем итерацию.
+            //
+            // Если значение имеет числовой ключ, переиндексируем его.
+            if (!is_array(v)) {
+                if (is_int(Number(k))) {
+                    result[index++] = v;
+                } else if (k in result) {
+                    result[k] = [result[k], v];
+                } else {
+                    result[k] = v;
+                }
+
+                continue;
+            }
+
+            // Значение является массивом
+            //
+            // Массив имеет числовой ключ
+            if (is_int(Number(k))) {
+                // Если это первый массив с числовым ключом, сохраняем его индекс,
+                // иначе объединяем массив с первым массивом.
+                if (is_null(first_array_index)) {
+                    result[index] = v;
+                    first_array_index = index++;
+                } else {
+                    result[first_array_index] = array_merge_recursive(result[first_array_index], v);
+                }
+
+                continue;
+            }
+
+            // Массив имеет строковый ключ.
+            //
+            // Если массив с таким ключом уже был записан в результат, объединяем его с текущим массивом.
+            // Иначе записываем текущий массив в результат.
+            if (k in result && is_array(result[k])) {
+                result[k] = array_merge_recursive(result[k], v);
+
+                continue;
+            }
+
+            result[k] = v;
+        }
+    }
+
+    return result;
+}

package/src/helpers/array/array_pad.mjs

@@ -0,0 +1,105 @@
+import array from '../array.mjs';
+import is_array from '../is_array.mjs';
+import is_int from '../is_int.mjs';
+import is_list from '../is_list.mjs';
+import array_fill from './array_fill.mjs';
+import array_merge from './array_merge.mjs';
+
+/**
+ * Дополняет массив до заданной длины указанным значением.
+ *
+ * ### Описание
+ *
+ * Функция `array_pad` используется для дополнения массива до заданной длины указанным значением.
+ * Если длина положительная, элементы добавляются в конец массива.
+ * Если длина отрицательная, элементы добавляются в начало массива.
+ *
+ * ### Параметры
+ *
+ * - `arr` (object): Исходный массив.
+ * - `length` (number): Желаемая длина массива.
+ * - `value` (any): Значение для дополнения массива.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает новый массив, дополненный до заданной длины указанным значением.
+ *
+ * ### Примеры использования
+ *
+ * 1. Дополнение массива до длины 5:
+ *
+ *    ```js
+ *    const array = [1, 2, 3];
+ *    const result = array_pad(array, 5, 0);
+ *    console.log(result); // [1, 2, 3, 0, 0]
+ *    ```
+ *
+ * 2. Дополнение массива до длины -5:
+ *
+ *    ```js
+ *    const array = [1, 2, 3];
+ *    const result = array_pad(array, -5, 0);
+ *    console.log(result); // [0, 0, 1, 2, 3]
+ *    ```
+ *
+ * 3. Возвращение массива без изменений, если длина меньше или равна текущей длине массива:
+ *
+ *    ```js
+ *    const array = [1, 2, 3];
+ *    const result = array_pad(array, 3, 0);
+ *    console.log(result); // [1, 2, 3]
+ *    ```
+ *
+ * 4. Дополнение пустого массива:
+ *
+ *    ```js
+ *    const array = [];
+ *    const result = array_pad(array, 3, 0);
+ *    console.log(result); // [0, 0, 0]
+ *    ```
+ *
+ * 5. Обработка значений, не являющихся массивами:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_pad('not an array', 5, 0);
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "arr" должен быть массивом.
+ *    }
+ *    ```
+ *
+ * 6. Обработка значений длины, не являющихся числами:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_pad([1, 2, 3], 'not a number', 0);
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "length" должен быть целым числом.
+ *    }
+ *    ```
+ *
+ * @param {object} arr Исходный массив.
+ * @param {number} length Желаемая длина массива.
+ * @param {any} value Значение для дополнения массива.
+ * @returns {object} Возвращает новый массив, дополненный до заданной длины указанным значением.
+ * @throws {TypeError} Если параметры не являются массивом или числом.
+ */
+export default function array_pad(arr, length, value) {
+    if (!is_array(arr)) {
+        throw new TypeError('Параметр "arr" должен быть массивом.');
+    }
+
+    if (!is_int(length)) {
+        throw new TypeError('Параметр "length" должен быть целым числом.');
+    }
+
+    const count = Object.keys(arr).length;
+
+    if (count >= Math.abs(length)) {
+        return arr;
+    }
+
+    const pad = array_fill(is_list(arr) ? [] : array({}), 0, Math.abs(length) - count, value);
+
+    return length > 0 ? array_merge(arr, pad) : array_merge(pad, arr);
+}

package/src/helpers/array/array_pop.mjs

@@ -0,0 +1,82 @@
+import empty from '../empty.mjs';
+import is_array from '../is_array.mjs';
+import is_list from '../is_list.mjs';
+import array_key_last from './array_key_last.mjs';
+
+/**
+ * Удаляет и возвращает последний элемент массива.
+ *
+ * ### Описание
+ *
+ * Функция `array_pop` используется для удаления и возврата последнего элемента массива.
+ * Она поддерживает как обычные массивы, так и ассоциативные массивы (объекты с ключами и значениями).
+ *
+ * ### Параметры
+ *
+ * - `arr` (object): Исходный массив.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает последний элемент массива. Если массив пустой, возвращает `null`.
+ *
+ * ### Примеры использования
+ *
+ * 1. Удаление и возврат последнего элемента обычного массива:
+ *
+ *    ```js
+ *    const array = [1, 2, 3];
+ *    const result = array_pop(array);
+ *    console.log(result); // 3
+ *    console.log(array); // [1, 2]
+ *    ```
+ *
+ * 2. Удаление и возврат последнего элемента ассоциативного массива:
+ *
+ *    ```js
+ *    const array = { a: 1, b: 2, c: 3 };
+ *    const result = array_pop(array);
+ *    console.log(result); // 3
+ *    console.log(array); // { a: 1, b: 2 }
+ *    ```
+ *
+ * 3. Обработка пустого массива:
+ *
+ *    ```js
+ *    const array = [];
+ *    const result = array_pop(array);
+ *    console.log(result); // null
+ *    ```
+ *
+ * 4. Обработка значений, не являющихся массивами:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_pop('not an array');
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "arr" должен быть массивом.
+ *    }
+ *    ```
+ *
+ * @param {object} arr Исходный массив.
+ * @returns {any} Возвращает последний элемент массива. Если массив пустой, возвращает `null`.
+ * @throws {TypeError} Если параметр не является массивом.
+ */
+export default function array_pop(arr) {
+    if (!is_array(arr)) {
+        throw new TypeError('Параметр "arr" должен быть массивом.');
+    }
+
+    if (empty(arr)) {
+        return null;
+    }
+
+    if (is_list(arr)) {
+        return arr.pop();
+    }
+
+    const last_key = array_key_last(arr);
+    const result = arr[last_key];
+    delete arr[last_key];
+
+    return result;
+}

package/src/helpers/array/array_product.mjs

@@ -0,0 +1,67 @@
+import is_array from '../is_array.mjs';
+import to_float from '../to_float.mjs';
+import array_reduce from './array_reduce.mjs';
+
+/**
+ * Вычисляет произведение значений массива.
+ *
+ * ### Описание
+ *
+ * Функция `array_product` используется для вычисления произведения всех значений в массиве.
+ * Она поддерживает как обычные массивы, так и ассоциативные массивы (объекты с ключами и значениями).
+ *
+ * ### Параметры
+ *
+ * - `arr` (object): Исходный массив.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает произведение всех значений в массиве. Если массив пустой, возвращает `1`.
+ *
+ * ### Примеры использования
+ *
+ * 1. Вычисление произведения значений обычного массива:
+ *
+ *    ```js
+ *    const array = [1, 2, 3, 4];
+ *    const result = array_product(array);
+ *    console.log(result); // 24
+ *    ```
+ *
+ * 2. Вычисление произведения значений ассоциативного массива:
+ *
+ *    ```js
+ *    const array = { a: 1, b: 2, c: 3 };
+ *    const result = array_product(array);
+ *    console.log(result); // 6
+ *    ```
+ *
+ * 3. Обработка пустого массива:
+ *
+ *    ```js
+ *    const array = [];
+ *    const result = array_product(array);
+ *    console.log(result); // 1
+ *    ```
+ *
+ * 4. Обработка значений, не являющихся массивами:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_product('not an array');
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "arr" должен быть массивом.
+ *    }
+ *    ```
+ *
+ * @param {object} arr Исходный массив.
+ * @returns {number} Возвращает произведение всех значений в массиве. Если массив пустой, возвращает `1`.
+ * @throws {TypeError} Если параметр не является массивом.
+ */
+export default function array_product(arr) {
+    if (!is_array(arr)) {
+        throw new TypeError('Параметр "arr" должен быть массивом.');
+    }
+
+    return array_reduce(arr, (carry, item) => (carry *= isNaN(item) ? 1 : to_float(item)), 1);
+}

package/src/helpers/array/array_push.mjs

@@ -0,0 +1,75 @@
+import is_array from '../is_array.mjs';
+import is_list from '../is_list.mjs';
+import is_null from '../is_null.mjs';
+import array_index_max from './array_index_max.mjs';
+
+/**
+ * Добавляет один или несколько элементов в конец массива.
+ *
+ * ### Описание
+ *
+ * Функция `array_push` используется для добавления одного или нескольких элементов в конец массива.
+ * Она поддерживает как обычные массивы, так и ассоциативные массивы (объекты с ключами и значениями).
+ *
+ * ### Параметры
+ *
+ * - `arr` (object): Исходный массив.
+ * - `...values` (any): Значения, которые необходимо добавить в массив.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает новую длину массива после добавления элементов.
+ *
+ * ### Примеры использования
+ *
+ * 1. Добавление элементов в обычный массив:
+ *
+ *    ```js
+ *    const array = [1, 2, 3];
+ *    const result = array_push(array, 4, 5);
+ *    console.log(result); // 5
+ *    console.log(array); // [1, 2, 3, 4, 5]
+ *    ```
+ *
+ * 2. Добавление элементов в ассоциативный массив:
+ *
+ *    ```js
+ *    const array = { a: 1, b: 2 };
+ *    const result = array_push(array, 3, 4);
+ *    console.log(result); // 4
+ *    console.log(array); // { a: 1, b: 2, 0: 3, 1: 4 }
+ *    ```
+ *
+ * 3. Обработка значений, не являющихся массивами:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_push('not an array', 1, 2);
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "arr" должен быть массивом.
+ *    }
+ *    ```
+ *
+ * @param {object} arr Исходный массив.
+ * @param {...any} values Значения, которые необходимо добавить в массив.
+ * @returns {number} Возвращает новую длину массива после добавления элементов.
+ * @throws {TypeError} Если параметр не является массивом.
+ */
+export default function array_push(arr, ...values) {
+    if (!is_array(arr)) {
+        throw new TypeError('Параметр "arr" должен быть массивом.');
+    }
+
+    if (is_list(arr)) {
+        return arr.push(...values);
+    }
+
+    let index = array_index_max(arr);
+    index = is_null(index) ? 0 : index + 1;
+
+    for (const value of values) {
+        arr[index++] = value;
+    }
+
+    return Object.keys(arr).length;
+}