@rogolev/value 0.0.1 → 0.0.3

package/docs/classes/Value/isBoolean.md

@@ -0,0 +1,60 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isBoolean
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isBoolean
+
+`Value.isBoolean` — Проверяет, является ли значение логическим (булевым).
+
+## Сигнатура метода
+
+```ts
+isBoolean(): boolean;
+```
+
+## Описание
+
+Метод `isBoolean` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, логическим (булевым). Логическим значением считается значение, которое является `true` или
+`false`.
+
+Метод использует функцию `is_bool` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является логическим, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка значения `true`:
+
+    ```js
+    const valueInstance = new Value(true);
+    const result = valueInstance.isBoolean();
+    // Результат: true
+    ```
+
+2. Проверка значения `false`:
+
+    ```js
+    const valueInstance = new Value(false);
+    const result = valueInstance.isBoolean();
+    // Результат: true
+    ```
+
+3. Проверка строки:
+
+    ```js
+    const valueInstance = new Value('true');
+    const result = valueInstance.isBoolean();
+    // Результат: false
+    ```
+
+4. Проверка числа:
+
+    ```js
+    const valueInstance = new Value(1);
+    const result = valueInstance.isBoolean();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isClass.md

@@ -0,0 +1,55 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isClass
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isClass
+
+`Value.isClass` — Проверяет, является ли значение классом.
+
+## Сигнатура метода
+
+```ts
+isClass(): boolean;
+```
+
+## Описание
+
+Метод `isClass` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, классом. Классом считается значение, которое является функцией и имеет свойство
+`prototype`, являющееся объектом.
+
+Метод использует функцию `is_class` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является классом, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка класса:
+
+    ```js
+    class MyClass {}
+    const valueInstance = new Value(MyClass);
+    const result = valueInstance.isClass();
+    // Результат: true
+    ```
+
+2. Проверка функции:
+
+    ```js
+    const myFunction = function () {};
+    const valueInstance = new Value(myFunction);
+    const result = valueInstance.isClass();
+    // Результат: false
+    ```
+
+3. Проверка объекта:
+
+    ```js
+    const myObject = {};
+    const valueInstance = new Value(myObject);
+    const result = valueInstance.isClass();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isEmpty.md

@@ -0,0 +1,84 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isEmpty
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isEmpty
+
+`Value.isEmpty` — Проверяет, является ли значение, хранящееся в экземпляре класса `Value`,
+пустым.
+
+## Сигнатура метода
+
+```ts
+isEmpty(): boolean;
+```
+
+## Описание
+
+Метод `isEmpty` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, пустым. Пустыми считаются значения `null`, `undefined`, пустая строка, `0`, `false`, пустой
+массив и пустой объект.
+
+Метод использует функцию `empty` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение пустое, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка пустых значений:
+
+    ```js
+    const valueInstance1 = new Value(null);
+    const result1 = valueInstance1.isEmpty();
+    // Результат: true
+
+    const valueInstance2 = new Value(undefined);
+    const result2 = valueInstance2.isEmpty();
+    // Результат: true
+
+    const valueInstance3 = new Value('');
+    const result3 = valueInstance3.isEmpty();
+    // Результат: true
+
+    const valueInstance4 = new Value(0);
+    const result4 = valueInstance4.isEmpty();
+    // Результат: true
+
+    const valueInstance5 = new Value(false);
+    const result5 = valueInstance5.isEmpty();
+    // Результат: true
+
+    const valueInstance6 = new Value([]);
+    const result6 = valueInstance6.isEmpty();
+    // Результат: true
+
+    const valueInstance7 = new Value({});
+    const result7 = valueInstance7.isEmpty();
+    // Результат: true
+    ```
+
+2. Проверка непустых значений:
+
+    ```js
+    const valueInstance1 = new Value('example');
+    const result1 = valueInstance1.isEmpty();
+    // Результат: false
+
+    const valueInstance2 = new Value(123);
+    const result2 = valueInstance2.isEmpty();
+    // Результат: false
+
+    const valueInstance3 = new Value(true);
+    const result3 = valueInstance3.isEmpty();
+    // Результат: false
+
+    const valueInstance4 = new Value([1, 2, 3]);
+    const result4 = valueInstance4.isEmpty();
+    // Результат: false
+
+    const valueInstance5 = new Value({ key: 'value' });
+    const result5 = valueInstance5.isEmpty();
+    // Результат: false
+    ```

package/docs/classes/Value/isFloat.md

@@ -0,0 +1,52 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isFloat
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isFloat
+
+`Value.isFloat` — Проверяет, является ли значение числом с плавающей точкой.
+
+## Сигнатура метода
+
+```ts
+isFloat(): boolean;
+```
+
+## Описание
+
+Метод `isFloat` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, числом с плавающей точкой. Числом с плавающей точкой считается значение, которое является
+числом и не является целым числом.
+
+Метод использует функцию `is_float` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является числом с плавающей точкой, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка числа с плавающей точкой:
+
+    ```js
+    const valueInstance = new Value(123.45);
+    const result = valueInstance.isFloat();
+    // Результат: true
+    ```
+
+2. Проверка целого числа:
+
+    ```js
+    const valueInstance = new Value(123);
+    const result = valueInstance.isFloat();
+    // Результат: false
+    ```
+
+3. Проверка строки:
+
+    ```js
+    const valueInstance = new Value('123.45');
+    const result = valueInstance.isFloat();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isFunction.md

@@ -0,0 +1,60 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isFunction
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isFunction
+
+`Value.isFunction` — Проверяет, является ли значение функцией.
+
+## Сигнатура метода
+
+```ts
+isFunction(): boolean;
+```
+
+## Описание
+
+Метод `isFunction` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, функцией. Функцией считается значение, которое является экземпляром класса `Function`.
+
+Метод использует функцию `is_function` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является функцией, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка функции:
+
+    ```js
+    const valueInstance = new Value(function () {});
+    const result = valueInstance.isFunction();
+    // Результат: true
+    ```
+
+2. Проверка стрелочной функции:
+
+    ```js
+    const valueInstance = new Value(() => {});
+    const result = valueInstance.isFunction();
+    // Результат: true
+    ```
+
+3. Проверка класса:
+
+    ```js
+    class MyClass {}
+    const valueInstance = new Value(MyClass);
+    const result = valueInstance.isFunction();
+    // Результат: false
+    ```
+
+4. Проверка объекта:
+
+    ```js
+    const valueInstance = new Value({});
+    const result = valueInstance.isFunction();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isInfinity.md

@@ -0,0 +1,60 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isInfinity
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isInfinity
+
+`Value.isInfinity` — Проверяет, является ли значение бесконечностью.
+
+## Сигнатура метода
+
+```ts
+isInfinity(): boolean;
+```
+
+## Описание
+
+Метод `isInfinity` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, бесконечностью. Значение считается бесконечностью, если оно равно `Infinity` или
+`-Infinity`.
+
+Метод использует функцию `is_infinity` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является бесконечностью, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка значения `Infinity`:
+
+    ```js
+    const valueInstance = new Value(Infinity);
+    const result = valueInstance.isInfinity();
+    // Результат: true
+    ```
+
+2. Проверка значения `-Infinity`:
+
+    ```js
+    const valueInstance = new Value(-Infinity);
+    const result = valueInstance.isInfinity();
+    // Результат: true
+    ```
+
+3. Проверка значения `123`:
+
+    ```js
+    const valueInstance = new Value(123);
+    const result = valueInstance.isInfinity();
+    // Результат: false
+    ```
+
+4. Проверка значения `NaN`:
+
+    ```js
+    const valueInstance = new Value(NaN);
+    const result = valueInstance.isInfinity();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isInt.md

@@ -0,0 +1,52 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isInt
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isInt
+
+`Value.isInt` — Проверяет, является ли значение целым числом.
+
+## Сигнатура метода
+
+```ts
+isInt(): boolean;
+```
+
+## Описание
+
+Метод `isInt` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, целым числом. Целым числом считается значение, которое имеет тип `number`, является
+конечным и не имеет дробной части.
+
+Метод использует функцию `is_int` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является целым числом, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка целого числа:
+
+    ```js
+    const valueInstance = new Value(123);
+    const result = valueInstance.isInt();
+    // Результат: true
+    ```
+
+2. Проверка числа с плавающей точкой:
+
+    ```js
+    const valueInstance = new Value(123.45);
+    const result = valueInstance.isInt();
+    // Результат: false
+    ```
+
+3. Проверка строки:
+
+    ```js
+    const valueInstance = new Value('123');
+    const result = valueInstance.isInt();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isInteger.md

@@ -0,0 +1,52 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isInteger
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isInteger
+
+`Value.isInteger` — Проверяет, является ли значение целым числом.
+
+## Сигнатура метода
+
+```ts
+isInteger(): boolean;
+```
+
+## Описание
+
+Метод `isInteger` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, целым числом. Целым числом считается значение, которое имеет тип `number`, является
+конечным и не имеет дробной части.
+
+Метод использует функцию `is_int` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является целым числом, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка целого числа:
+
+    ```js
+    const valueInstance = new Value(123);
+    const result = valueInstance.isInteger();
+    // Результат: true
+    ```
+
+2. Проверка числа с плавающей точкой:
+
+    ```js
+    const valueInstance = new Value(123.45);
+    const result = valueInstance.isInteger();
+    // Результат: false
+    ```
+
+3. Проверка строки:
+
+    ```js
+    const valueInstance = new Value('123');
+    const result = valueInstance.isInteger();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isList.md

@@ -0,0 +1,59 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isList
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isList
+
+`Value.isList` — Проверяет, является ли значение списком.
+
+## Сигнатура метода
+
+```ts
+isList(): boolean;
+```
+
+## Описание
+
+Метод `isList` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, списком. Списком считается значение, которое является массивом.
+
+Метод использует функцию `is_list` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является списком, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка массивов:
+
+    ```js
+    const valueInstance = new Value([1, 2, 3]);
+    const result = valueInstance.isList();
+    // Результат: true
+    ```
+
+2. Проверка значений других типов:
+
+    ```js
+    const valueInstance = new Value({});
+    const result = valueInstance.isList();
+    // Результат: false
+
+    const valueInstance2 = new Value('string');
+    const result2 = valueInstance2.isList();
+    // Результат: false
+
+    const valueInstance3 = new Value(42);
+    const result3 = valueInstance3.isList();
+    // Результат: false
+
+    const valueInstance4 = new Value(null);
+    const result4 = valueInstance4.isList();
+    // Результат: false
+
+    const valueInstance5 = new Value(undefined);
+    const result5 = valueInstance5.isList();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isNaN.md

@@ -0,0 +1,79 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isNaN
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isNaN
+
+`Value.isNaN` — Проверяет, является ли значение NaN.
+
+## Сигнатура метода
+
+```ts
+isNaN(): boolean;
+```
+
+## Описание
+
+Метод `isNaN` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, NaN (Not-a-Number).
+
+Метод использует функцию `is_nan` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является NaN, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка значения NaN:
+
+    ```js
+    const valueInstance = new Value(NaN);
+    const result = valueInstance.isNaN();
+    // Результат: true
+    ```
+
+2. Проверка числовых значений:
+
+    ```js
+    const valueInstance = new Value(42);
+    const result = valueInstance.isNaN();
+    // Результат: false
+
+    const valueInstance2 = new Value(3.14);
+    const result2 = valueInstance2.isNaN();
+    // Результат: false
+
+    const valueInstance3 = new Value(Infinity);
+    const result3 = valueInstance3.isNaN();
+    // Результат: false
+    ```
+
+3. Проверка значений других типов:
+
+    ```js
+    const valueInstance = new Value('42');
+    const result = valueInstance.isNaN();
+    // Результат: false
+
+    const valueInstance2 = new Value(true);
+    const result2 = valueInstance2.isNaN();
+    // Результат: false
+
+    const valueInstance3 = new Value(null);
+    const result3 = valueInstance3.isNaN();
+    // Результат: false
+
+    const valueInstance4 = new Value(undefined);
+    const result4 = valueInstance4.isNaN();
+    // Результат: false
+
+    const valueInstance5 = new Value({});
+    const result5 = valueInstance5.isNaN();
+    // Результат: false
+
+    const valueInstance6 = new Value([]);
+    const result6 = valueInstance6.isNaN();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isNull.md

@@ -0,0 +1,59 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isNull
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isNull
+
+`Value.isNull` — Проверяет, является ли значение null.
+
+## Сигнатура метода
+
+```ts
+isNull(): boolean;
+```
+
+## Описание
+
+Метод `isNull` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, null. Значение считается null, если оно строго равно null.
+
+Метод использует функцию `is_null` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является null, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка значения null:
+
+    ```js
+    const valueInstance = new Value(null);
+    const result = valueInstance.isNull();
+    // Результат: true
+    ```
+
+2. Проверка значения undefined:
+
+    ```js
+    const valueInstance = new Value(undefined);
+    const result = valueInstance.isNull();
+    // Результат: false
+    ```
+
+3. Проверка значения 0:
+
+    ```js
+    const valueInstance = new Value(0);
+    const result = valueInstance.isNull();
+    // Результат: false
+    ```
+
+4. Проверка значения пустой строки:
+
+    ```js
+    const valueInstance = new Value('');
+    const result = valueInstance.isNull();
+    // Результат: false
+    ```
+