@rogolev/value 0.0.2 → 0.0.3

package/src/helpers/is_array.mjs

@@ -1,128 +1,128 @@
-/**
- * Проверяет, является ли переданное значение массивом или ассоциативным массивом (объектом с ключами и значениями).
- *
- * ### Описание
- *
- * В JavaScript массивы и объекты имеют разные структуры и предназначения:
- *
- * - Массивы (Array) являются упорядоченными коллекциями элементов, которые могут быть индексированы.
- * - Объекты (Object) содержат пары "ключ-значение", которые могут быть неупорядоченными.
- *
- * Эта функция проверяет, является ли переданное значение обычным массивом (например, `[1, 2, 3]`),
- * либо ассоциативным массивом (объектом с парами "ключ-значение", например, `{foo: 'bar'}`).
- *
- * ### Алгоритм работы функции
- *
- * 1. Сначала проверяется, является ли переданное значение обычным массивом с помощью встроенного метода `Array.isArray(value)`. Если это массив, функция сразу возвращает `true`.
- *
- * 2. Если переменная не является массивом, то выполняются дополнительные проверки:
- *
- *    - Проверяется, что значение не равно `null` (так как `null` в JavaScript также является объектом, но не является ни массивом, ни объектом с парами "ключ-значение").
- *    - Проверяется, что значение является объектом JavaScript (с помощью `typeof value === 'object'`).
- *    - Проверяется, что прототип объекта совпадает с `Object.prototype` (это объект, от которого наследуются все объекты в JavaScript) или является `null` (это означает, что объект был создан с помощью `Object.create(null)` и не имеет прототипа).
- *    - Исключаются массивоподобные объекты (например, `arguments`, `NodeList`), путем проверки, что свойство `length` не является собственным свойством объекта.
- *    - Дополнительно проверяется, что объект является простым (его конструктор равен `Object`), а также исключаются встроенные объекты (`Math`, `JSON`, `Reflect`, `Intl`), для которых функция возвращает `true`.
- *
- * ### Параметры
- *
- * - `value` (any)
- *      Проверяемая переменная.
- *
- * ### Возвращаемое значение
- *
- * Возвращает `true`, если переменная является обычным массивом (`Array`), ассоциативным массивом (объектом с парами "ключ-значение"), ассоциативным массивом, созданным с помощью `Object.create(null)`. В остальных случаях функция возвращает `false`.
- *
- * ### Примеры использования
- *
- * 1. Простые массивы:
- *
- *    ```js
- *    is_array([1, 2, 3]); // true
- *    is_array([]); // true
- *    ```
- *
- * 2. Ассоциативные массивы (объекты с ключами и значениями):
- *
- *    ```js
- *    is_array({ foo: 'bar', baz: 42 }); // true
- *    is_array({ '0': 'a', '1': 'b' }); // true
- *    ```
- *
- * 3. Объекты, созданные без прототипа:
- *
- *    ```js
- *    const noProtoObject = Object.create(null);
- *    noProtoObject.foo = 'bar';
- *    is_array(noProtoObject); // true
- *    ```
- *
- * 4. Примитивы и невалидные значения:
- *
- *    ```js
- *    is_array(null);         // false
- *    is_array(undefined);    // false
- *    is_array(42);           // false
- *    is_array('hello');      // false
- *    ```
- *
- * 5. Специальные объекты:
- *
- *    ```js
- *    is_array(new Map());    // false
- *    is_array(new Set());    // false
- *    is_array(() => {});     // false
- *    ```
- *
- * 6. Классы и их экземпляры:
- *
- *    ```js
- *    class MyClass {}
- *    const instance = new MyClass();
- *    is_array(instance); // false
- *    ```
- *
- * @param {any} value Проверяемая переменная.
- * @returns {boolean} Возвращает `true`, если значение является массивом или ассоциативным массивом, иначе `false`.
- */
-export default function is_array(value) {
-    // Для массивов (Array) возвращаем `true` по умолчанию.
-    if (Array.isArray(value)) {
-        return true;
-    }
-
-    // Далее работаем только с объектами.
-    if (!value || typeof value !== 'object') {
-        return false;
-    }
-
-    // Если у переданного объекта отсутствует прототип, то это означает,
-    // что объект является контейнером пар ключ-значение без встроенных методов,
-    // наследуемых от прототипа Object.prototype.
-    // Такой контейнер можно создать с помощью конструкции `Object.create(null)`
-    // или с помощью функции `array({})`.
-    if (Object.getPrototypeOf(value) === null) {
-        return true;
-    }
-
-    // Исключаем встроенные объекты Math, JSON, Reflect, Intl, для которых
-    // функция возвращает `true`.
-    if ([Math, JSON, Reflect, Intl].includes(value)) {
-        return false;
-    }
-
-    // Если у объекта присутствует свойство `length`, то это означает, что
-    // передан массивоподобный объект, например `arguments`.
-    // С точки зрения данной функции, данные объекты считать
-    // ассоциативными массивами нельзя.
-    if (Object.hasOwn(value, 'length')) {
-        return false;
-    }
-
-    // Если прототип переданного объекта - `Object.prototype`, то передан
-    // обычный объект.
-    if (Object.getPrototypeOf(value) === Object.prototype) {
-        return true;
-    }
-
-    return false;
-}
+/**
+ * Проверяет, является ли переданное значение массивом или ассоциативным массивом (объектом с ключами и значениями).
+ *
+ * ### Описание
+ *
+ * В JavaScript массивы и объекты имеют разные структуры и предназначения:
+ *
+ * - Массивы (Array) являются упорядоченными коллекциями элементов, которые могут быть индексированы.
+ * - Объекты (Object) содержат пары "ключ-значение", которые могут быть неупорядоченными.
+ *
+ * Эта функция проверяет, является ли переданное значение обычным массивом (например, `[1, 2, 3]`),
+ * либо ассоциативным массивом (объектом с парами "ключ-значение", например, `{foo: 'bar'}`).
+ *
+ * ### Алгоритм работы функции
+ *
+ * 1. Сначала проверяется, является ли переданное значение обычным массивом с помощью встроенного метода `Array.isArray(value)`. Если это массив, функция сразу возвращает `true`.
+ *
+ * 2. Если переменная не является массивом, то выполняются дополнительные проверки:
+ *
+ *    - Проверяется, что значение не равно `null` (так как `null` в JavaScript также является объектом, но не является ни массивом, ни объектом с парами "ключ-значение").
+ *    - Проверяется, что значение является объектом JavaScript (с помощью `typeof value === 'object'`).
+ *    - Проверяется, что прототип объекта совпадает с `Object.prototype` (это объект, от которого наследуются все объекты в JavaScript) или является `null` (это означает, что объект был создан с помощью `Object.create(null)` и не имеет прототипа).
+ *    - Исключаются массивоподобные объекты (например, `arguments`, `NodeList`), путем проверки, что свойство `length` не является собственным свойством объекта.
+ *    - Дополнительно проверяется, что объект является простым (его конструктор равен `Object`), а также исключаются встроенные объекты (`Math`, `JSON`, `Reflect`, `Intl`), для которых функция возвращает `true`.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Проверяемая переменная.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если переменная является обычным массивом (`Array`), ассоциативным массивом (объектом с парами "ключ-значение"), ассоциативным массивом, созданным с помощью `Object.create(null)`. В остальных случаях функция возвращает `false`.
+ *
+ * ### Примеры использования
+ *
+ * 1. Простые массивы:
+ *
+ *    ```js
+ *    is_array([1, 2, 3]); // true
+ *    is_array([]); // true
+ *    ```
+ *
+ * 2. Ассоциативные массивы (объекты с ключами и значениями):
+ *
+ *    ```js
+ *    is_array({ foo: 'bar', baz: 42 }); // true
+ *    is_array({ '0': 'a', '1': 'b' }); // true
+ *    ```
+ *
+ * 3. Объекты, созданные без прототипа:
+ *
+ *    ```js
+ *    const noProtoObject = Object.create(null);
+ *    noProtoObject.foo = 'bar';
+ *    is_array(noProtoObject); // true
+ *    ```
+ *
+ * 4. Примитивы и невалидные значения:
+ *
+ *    ```js
+ *    is_array(null);         // false
+ *    is_array(undefined);    // false
+ *    is_array(42);           // false
+ *    is_array('hello');      // false
+ *    ```
+ *
+ * 5. Специальные объекты:
+ *
+ *    ```js
+ *    is_array(new Map());    // false
+ *    is_array(new Set());    // false
+ *    is_array(() => {});     // false
+ *    ```
+ *
+ * 6. Классы и их экземпляры:
+ *
+ *    ```js
+ *    class MyClass {}
+ *    const instance = new MyClass();
+ *    is_array(instance); // false
+ *    ```
+ *
+ * @param {any} value Проверяемая переменная.
+ * @returns {boolean} Возвращает `true`, если значение является массивом или ассоциативным массивом, иначе `false`.
+ */
+export default function is_array(value) {
+    // Для массивов (Array) возвращаем `true` по умолчанию.
+    if (Array.isArray(value)) {
+        return true;
+    }
+
+    // Далее работаем только с объектами.
+    if (!value || typeof value !== 'object') {
+        return false;
+    }
+
+    // Если у переданного объекта отсутствует прототип, то это означает,
+    // что объект является контейнером пар ключ-значение без встроенных методов,
+    // наследуемых от прототипа Object.prototype.
+    // Такой контейнер можно создать с помощью конструкции `Object.create(null)`
+    // или с помощью функции `array({})`.
+    if (Object.getPrototypeOf(value) === null) {
+        return true;
+    }
+
+    // Исключаем встроенные объекты Math, JSON, Reflect, Intl, для которых
+    // функция возвращает `true`.
+    if ([Math, JSON, Reflect, Intl].includes(value)) {
+        return false;
+    }
+
+    // Если у объекта присутствует свойство `length`, то это означает, что
+    // передан массивоподобный объект, например `arguments`.
+    // С точки зрения данной функции, данные объекты считать
+    // ассоциативными массивами нельзя.
+    if (Object.hasOwn(value, 'length')) {
+        return false;
+    }
+
+    // Если прототип переданного объекта - `Object.prototype`, то передан
+    // обычный объект.
+    if (Object.getPrototypeOf(value) === Object.prototype) {
+        return true;
+    }
+
+    return false;
+}

package/src/helpers/is_assoc.mjs

@@ -1,51 +1,51 @@
-import is_array from './is_array.mjs';
-
-/**
- * Проверяет, является ли значение ассоциативным массивом.
- *
- * ### Параметры
- *
- * - `value` (any)
- *      Значение, которое необходимо проверить.
- *
- * ### Описание
- *
- * Функция `is_assoc` проверяет, является ли переданное значение ассоциативным массивом.
- *
- * Она использует метод `is_array` для проверки значения и убеждается, что значение не является обычным массивом.
- *
- * ### Возвращаемое значение
- *
- * Возвращает `true`, если значение является ассоциативным массивом, и `false` в противном случае.
- *
- * ### Примеры использования
- *
- * #### Пример 1: Проверка ассоциативных массивов
- *
- * ```js
- * is_assoc({ foo: 'bar' }); // true
- * is_assoc({}); // true
- * ```
- *
- * #### Пример 2: Проверка обычных массивов
- *
- * ```js
- * is_assoc([]); // false
- * is_assoc([1, 2, 3]); // false
- * ```
- *
- * #### Пример 3: Проверка значений других типов
- *
- * ```js
- * is_assoc('string'); // false (строка)
- * is_assoc(42); // false (число)
- * is_assoc(null); // false
- * is_assoc(undefined); // false
- * ```
- *
- * @param {any} value Значение, которое необходимо проверить.
- * @returns {boolean} Возвращает `true`, если значение является ассоциативным массивом, и `false` в противном случае.
- */
-export default function is_assoc(value) {
-    return is_array(value) && !Array.isArray(value);
-}
+import is_array from './is_array.mjs';
+
+/**
+ * Проверяет, является ли значение ассоциативным массивом.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Значение, которое необходимо проверить.
+ *
+ * ### Описание
+ *
+ * Функция `is_assoc` проверяет, является ли переданное значение ассоциативным массивом.
+ *
+ * Она использует метод `is_array` для проверки значения и убеждается, что значение не является обычным массивом.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение является ассоциативным массивом, и `false` в противном случае.
+ *
+ * ### Примеры использования
+ *
+ * #### Пример 1: Проверка ассоциативных массивов
+ *
+ * ```js
+ * is_assoc({ foo: 'bar' }); // true
+ * is_assoc({}); // true
+ * ```
+ *
+ * #### Пример 2: Проверка обычных массивов
+ *
+ * ```js
+ * is_assoc([]); // false
+ * is_assoc([1, 2, 3]); // false
+ * ```
+ *
+ * #### Пример 3: Проверка значений других типов
+ *
+ * ```js
+ * is_assoc('string'); // false (строка)
+ * is_assoc(42); // false (число)
+ * is_assoc(null); // false
+ * is_assoc(undefined); // false
+ * ```
+ *
+ * @param {any} value Значение, которое необходимо проверить.
+ * @returns {boolean} Возвращает `true`, если значение является ассоциативным массивом, и `false` в противном случае.
+ */
+export default function is_assoc(value) {
+    return is_array(value) && !Array.isArray(value);
+}

package/src/helpers/is_bigint.mjs

@@ -1,47 +1,47 @@
-/**
- * Проверяет, является ли значение типом `bigint`.
- *
- * ### Параметры
- *
- * - `value` (any)
- *      Значение, которое необходимо проверить.
- *
- * ### Описание
- *
- * Функция `is_bigint` проверяет, является ли переданное значение типом `bigint`.
- *
- * 1. Проверяется, что значение имеет тип `bigint`.
- *
- * Функция возвращает `false` для значений других типов, таких как числа, строки, объекты или массивы.
- *
- * ### Возвращаемое значение
- *
- * Возвращает `true`, если значение является типом `bigint`, и `false` в противном случае.
- *
- * ### Примеры использования
- *
- * #### Пример 1: Проверка значений типа bigint
- *
- * ```js
- * is_bigint(BigInt(123456)); // true
- * is_bigint(BigInt(-123456)); // true
- * ```
- *
- * #### Пример 2: Проверка значений других типов
- *
- * ```js
- * is_bigint(42); // false (число)
- * is_bigint('42'); // false (строка)
- * is_bigint(true); // false (логическое значение)
- * is_bigint(null); // false
- * is_bigint(undefined); // false
- * is_bigint({}); // false (объект)
- * is_bigint([]); // false (массив)
- * ```
- *
- * @param {any} value Значение, которое необходимо проверить.
- * @returns {boolean} Возвращает `true`, если значение является типом bigint, и `false` в противном случае.
- */
-export default function is_bigint(value) {
-    return typeof value === 'bigint';
-}
+/**
+ * Проверяет, является ли значение типом `bigint`.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Значение, которое необходимо проверить.
+ *
+ * ### Описание
+ *
+ * Функция `is_bigint` проверяет, является ли переданное значение типом `bigint`.
+ *
+ * 1. Проверяется, что значение имеет тип `bigint`.
+ *
+ * Функция возвращает `false` для значений других типов, таких как числа, строки, объекты или массивы.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение является типом `bigint`, и `false` в противном случае.
+ *
+ * ### Примеры использования
+ *
+ * #### Пример 1: Проверка значений типа bigint
+ *
+ * ```js
+ * is_bigint(BigInt(123456)); // true
+ * is_bigint(BigInt(-123456)); // true
+ * ```
+ *
+ * #### Пример 2: Проверка значений других типов
+ *
+ * ```js
+ * is_bigint(42); // false (число)
+ * is_bigint('42'); // false (строка)
+ * is_bigint(true); // false (логическое значение)
+ * is_bigint(null); // false
+ * is_bigint(undefined); // false
+ * is_bigint({}); // false (объект)
+ * is_bigint([]); // false (массив)
+ * ```
+ *
+ * @param {any} value Значение, которое необходимо проверить.
+ * @returns {boolean} Возвращает `true`, если значение является типом bigint, и `false` в противном случае.
+ */
+export default function is_bigint(value) {
+    return typeof value === 'bigint';
+}

package/src/helpers/is_bool.mjs

@@ -1,43 +1,43 @@
-/**
- * Проверяет, является ли переданное значение логическим типом (`boolean`).
- *
- * ### Описание
- *
- * В JavaScript логическое значение может быть только двумя состояниями: `true` или `false`.
- * Функция проверяет тип переданного значения с использованием оператора `typeof`.
- * Если значение является примитивом типа `boolean`, функция возвращает `true`.
- * Для всех других типов (включая объекты, строки, числа, `null`, `undefined` и другие) функция вернёт `false`.
- *
- * #### Примечание
- *
- * - Функция возвращает `false` для объектов типа `Boolean`, созданных с помощью конструктора `new Boolean()`.
- * - Возвращает `false` для массивов, объектов и других типов данных, отличных от `boolean`.
- *
- * ### Параметры
- *
- * - `value` (any):
- *      Проверяемая переменная.
- *
- * ### Возвращаемое значение
- *
- * Возвращает `true`, если значение `value` является логическим (`boolean`), иначе `false`.
- *
- * ### Примеры использования
- *
- * ```js
- * is_bool(true);   // Возвращает: true
- * is_bool(false);  // Возвращает: true
- * is_bool(0);      // Возвращает: false
- * is_bool('true'); // Возвращает: false
- * is_bool(null);   // Возвращает: false
- * is_bool([]);     // Возвращает: false
- * is_bool({});     // Возвращает: false
- * is_bool(new Boolean(true)); // Возвращает: false
- * ```
- *
- * @param {any} value Проверяемая переменная.
- * @returns {boolean} Возвращает `true`, если значение является логическим, иначе `false`.
- */
-export default function is_bool(value) {
-    return typeof value === 'boolean';
-}
+/**
+ * Проверяет, является ли переданное значение логическим типом (`boolean`).
+ *
+ * ### Описание
+ *
+ * В JavaScript логическое значение может быть только двумя состояниями: `true` или `false`.
+ * Функция проверяет тип переданного значения с использованием оператора `typeof`.
+ * Если значение является примитивом типа `boolean`, функция возвращает `true`.
+ * Для всех других типов (включая объекты, строки, числа, `null`, `undefined` и другие) функция вернёт `false`.
+ *
+ * #### Примечание
+ *
+ * - Функция возвращает `false` для объектов типа `Boolean`, созданных с помощью конструктора `new Boolean()`.
+ * - Возвращает `false` для массивов, объектов и других типов данных, отличных от `boolean`.
+ *
+ * ### Параметры
+ *
+ * - `value` (any):
+ *      Проверяемая переменная.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение `value` является логическим (`boolean`), иначе `false`.
+ *
+ * ### Примеры использования
+ *
+ * ```js
+ * is_bool(true);   // Возвращает: true
+ * is_bool(false);  // Возвращает: true
+ * is_bool(0);      // Возвращает: false
+ * is_bool('true'); // Возвращает: false
+ * is_bool(null);   // Возвращает: false
+ * is_bool([]);     // Возвращает: false
+ * is_bool({});     // Возвращает: false
+ * is_bool(new Boolean(true)); // Возвращает: false
+ * ```
+ *
+ * @param {any} value Проверяемая переменная.
+ * @returns {boolean} Возвращает `true`, если значение является логическим, иначе `false`.
+ */
+export default function is_bool(value) {
+    return typeof value === 'boolean';
+}

package/src/helpers/is_boolean.mjs

@@ -1,43 +1,43 @@
-/**
- * Проверяет, является ли переданное значение логическим типом (`boolean`).
- *
- * ### Описание
- *
- * В JavaScript логическое значение может быть только двумя состояниями: `true` или `false`.
- * Функция проверяет тип переданного значения с использованием оператора `typeof`.
- * Если значение является примитивом типа `boolean`, функция возвращает `true`.
- * Для всех других типов (включая объекты, строки, числа, `null`, `undefined` и другие) функция вернёт `false`.
- *
- * #### Примечание
- *
- * - Функция возвращает `false` для объектов типа `Boolean`, созданных с помощью конструктора `new Boolean()`.
- * - Возвращает `false` для массивов, объектов и других типов данных, отличных от `boolean`.
- *
- * ### Параметры
- *
- * - `value` (any):
- *      Проверяемая переменная.
- *
- * ### Возвращаемое значение
- *
- * Возвращает `true`, если значение `value` является логическим (`boolean`), иначе `false`.
- *
- * ### Примеры использования
- *
- * ```js
- * is_boolean(true);   // Возвращает: true
- * is_boolean(false);  // Возвращает: true
- * is_boolean(0);      // Возвращает: false
- * is_boolean('true'); // Возвращает: false
- * is_boolean(null);   // Возвращает: false
- * is_boolean([]);     // Возвращает: false
- * is_boolean({});     // Возвращает: false
- * is_boolean(new Boolean(true)); // Возвращает: false
- * ```
- *
- * @param {any} value Проверяемая переменная.
- * @returns {boolean} Возвращает `true`, если значение является логическим, иначе `false`.
- */
-export default function is_boolean(value) {
-    return typeof value === 'boolean';
-}
+/**
+ * Проверяет, является ли переданное значение логическим типом (`boolean`).
+ *
+ * ### Описание
+ *
+ * В JavaScript логическое значение может быть только двумя состояниями: `true` или `false`.
+ * Функция проверяет тип переданного значения с использованием оператора `typeof`.
+ * Если значение является примитивом типа `boolean`, функция возвращает `true`.
+ * Для всех других типов (включая объекты, строки, числа, `null`, `undefined` и другие) функция вернёт `false`.
+ *
+ * #### Примечание
+ *
+ * - Функция возвращает `false` для объектов типа `Boolean`, созданных с помощью конструктора `new Boolean()`.
+ * - Возвращает `false` для массивов, объектов и других типов данных, отличных от `boolean`.
+ *
+ * ### Параметры
+ *
+ * - `value` (any):
+ *      Проверяемая переменная.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение `value` является логическим (`boolean`), иначе `false`.
+ *
+ * ### Примеры использования
+ *
+ * ```js
+ * is_boolean(true);   // Возвращает: true
+ * is_boolean(false);  // Возвращает: true
+ * is_boolean(0);      // Возвращает: false
+ * is_boolean('true'); // Возвращает: false
+ * is_boolean(null);   // Возвращает: false
+ * is_boolean([]);     // Возвращает: false
+ * is_boolean({});     // Возвращает: false
+ * is_boolean(new Boolean(true)); // Возвращает: false
+ * ```
+ *
+ * @param {any} value Проверяемая переменная.
+ * @returns {boolean} Возвращает `true`, если значение является логическим, иначе `false`.
+ */
+export default function is_boolean(value) {
+    return typeof value === 'boolean';
+}