@rogolev/value 0.0.1

package/src/helpers/is_integer.mjs

@@ -0,0 +1,74 @@
+/**
+ * Проверяет, является ли значение целым числом.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Значение, которое необходимо проверить.
+ *
+ * ### Описание
+ *
+ * Функция `is_integer` проверяет, является ли переданное значение целым числом.
+ *
+ * 1. Проверяется, что значение имеет тип `number`.
+ * 2. Убеждается, что значение является конечным числом.
+ * 3. Проверяется, что остаток от деления значения на 1 равен 0.
+ *
+ * Функция возвращает `false` для:
+ *
+ * - Чисел с плавающей точкой (например, `3.14`, `-0.99`).
+ * - Специальных чисел (`NaN`, `Infinity`, `-Infinity`).
+ * - Значений других типов, таких как строки, объекты или массивы.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение является целым числом, и `false` в противном случае.
+ *
+ * ### Примеры использования
+ *
+ * #### Пример 1: Проверка целых чисел
+ *
+ * ```js
+ * is_integer(42); // true
+ * is_integer(-7); // true
+ * is_integer(0); // true
+ * ```
+ *
+ * #### Пример 2: Проверка чисел с плавающей точкой
+ *
+ * ```js
+ * is_integer(3.14); // false
+ * is_integer(-0.5); // false
+ * ```
+ *
+ * #### Пример 3: Проверка специальных чисел
+ *
+ * ```js
+ * is_integer(NaN); // false
+ * is_integer(Infinity); // false
+ * is_integer(-Infinity); // false
+ * ```
+ *
+ * #### Пример 4: Проверка других типов данных
+ *
+ * ```js
+ * is_integer('42'); // false (строка)
+ * is_integer(true); // false (логическое значение)
+ * is_integer(null); // false
+ * is_integer(undefined); // false
+ * is_integer({}); // false (объект)
+ * is_integer([]); // false (массив)
+ * ```
+ *
+ * #### Пример 5: Проверка типа bigint
+ *
+ * ```js
+ * is_integer(BigInt(123456)); // false
+ * ```a
+ *
+ * @param {any} value Значение для проверки.
+ * @returns {boolean} Возвращает `true`, если значение является целым числом, иначе `false`.
+ */
+export default function is_integer(value) {
+    return typeof value === 'number' && Number.isFinite(value) && value % 1 === 0;
+}

package/src/helpers/is_list.mjs

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

package/src/helpers/is_nan.mjs

@@ -0,0 +1,51 @@
+/**
+ * Проверяет, является ли значение NaN.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Значение, которое необходимо проверить.
+ *
+ * ### Описание
+ *
+ * Функция `is_nan` проверяет, является ли переданное значение NaN (Not-a-Number).
+ *
+ * Она использует метод `Number.isNaN` для проверки значения.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение является NaN, и `false` в противном случае.
+ *
+ * ### Примеры использования
+ *
+ * #### Пример 1: Проверка значения NaN
+ *
+ * ```js
+ * is_nan(NaN); // true
+ * ```
+ *
+ * #### Пример 2: Проверка числовых значений
+ *
+ * ```js
+ * is_nan(42); // false
+ * is_nan(3.14); // false
+ * is_nan(Infinity); // false
+ * ```
+ *
+ * #### Пример 3: Проверка значений других типов
+ *
+ * ```js
+ * is_nan('42'); // false (строка)
+ * is_nan(true); // false (логическое значение)
+ * is_nan(null); // false
+ * is_nan(undefined); // false
+ * is_nan({}); // false (объект)
+ * is_nan([]); // false (массив)
+ * ```
+ *
+ * @param {any} value Значение, которое необходимо проверить.
+ * @returns {boolean} Возвращает `true`, если значение является NaN, и `false` в противном случае.
+ */
+export default function is_nan(value) {
+    return Number.isNaN(value);
+}

package/src/helpers/is_null.mjs

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

package/src/helpers/is_number.mjs

@@ -0,0 +1,49 @@
+/**
+ * Проверяет, является ли значение числом.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Проверяемая переменная.
+ *
+ * ### Описание
+ *
+ * Функция `is_number` предназначена для проверки, является ли переданное значение числом.
+ *
+ * Она проверяет:
+ *
+ * 1. **Тип значения**: Убеждается, что `value` имеет тип `number`.
+ * 2. **Конечность числа**: Проверяет, что значение не является `Infinity` или `NaN` с помощью `Number.isFinite(value)`.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение является числом, иначе `false`.
+ *
+ * ### Примеры использования
+ *
+ * ```js
+ * // Пример 1: Проверка числовых значений
+ * is_number(42); // true
+ * is_number(3.14); // true
+ * is_number(-0.99); // true
+ *
+ * // Пример 2: Проверка специальных числовых значений
+ * is_number(NaN); // false
+ * is_number(Infinity); // false
+ * is_number(-Infinity); // false
+ *
+ * // Пример 3: Проверка значений других типов
+ * is_number('42'); // false (строка)
+ * is_number(true); // false (логическое значение)
+ * is_number(null); // false
+ * is_number(undefined); // false
+ * is_number({}); // false (объект)
+ * is_number([]); // false (массив)
+ * ```
+ *
+ * @param {any} value Проверяемая переменная.
+ * @returns {boolean} Возвращает `true`, если значение является числом, иначе `false`.
+ */
+export default function is_number(value) {
+    return typeof value === 'number' && Number.isFinite(value);
+}

package/src/helpers/is_numeric.mjs

@@ -0,0 +1,64 @@
+/**
+ * Проверяет, является ли значение числом или числовой строкой.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Проверяемая переменная.
+ *
+ * ### Описание
+ *
+ * Функция `is_numeric` предназначена для проверки, является ли переданное значение числом или числовой строкой.
+ *
+ * Она проверяет:
+ *
+ * 1. **Тип значения**: Убеждается, что `value` имеет тип `number` или `string`.
+ * 2. **Конечность числа**: Проверяет, что значение не является `Infinity` или `NaN` с помощью `Number.isFinite(value)`.
+ * 3. **Числовая строка**: Проверяет, что строка может быть преобразована в конечное число.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение является числом или числовой строкой, иначе `false`.
+ *
+ * ### Примеры использования
+ *
+ * ```js
+ * // Пример 1: Проверка числовых значений
+ * is_numeric(42); // true
+ * is_numeric(3.14); // true
+ * is_numeric(-0.99); // true
+ *
+ * // Пример 2: Проверка числовых строк
+ * is_numeric('42'); // true
+ * is_numeric('3.14'); // true
+ * is_numeric('-0.99'); // true
+ *
+ * // Пример 3: Проверка специальных числовых значений
+ * is_numeric(NaN); // false
+ * is_numeric(Infinity); // false
+ * is_numeric(-Infinity); // false
+ *
+ * // Пример 4: Проверка значений других типов
+ * is_numeric(true); // false (логическое значение)
+ * is_numeric(null); // false
+ * is_numeric(undefined); // false
+ * is_numeric({}); // false (объект)
+ * is_numeric([]); // false (массив)
+ * ```
+ *
+ * @param {any} value Проверяемая переменная.
+ * @returns {boolean} Возвращает `true`, если значение является числом или числовой строкой, иначе `false`.
+ */
+export default function is_numeric(value) {
+    if (typeof value === 'number') {
+        return isFinite(value);
+    }
+
+    if (typeof value === 'string') {
+        const parsed = parseFloat(value);
+
+        return !isNaN(parsed) && isFinite(parsed);
+    }
+
+    return false;
+}

package/src/helpers/is_object.mjs

@@ -0,0 +1,72 @@
+import is_class from './is_class.mjs';
+
+/**
+ * Проверяет, является ли переданное значение объектом, созданным с использованием класса.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Проверяемая переменная.
+ *
+ * ### Описание
+ *
+ * В JavaScript объекты могут быть созданы как с использованием классов, так и с помощью функций-конструкторов
+ * или простых объектов. Для определения, является ли значение объектом, созданным с использованием класса,
+ * функция выполняет несколько проверок:
+ *
+ * 1. Проверка, что значение является объектом (с использованием `instanceof Object`).
+ * 2. Проверка, что у объекта есть конструктор, и что его строковое представление начинается с 'class',
+ *    что характерно для объектов, созданных с использованием классов.
+ *
+ * Это позволяет корректно отличить обычные объекты, массивы, примитивы и классовые объекты.
+ *
+ * #### Примечание
+ *
+ * - Если объект был создан с помощью `class`, то его конструктор будет иметь строковое представление, начинающееся с "class".
+ * - Массивы и обычные объекты, созданные с использованием `Object` или функции-конструктора, будут исключены.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение является объектом, созданным с использованием класса, иначе возвращает `false`.
+ *
+ * ### Примеры использования
+ *
+ * 1. Обычные объекты:
+ *
+ * ```js
+ * is_object({}); // false - это обычный объект, не созданный с помощью класса
+ * ```
+ *
+ * 2. Массивы:
+ *
+ * ```js
+ * is_object([]); // false - это массив, а не объект, созданный с использованием класса
+ * ```
+ *
+ * 3. Объект, созданный с использованием `Date`:
+ *
+ * ```js
+ * is_object(new Date()); // false - объект Date, не являющийся классом, а встроенным объектом
+ * ```
+ *
+ * 4. Классы:
+ *
+ * ```js
+ * class MyClass {}
+ * is_object(new MyClass()); // true - это объект, созданный с использованием класса
+ * ```
+ *
+ * 5. Примитивы и другие объекты:
+ *
+ * ```js
+ * is_object(null); // false - это не объект
+ * is_object(42); // false - это не объект
+ * is_object(new Map()); // false - объект Map, но не класс
+ * ```
+ *
+ * @param {any} value Проверяемая переменная.
+ * @returns {boolean}
+ */
+export default function is_object(value) {
+    return value instanceof Object && is_class(Object.getPrototypeOf(value).constructor);
+}

package/src/helpers/is_scalar.mjs

@@ -0,0 +1,45 @@
+import is_bool from './is_bool.mjs';
+import is_number from './is_number.mjs';
+import is_string from './is_string.mjs';
+import is_symbol from './is_symbol.mjs';
+
+/**
+ * Проверяет, является ли значение скалярным.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Проверяемая переменная.
+ *
+ * ### Описание
+ *
+ * Скалярные переменные — это переменные, содержащие `int`, `float`, `string`, `bool` и `symbol`.
+ * Типы `array`, `object`, `null`, `undefined` — не скалярные.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение является скалярным, иначе `false`.
+ *
+ * ### Примеры использования
+ *
+ * ```js
+ * // Пример 1: Проверка скалярных значений
+ * is_scalar(true); // true
+ * is_scalar(42); // true
+ * is_scalar('hello'); // true
+ * is_scalar(Symbol('symbol')); // true
+ *
+ * // Пример 2: Проверка не скалярных значений
+ * is_scalar(null); // false
+ * is_scalar(undefined); // false
+ * is_scalar({}); // false (объект)
+ * is_scalar([]); // false (массив)
+ * is_scalar(() => {}); // false (функция)
+ * ```
+ *
+ * @param {any} value Проверяемая переменная.
+ * @returns {boolean} Возвращает `true`, если значение является скалярным, иначе `false`.
+ */
+export default function is_scalar(value) {
+    return is_bool(value) || is_number(value) || is_string(value) || is_symbol(value);
+}

package/src/helpers/is_string.mjs

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

package/src/helpers/is_symbol.mjs

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

package/src/helpers/is_undefined.mjs

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