@rogolev/value 0.0.3 → 0.0.5

package/src/helpers/array/array_diff_key.mjs

@@ -0,0 +1,56 @@
+import array_diff_ukey from './array_diff_ukey.mjs';
+
+/**
+ * Вычисляет расхождение между массивами с использованием стандартной функции сравнения ключей.
+ *
+ * ### Описание
+ *
+ * Функция `array_diff_key` используется для вычисления расхождения между массивами с использованием стандартной функции сравнения ключей.
+ * Она возвращает ассоциативный массив, содержащий элементы из первого массива, которые отсутствуют в других массивах.
+ *
+ * ### Параметры
+ *
+ * - `original_array` (object): Исходный массив.
+ * - `...arrays` (object): Массивы для сравнения.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает ассоциативный массив, содержащий элементы из первого массива, которые отсутствуют в других массивах.
+ *
+ * ### Примеры использования
+ *
+ * 1. Сравнение массивов:
+ *
+ *    ```js
+ *    const original_array = { a: 1, b: 2, c: 3 };
+ *    const array1 = { a: 1, b: 2 };
+ *    const result = array_diff_key(original_array, array1);
+ *    console.log(result); // { c: 3 }
+ *    ```
+ *
+ * 2. Обработка пустых массивов:
+ *
+ *    ```js
+ *    const original_array = {};
+ *    const array1 = {};
+ *    const result = array_diff_key(original_array, array1);
+ *    console.log(result); // {}
+ *    ```
+ *
+ * 3. Сравнение массивов с различными типами данных:
+ *
+ *    ```js
+ *    const original_array = { a: 1, b: '2', c: true };
+ *    const array1 = { a: 1, b: 2, d: false };
+ *    const result = array_diff_key(original_array, array1);
+ *    console.log(result); // { c: true }
+ *    ```
+ *
+ * @param {object} original_array Исходный массив.
+ * @param {...object} arrays Массивы для сравнения.
+ * @returns {object} Возвращает ассоциативный массив, содержащий элементы из первого массива, которые отсутствуют в других массивах.
+ * @throws {TypeError} Если параметры не являются массивами.
+ */
+export default function array_diff_key(original_array, ...arrays) {
+    return array_diff_ukey((a, b) => a === b, original_array, ...arrays);
+}

package/src/helpers/array/array_diff_uassoc.mjs

@@ -0,0 +1,76 @@
+import array_udiff_uassoc from './array_udiff_uassoc.mjs';
+
+/**
+ * Вычисляет расхождение между массивами с использованием пользовательской функции сравнения ключей.
+ *
+ * ### Описание
+ *
+ * Функция `array_diff_uassoc` используется для вычисления расхождения между массивами с использованием пользовательской функции сравнения ключей.
+ * Она возвращает ассоциативный массив, содержащий элементы из первого массива, которые отсутствуют в других массивах.
+ *
+ * ### Параметры
+ *
+ * - `key_compare_func` (function): Функция для сравнения ключей.
+ * - `original_array` (object): Исходный массив.
+ * - `...arrays` (object): Массивы для сравнения.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает ассоциативный массив, содержащий элементы из первого массива, которые отсутствуют в других массивах.
+ *
+ * ### Примеры использования
+ *
+ * 1. Сравнение массивов с использованием пользовательской функции сравнения:
+ *
+ *    ```js
+ *    const key_compare_func = (a, b) => a === b;
+ *    const original_array = { a: 1, b: 2, c: 3 };
+ *    const array1 = { a: 1, b: 2 };
+ *    const result = array_diff_uassoc(key_compare_func, original_array, array1);
+ *    console.log(result); // { c: 3 }
+ *    ```
+ *
+ * 2. Обработка пустых массивов:
+ *
+ *    ```js
+ *    const key_compare_func = (a, b) => a === b;
+ *    const original_array = {};
+ *    const array1 = {};
+ *    const result = array_diff_uassoc(key_compare_func, original_array, array1);
+ *    console.log(result); // {}
+ *    ```
+ *
+ * 3. Обработка значений, не являющихся массивами:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_diff_uassoc('not a function', 'not an array');
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "key_compare_func" должен быть функцией.
+ *    }
+ *    ```
+ *
+ * 4. Сравнение массивов с различными типами данных:
+ *
+ *    ```js
+ *    const key_compare_func = (a, b) => a === b;
+ *    const original_array = { a: 1, b: '2', c: true };
+ *    const array1 = { a: 1, b: 2, d: false };
+ *    const result = array_diff_uassoc(key_compare_func, original_array, array1);
+ *    console.log(result); // { c: true }
+ *    ```
+ *
+ * @param {function} key_compare_func Функция для сравнения ключей.
+ * @param {object} original_array Исходный массив.
+ * @param {...object} arrays Массивы для сравнения.
+ * @returns {object} Возвращает ассоциативный массив, содержащий элементы из первого массива, которые отсутствуют в других массивах.
+ * @throws {TypeError} Если параметры не являются функциями или массивами.
+ */
+export default function array_diff_uassoc(key_compare_func, original_array, ...arrays) {
+    return array_udiff_uassoc(
+        (a, b) => JSON.stringify(a) === JSON.stringify(b),
+        key_compare_func,
+        original_array,
+        ...arrays,
+    );
+}

package/src/helpers/array/array_diff_ukey.mjs

@@ -0,0 +1,71 @@
+import array_udiff_uassoc from './array_udiff_uassoc.mjs';
+
+/**
+ * Вычисляет расхождение между массивами с использованием пользовательской функции сравнения для ключей.
+ *
+ * ### Описание
+ *
+ * Функция `array_diff_ukey` используется для вычисления расхождения между массивами с использованием пользовательской функции сравнения для ключей.
+ * Она возвращает ассоциативный массив, содержащий элементы из первого массива, которые отсутствуют в других массивах.
+ *
+ * ### Параметры
+ *
+ * - `key_compare_func` (function): Функция для сравнения ключей.
+ * - `original_array` (object): Исходный массив.
+ * - `...arrays` (object): Массивы для сравнения.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает ассоциативный массив, содержащий элементы из первого массива, которые отсутствуют в других массивах.
+ *
+ * ### Примеры использования
+ *
+ * 1. Сравнение массивов с использованием пользовательской функции сравнения ключей:
+ *
+ *    ```js
+ *    const key_compare_func = (a, b) => a === b;
+ *    const original_array = { a: 1, b: 2, c: 3 };
+ *    const array1 = { a: 1, b: 2 };
+ *    const result = array_diff_ukey(key_compare_func, original_array, array1);
+ *    console.log(result); // { c: 3 }
+ *    ```
+ *
+ * 2. Обработка пустых массивов:
+ *
+ *    ```js
+ *    const key_compare_func = (a, b) => a === b;
+ *    const original_array = {};
+ *    const array1 = {};
+ *    const result = array_diff_ukey(key_compare_func, original_array, array1);
+ *    console.log(result); // {}
+ *    ```
+ *
+ * 3. Обработка значений, не являющихся массивами:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_diff_ukey('not a function', 'not an array');
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "key_compare_func" должен быть функцией.
+ *    }
+ *    ```
+ *
+ * 4. Сравнение массивов с различными типами данных:
+ *
+ *    ```js
+ *    const key_compare_func = (a, b) => a === b;
+ *    const original_array = { a: 1, b: '2', c: true };
+ *    const array1 = { a: 1, b: 2, d: false };
+ *    const result = array_diff_ukey(key_compare_func, original_array, array1);
+ *    console.log(result); // { c: true }
+ *    ```
+ *
+ * @param {function} key_compare_func Функция для сравнения ключей.
+ * @param {object} original_array Исходный массив.
+ * @param {...object} arrays Массивы для сравнения.
+ * @returns {object} Возвращает ассоциативный массив, содержащий элементы из первого массива, которые отсутствуют в других массивах.
+ * @throws {TypeError} Если параметры не являются функциями или массивами.
+ */
+export default function array_diff_ukey(key_compare_func, original_array, ...arrays) {
+    return array_udiff_uassoc(() => true, key_compare_func, original_array, ...arrays);
+}

package/src/helpers/array/array_fill.mjs

@@ -0,0 +1,108 @@
+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';
+
+/**
+ * Заполняет массив значениями, начиная с указанного индекса.
+ *
+ * ### Описание
+ *
+ * Функция `array_fill` используется для заполнения массива значениями, начиная с указанного индекса.
+ * Она возвращает массив, содержащий заданное количество элементов, заполненных указанным значением.
+ *
+ * ### Параметры
+ *
+ * - `arr` (object): Исходный массив.
+ * - `start_index` (number): Индекс, с которого начинается заполнение массива.
+ * - `count` (number): Количество элементов для заполнения.
+ * - `value` (any): Значение, которым будет заполнен массив.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает массив, содержащий заданное количество элементов, заполненных указанным значением.
+ *
+ * ### Примеры использования
+ *
+ * 1. Заполнение пустого массива значениями:
+ *
+ *    ```js
+ *    const result = array_fill([], 0, 3, 'a');
+ *    console.log(result); // ['a', 'a', 'a']
+ *    ```
+ *
+ * 2. Заполнение массива значениями с указанного индекса:
+ *
+ *    ```js
+ *    const result = array_fill([], 2, 3, 'b');
+ *    console.log(result); // [undefined, undefined, 'b', 'b', 'b']
+ *    ```
+ *
+ * 3. Заполнение существующего массива значениями:
+ *
+ *    ```js
+ *    const existingArray = [1, 2, 3];
+ *    const result = array_fill(existingArray, 1, 2, 'c');
+ *    console.log(result); // [1, 'c', 'c']
+ *    ```
+ *
+ * 4. Обработка отрицательных значений для `count`:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_fill([], 0, -1, 'd');
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "count" должен быть равен или больше нуля.
+ *    }
+ *    ```
+ *
+ * 5. Обработка значений, не являющихся целыми числами:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_fill([], 0.5, 3, 'e');
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "start_index" должен быть целым числом.
+ *    }
+ *    ```
+ *
+ * 6. Заполнение ассоциативного массива значениями:
+ *
+ *    ```js
+ *    const assocArray = { a: 1, b: 2 };
+ *    const result = array_fill(assocArray, 2, 3, 'f');
+ *    console.log(result); // { a: 1, b: 2, 2: 'f', 3: 'f', 4: 'f' }
+ *    ```
+ *
+ * @param {object} arr Исходный массив.
+ * @param {number} start_index Индекс, с которого начинается заполнение массива.
+ * @param {number} count Количество элементов для заполнения.
+ * @param {any} value Значение, которым будет заполнен массив.
+ * @returns {object} Возвращает массив, содержащий заданное количество элементов, заполненных указанным значением.
+ * @throws {TypeError} Если параметры не являются массивами или целыми числами, или если `count` меньше нуля.
+ */
+export default function array_fill(arr, start_index, count, value) {
+    if (!is_array(arr)) {
+        throw new TypeError('Параметр "arr" должен быть массивом.');
+    }
+
+    if (!is_int(start_index)) {
+        throw new TypeError('Параметр "start_index" должен быть целым числом.');
+    }
+
+    if (!is_int(count)) {
+        throw new TypeError('Параметр "count" должен быть целым числом.');
+    }
+
+    if (count < 0) {
+        throw new TypeError('Параметр "count" должен быть равен или больше нуля.');
+    }
+
+    const result = is_list(arr) ? Array.from(arr) : array(arr);
+
+    for (let index = start_index; index < start_index + count; index++) {
+        result[index] = value;
+    }
+
+    return result;
+}

package/src/helpers/array/array_fill_keys.mjs

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

package/src/helpers/array/array_filter.mjs

@@ -0,0 +1,105 @@
+import array from '../array.mjs';
+import empty from '../empty.mjs';
+import is_array from '../is_array.mjs';
+import is_function from '../is_function.mjs';
+import is_list from '../is_list.mjs';
+import is_null from '../is_null.mjs';
+
+/**
+ * Фильтрует элементы массива с использованием функции обратного вызова.
+ *
+ * ### Описание
+ *
+ * Функция `array_filter` используется для фильтрации элементов массива с использованием функции обратного вызова.
+ * Она возвращает новый массив, содержащий только те элементы, для которых функция обратного вызова вернула `true`.
+ * Если функция обратного вызова не предоставлена, используется функция по умолчанию, которая удаляет пустые значения.
+ *
+ * ### Параметры
+ *
+ * - `value` (array): Исходный массив.
+ * - `callback` (function|null): Функция обратного вызова для фильтрации элементов. Если не указана, используется функция по умолчанию, которая удаляет пустые значения.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает новый массив, содержащий только те элементы, для которых функция обратного вызова вернула `true`.
+ *
+ * ### Примеры использования
+ *
+ * 1. Фильтрация массива с использованием функции обратного вызова:
+ *
+ *    ```js
+ *    const array = [1, 2, 3, 4, 5];
+ *    const callback = (value) => value > 2;
+ *    const result = array_filter(array, callback);
+ *    console.log(result); // [3, 4, 5]
+ *    ```
+ *
+ * 2. Фильтрация массива без функции обратного вызова (удаление пустых значений):
+ *
+ *    ```js
+ *    const array = [0, 1, false, 2, '', 3];
+ *    const result = array_filter(array);
+ *    console.log(result); // [1, 2, 3]
+ *    ```
+ *
+ * 3. Фильтрация ассоциативного массива с использованием функции обратного вызова:
+ *
+ *    ```js
+ *    const array = { a: 1, b: 2, c: 3, d: 4 };
+ *    const callback = (value, key) => value > 2;
+ *    const result = array_filter(array, callback);
+ *    console.log(result); // { c: 3, d: 4 }
+ *    ```
+ *
+ * 4. Обработка значений, не являющихся массивами:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_filter('not an array');
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "value" должен быть массивом.
+ *    }
+ *    ```
+ *
+ * 5. Обработка значений, не являющихся функциями:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_filter([1, 2, 3], 'not a function');
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "callback" должен быть функцией.
+ *    }
+ *    ```
+ *
+ * @param {object} value Исходный массив.
+ * @param {function|null} callback Функция обратного вызова для фильтрации элементов. Если не указана, используется функция по умолчанию, которая удаляет пустые значения.
+ * @returns {object} Возвращает новый массив, содержащий только те элементы, для которых функция обратного вызова вернула `true`.
+ * @throws {TypeError} Если параметры не являются массивами или функциями.
+ */
+export default function array_filter(value, callback = null) {
+    if (!is_array(value)) {
+        throw new TypeError('Параметр "value" должен быть массивом.');
+    }
+
+    if (!is_function(callback) && !is_null(callback)) {
+        throw new TypeError('Параметр "callback" должен быть функцией.');
+    }
+
+    if (is_null(callback)) {
+        callback = (v) => !empty(v);
+    }
+
+    if (is_list(value)) {
+        return value.filter(callback);
+    }
+
+    const result = array({});
+
+    for (const [k, v] of Object.entries(value)) {
+        if (callback(v, k)) {
+            result[k] = v;
+        }
+    }
+
+    return result;
+}

package/src/helpers/array/array_flip.mjs

@@ -0,0 +1,58 @@
+import is_array from '../is_array.mjs';
+import array_combine from './array_combine.mjs';
+
+/**
+ * Меняет местами ключи и значения в массиве.
+ *
+ * ### Описание
+ *
+ * Функция `array_flip` используется для обмена местами ключей и значений в массиве.
+ * Она возвращает новый массив, в котором ключи и значения поменяны местами.
+ *
+ * ### Параметры
+ *
+ * - `value` (object): Исходный массив.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает новый массив, в котором ключи и значения поменяны местами.
+ *
+ * ### Примеры использования
+ *
+ * 1. Обмен ключей и значений в обычном массиве:
+ *
+ *    ```js
+ *    const array = { a: 1, b: 2, c: 3 };
+ *    const result = array_flip(array);
+ *    console.log(result); // { 1: 'a', 2: 'b', 3: 'c' }
+ *    ```
+ *
+ * 2. Обработка пустого массива:
+ *
+ *    ```js
+ *    const array = {};
+ *    const result = array_flip(array);
+ *    console.log(result); // {}
+ *    ```
+ *
+ * 3. Обработка значений, не являющихся массивами:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_flip('not an array');
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "value" должен быть массивом.
+ *    }
+ *    ```
+ *
+ * @param {object} value Исходный массив.
+ * @returns {object} Возвращает новый массив, в котором ключи и значения поменяны местами.
+ * @throws {TypeError} Если параметр не является массивом.
+ */
+export default function array_flip(value) {
+    if (!is_array(value)) {
+        throw new TypeError('Параметр "value" должен быть массивом.');
+    }
+
+    return array_combine(Object.values(value), Object.keys(value));
+}

package/src/helpers/array/array_index_max.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 is_nan from '../is_nan.mjs';
+
+/**
+ * Возвращает максимальный индекс массива.
+ *
+ * ### Описание
+ *
+ * Функция `array_index_max` используется для получения максимального индекса массива.
+ * Она возвращает максимальный индекс для обычных массивов и ассоциативных массивов.
+ *
+ * ### Параметры
+ *
+ * - `value` (array): Исходный массив.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает максимальный индекс массива. Если массив пустой, возвращает `null`.
+ *
+ * ### Примеры использования
+ *
+ * 1. Получение максимального индекса обычного массива:
+ *
+ *    ```js
+ *    const array = [1, 2, 3];
+ *    const result = array_index_max(array);
+ *    console.log(result); // 2
+ *    ```
+ *
+ * 2. Получение максимального индекса ассоциативного массива:
+ *
+ *    ```js
+ *    const array = { a: 1, b: 2, c: 3 };
+ *    const result = array_index_max(array);
+ *    console.log(result); // null (нет числовых ключей)
+ *    ```
+ *
+ * 3. Обработка пустого массива:
+ *
+ *    ```js
+ *    const array = [];
+ *    const result = array_index_max(array);
+ *    console.log(result); // null
+ *    ```
+ *
+ * 4. Обработка значений, не являющихся массивами:
+ *
+ *    ```js
+ *    try {
+ *        const result = array_index_max('not an array');
+ *    } catch (e) {
+ *        console.error(e.message); // Параметр "value" должен быть массивом.
+ *    }
+ *    ```
+ *
+ * @param {object} value Исходный массив.
+ * @returns {number|null} Возвращает максимальный индекс массива. Если массив пустой, возвращает `null`.
+ * @throws {TypeError} Если параметр не является массивом.
+ */
+export default function array_index_max(value) {
+    if (!is_array(value)) {
+        throw new TypeError('Параметр "value" должен быть массивом.');
+    }
+
+    if (empty(value)) {
+        return null;
+    }
+
+    if (is_list(value)) {
+        return value.length - 1;
+    }
+
+    for (const key of Object.keys(value).reverse()) {
+        if (!is_nan(Number(key))) {
+            return Number(key);
+        }
+    }
+
+    return null;
+}