@rogolev/value 0.0.1 → 0.0.2

package/src/helpers/is_numeric.mjs

@@ -1,64 +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;
-}
+/**
+ * Проверяет, является ли значение числом или числовой строкой.
+ *
+ * ### Параметры
+ *
+ * - `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

@@ -1,72 +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);
-}
+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

@@ -1,45 +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);
-}
+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

@@ -1,46 +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';
-}
+/**
+ * Проверяет, является ли значение строкой.
+ *
+ * ### Параметры
+ *
+ * - `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

@@ -1,46 +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';
-}
+/**
+ * Проверяет, является ли значение символом.
+ *
+ * ### Параметры
+ *
+ * - `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

@@ -1,44 +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';
-}
+/**
+ * Проверяет, является ли значение `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';
+}