@rogolev/value 0.0.1 → 0.0.3

package/docs/classes/Type/isFunction.md

@@ -0,0 +1,64 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isFunction
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isFunction
+
+`Type.isFunction` — Проверяет, что значение является функцией, исключая классы.
+
+## Сигнатура метода
+
+```ts
+static isFunction(value: any): boolean;
+```
+
+## Описание
+
+Метод проверяет, является ли переданное значение функцией, исключая классы. В JavaScript функции и
+классы оба являются типом `function`, но классы имеют особый синтаксис и поведение. Метод
+`Type.isFunction` различает их, проверяя, не начинается ли строковое представление функции с
+`class`, что указывает на то, что это класс, а не обычная функция. Если значение является функцией
+(но не классом), метод возвращает `true`. Для всех остальных типов данных (включая классы, объекты,
+примитивы) метод возвращает `false`.
+
+## Параметры
+
+- `value` (any)
+
+    Проверяемое значение. Может быть любым типом данных.
+
+## Возвращаемое значение
+
+Возвращает `true`, если переданное значение является функцией (но не классом). Возвращает `false`,
+если переданное значение является классом или любым другим типом данных.
+
+## Примеры использования
+
+1. Обычная функция:
+
+    ```js
+    function test() {}
+    Type.isFunction(test); // true
+    ```
+
+2. Класс:
+
+    ```js
+    class MyClass {}
+    Type.isFunction(MyClass); // false
+    ```
+
+3. Объект:
+
+    ```js
+    const obj = {};
+    Type.isFunction(obj); // false
+    ```
+
+4. Примитив:
+
+    ```js
+    Type.isFunction(42); // false
+    Type.isFunction('hello'); // false
+    ```
+

package/docs/classes/Type/isInfinity.md

@@ -0,0 +1,59 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isInfinity
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isInfinity
+
+`Type.isInfinity` — Проверяет, является ли значение бесконечностью (Infinity или -Infinity).
+
+## Сигнатура метода
+
+```ts
+static isInfinity(value: any): boolean;
+```
+
+## Описание
+
+Метод `Type.isInfinity` проверяет, является ли переданное значение бесконечностью (Infinity или
+-Infinity).
+
+Он проверяет, равно ли значение `Number.POSITIVE_INFINITY` или `Number.NEGATIVE_INFINITY`.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является бесконечностью, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка значения Infinity:
+
+    ```js
+    Type.isInfinity(Infinity); // true
+    Type.isInfinity(-Infinity); // true
+    ```
+
+2. Проверка числовых значений:
+
+    ```js
+    Type.isInfinity(42); // false
+    Type.isInfinity(3.14); // false
+    Type.isInfinity(NaN); // false
+    ```
+
+3. Проверка значений других типов:
+
+    ```js
+    Type.isInfinity('Infinity'); // false (строка)
+    Type.isInfinity(true); // false (логическое значение)
+    Type.isInfinity(null); // false
+    Type.isInfinity(undefined); // false
+    Type.isInfinity({}); // false (объект)
+    Type.isInfinity([]); // false (массив)
+    ```
+

package/docs/classes/Type/isInt.md

@@ -0,0 +1,77 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isInt
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isInt
+
+`Type.isInt` — Проверяет, является ли значение целым числом.
+
+## Сигнатура метода
+
+```ts
+static isInt(value: any): boolean;
+```
+
+## Описание
+
+Метод `Type.isInt` определяет, является ли переданное значение целым числом.
+
+Он выполняет следующие проверки:
+
+1. **Тип значения**: Убеждается, что `value` имеет тип `number`.
+2. **Конечность числа**: Проверяет, что значение не является `Infinity` или `NaN` с помощью
+   `Number.isFinite(value)`.
+3. **Целочисленность**: Убедится, что остаток от деления числа на 1 равен нулю (`value % 1 === 0`).
+
+Если значение соответствует всем этим условиям, оно считается целым числом.
+
+## Параметры
+
+- `value` (any)
+
+    Значение для проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является целым числом, иначе `false`.
+
+## Примеры использования
+
+1. Проверка целых чисел:
+
+    ```js
+    Type.isInt(42); // true
+    Type.isInt(0); // true
+    Type.isInt(-123); // true
+    ```
+
+2. Проверка дробных чисел:
+
+    ```js
+    Type.isInt(3.14); // false
+    Type.isInt(-0.001); // false
+    ```
+
+3. Некорректные типы данных:
+
+    ```js
+    Type.isInt('42'); // false (строка)
+    Type.isInt(true); // false (логическое значение)
+    Type.isInt(null); // false (null)
+    Type.isInt(undefined); // false (undefined)
+    ```
+
+4. Бесконечные и некорректные числовые значения:
+
+    ```js
+    Type.isInt(Infinity); // false (бесконечность)
+    Type.isInt(-Infinity); // false (отрицательная бесконечность)
+    Type.isInt(NaN); // false (не число)
+    ```
+
+5. Проверка типа bigint:
+
+    ```js
+    Type.isInt(BigInt(123456)); // false
+    ```
+

package/docs/classes/Type/isInteger.md

@@ -0,0 +1,77 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isInteger
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isInteger
+
+`Type.isInteger` — Проверяет, является ли значение целым числом.
+
+## Сигнатура метода
+
+```ts
+static isInteger(value: any): boolean;
+```
+
+## Описание
+
+Метод `Type.isInteger` проверяет, является ли переданное значение целым числом.
+
+Он выполняет следующие проверки:
+
+1. **Тип значения**: Убеждается, что `value` имеет тип `number`.
+2. **Конечность числа**: Проверяет, что значение не является `Infinity` или `NaN` с помощью
+   `Number.isFinite(value)`.
+3. **Целочисленность**: Убедится, что остаток от деления числа на 1 равен нулю (`value % 1 === 0`).
+
+Если значение соответствует всем этим условиям, оно считается целым числом.
+
+## Параметры
+
+- `value` (any)
+
+    Значение для проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является целым числом, иначе `false`.
+
+## Примеры использования
+
+1. Проверка целых чисел:
+
+    ```js
+    Type.isInteger(42); // true
+    Type.isInteger(0); // true
+    Type.isInteger(-123); // true
+    ```
+
+2. Проверка дробных чисел:
+
+    ```js
+    Type.isInteger(3.14); // false
+    Type.isInteger(-0.001); // false
+    ```
+
+3. Некорректные типы данных:
+
+    ```js
+    Type.isInteger('42'); // false (строка)
+    Type.isInteger(true); // false (логическое значение)
+    Type.isInteger(null); // false (null)
+    Type.isInteger(undefined); // false (undefined)
+    ```
+
+4. Бесконечные и некорректные числовые значения:
+
+    ```js
+    Type.isInteger(Infinity); // false (бесконечность)
+    Type.isInteger(-Infinity); // false (отрицательная бесконечность)
+    Type.isInteger(NaN); // false (не число)
+    ```
+
+5. Проверка типа bigint:
+
+    ```js
+    Type.isInteger(BigInt(123456)); // false
+    ```
+

package/docs/classes/Type/isList.md

@@ -0,0 +1,49 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isList
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isList
+
+`Type.isList` — Проверяет, является ли значение списком.
+
+## Сигнатура метода
+
+```ts
+static isList(value: any): boolean;
+```
+
+## Описание
+
+Метод `Type.isList` проверяет, является ли переданное значение списком.
+
+Он использует метод `Array.isArray` для проверки значения.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является списком, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка массивов:
+
+    ```js
+    Type.isList([]); // true
+    Type.isList([1, 2, 3]); // true
+    ```
+
+2. Проверка значений других типов:
+
+    ```js
+    Type.isList({}); // false (ассоциативный массив)
+    Type.isList('string'); // false (строка)
+    Type.isList(42); // false (число)
+    Type.isList(null); // false
+    Type.isList(undefined); // false
+    ```
+

package/docs/classes/Type/isNaN.md

@@ -0,0 +1,57 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isNaN
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isNaN
+
+`Type.isNaN` — Проверяет, является ли значение NaN.
+
+## Сигнатура метода
+
+```ts
+static isNaN(value: any): boolean;
+```
+
+## Описание
+
+Метод `Type.isNaN` проверяет, является ли переданное значение NaN (Not-a-Number).
+
+Он использует метод `Number.isNaN` для проверки значения.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является NaN, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка значения NaN:
+
+    ```js
+    Type.isNaN(NaN); // true
+    ```
+
+2. Проверка числовых значений:
+
+    ```js
+    Type.isNaN(42); // false
+    Type.isNaN(3.14); // false
+    Type.isNaN(Infinity); // false
+    ```
+
+3. Проверка значений других типов:
+
+    ```js
+    Type.isNaN('42'); // false (строка)
+    Type.isNaN(true); // false (логическое значение)
+    Type.isNaN(null); // false
+    Type.isNaN(undefined); // false
+    Type.isNaN({}); // false (объект)
+    Type.isNaN([]); // false (массив)
+    ```
+

package/docs/classes/Type/isNull.md

@@ -0,0 +1,49 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isNull
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isNull
+
+`Type.isNull` — Проверяет, является ли значение `null`.
+
+## Сигнатура метода
+
+```ts
+static isNull(value: any): boolean;
+```
+
+## Описание
+
+Метод `Type.isNull` проверяет, является ли переданное значение `null`.
+
+Он просто сравнивает значение с `null`.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является `null`, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка значения `null`:
+
+    ```js
+    Type.isNull(null); // true
+    ```
+
+2. Проверка значений других типов:
+
+    ```js
+    Type.isNull(undefined); // false
+    Type.isNull(0); // false
+    Type.isNull(''); // false
+    Type.isNull(false); // false
+    Type.isNull({}); // false
+    Type.isNull([]); // false
+    ```
+

package/docs/classes/Type/isNumber.md

@@ -0,0 +1,60 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isNumber
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isNumber
+
+`Type.isNumber` — Проверяет, является ли значение числом.
+
+## Сигнатура метода
+
+```ts
+static isNumber(value: any): boolean;
+```
+
+## Описание
+
+Метод `Type.isNumber` проверяет, является ли переданное значение числом.
+
+Он использует оператор `typeof` для проверки типа значения.
+
+Метод возвращает `false` для значений других типов, таких как строки, объекты или массивы.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является числом, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка числовых значений:
+
+    ```js
+    Type.isNumber(42); // true
+    Type.isNumber(3.14); // true
+    ```
+
+2. Проверка значений других типов:
+
+    ```js
+    Type.isNumber('42'); // false (строка)
+    Type.isNumber(true); // false (логическое значение)
+    Type.isNumber(null); // false
+    Type.isNumber(undefined); // false
+    Type.isNumber({}); // false (объект)
+    Type.isNumber([]); // false (массив)
+    ```
+
+3. Проверка специальных чисел:
+
+    ```js
+    Type.isNumber(NaN); // false
+    Type.isNumber(Infinity); // false
+    Type.isNumber(-Infinity); // false
+    ```
+

package/docs/classes/Type/isNumeric.md

@@ -0,0 +1,58 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isNumeric
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isNumeric
+
+`Type.isNumeric` — Проверяет, является ли значение числом или числовой строкой.
+
+## Сигнатура метода
+
+```ts
+static isNumeric(value: any): boolean;
+```
+
+## Описание
+
+Метод `Type.isNumeric` проверяет, является ли переданное значение числом или строкой, которая может
+быть преобразована в число.
+
+Он использует функцию `is_numeric` для выполнения проверки.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является числом или числовой строкой, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка числовых значений:
+
+    ```js
+    Type.isNumeric(42); // true
+    Type.isNumeric(3.14); // true
+    ```
+
+2. Проверка числовых строк:
+
+    ```js
+    Type.isNumeric('42'); // true
+    Type.isNumeric('3.14'); // true
+    ```
+
+3. Проверка значений других типов:
+
+    ```js
+    Type.isNumeric(true); // false (логическое значение)
+    Type.isNumeric(null); // false
+    Type.isNumeric(undefined); // false
+    Type.isNumeric({}); // false (объект)
+    Type.isNumeric([]); // false (массив)
+    Type.isNumeric('hello'); // false (строка)
+    ```
+

package/docs/classes/Type/isObject.md

@@ -0,0 +1,53 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isObject
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isObject
+
+`Type.isObject` — Проверяет, является ли переданная переменная объектом.
+
+## Сигнатура метода
+
+```ts
+static isObject(value: any): boolean;
+```
+
+## Описание
+
+Метод `Type.isObject` проверяет, является ли переданное значение объектом.
+
+Он использует оператор `typeof` для проверки типа значения и убеждается, что значение не является
+`null`.
+
+Метод возвращает `false` для значений других типов, таких как числа, строки, массивы или функции.
+
+## Параметры
+
+- `value` (any)
+
+    Проверяемая переменная.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является объектом, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка объектов:
+
+    ```js
+    Type.isObject({}); // true
+    Type.isObject({ key: 'value' }); // true
+    ```
+
+2. Проверка значений других типов:
+
+    ```js
+    Type.isObject(42); // false (число)
+    Type.isObject('string'); // false (строка)
+    Type.isObject(null); // false
+    Type.isObject(undefined); // false
+    Type.isObject([]); // false (массив)
+    Type.isObject(() => {}); // false (функция)
+    ```
+

package/docs/classes/Type/isScalar.md

@@ -0,0 +1,54 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isScalar
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isScalar
+
+`Type.isScalar` — Проверяет, является ли значение скалярным.
+
+## Сигнатура метода
+
+```ts
+static isScalar(value: any): boolean;
+```
+
+## Описание
+
+Метод `Type.isScalar` проверяет, является ли переданное значение скалярным.
+
+Скалярные переменные — это переменные, содержащие `int`, `float`, `string`, `bool` и `symbol`. Типы
+`array`, `object`, `null`, `undefined` — не скалярные.
+
+## Параметры
+
+- `value` (any)
+
+    Проверяемая переменная.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является скалярным, иначе `false`.
+
+## Примеры использования
+
+1. Проверка скалярных значений:
+
+    ```js
+    Type.isScalar(true); // true
+    Type.isScalar(false); // true
+    Type.isScalar(42); // true
+    Type.isScalar(3.14); // true
+    Type.isScalar('hello'); // true
+    Type.isScalar(Symbol('symbol')); // true
+    ```
+
+2. Проверка не скалярных значений:
+
+    ```js
+    Type.isScalar(null); // false
+    Type.isScalar(undefined); // false
+    Type.isScalar({}); // false (объект)
+    Type.isScalar([]); // false (массив)
+    Type.isScalar(() => {}); // false (функция)
+    ```
+