@rogolev/value 0.0.1 → 0.0.3

package/docs/classes/Value/isNumber.md

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

package/docs/classes/Value/isNumeric.md

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

package/docs/classes/Value/isObject.md

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

package/docs/classes/Value/isScalar.md

@@ -0,0 +1,72 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isScalar
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isScalar
+
+`Value.isScalar` — Проверяет, является ли значение скалярным.
+
+## Сигнатура метода
+
+```ts
+isScalar(): boolean;
+```
+
+## Описание
+
+Метод `isScalar` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, скалярным. Скалярные переменные — это переменные, содержащие `int`, `float`, `string`,
+`bool` и `symbol`. Типы `array`, `object`, `null`, `undefined` — не скалярные.
+
+Метод использует функцию `is_scalar` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является скалярным, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка скалярных значений:
+
+    ```js
+    const valueInstance1 = new Value(true);
+    const result1 = valueInstance1.isScalar();
+    // Результат: true
+
+    const valueInstance2 = new Value(42);
+    const result2 = valueInstance2.isScalar();
+    // Результат: true
+
+    const valueInstance3 = new Value('hello');
+    const result3 = valueInstance3.isScalar();
+    // Результат: true
+
+    const valueInstance4 = new Value(Symbol('symbol'));
+    const result4 = valueInstance4.isScalar();
+    // Результат: true
+    ```
+
+2. Проверка не скалярных значений:
+
+    ```js
+    const valueInstance1 = new Value(null);
+    const result1 = valueInstance1.isScalar();
+    // Результат: false
+
+    const valueInstance2 = new Value(undefined);
+    const result2 = valueInstance2.isScalar();
+    // Результат: false
+
+    const valueInstance3 = new Value({});
+    const result3 = valueInstance3.isScalar();
+    // Результат: false
+
+    const valueInstance4 = new Value([]);
+    const result4 = valueInstance4.isScalar();
+    // Результат: false
+
+    const valueInstance5 = new Value(() => {});
+    const result5 = valueInstance5.isScalar();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isString.md

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

package/docs/classes/Value/isSymbol.md

@@ -0,0 +1,75 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isSymbol
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isSymbol
+
+`Value.isSymbol` — Проверяет, является ли значение символом.
+
+## Сигнатура метода
+
+```ts
+isSymbol(): boolean;
+```
+
+## Описание
+
+Метод `isSymbol` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, символом. Метод использует оператор `typeof` для проверки типа значения.
+
+Метод использует функцию `is_symbol` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является символом, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка символов:
+
+    ```js
+    const valueInstance = new Value(Symbol('symbol'));
+    const result = valueInstance.isSymbol();
+    // Результат: true
+
+    const valueInstance2 = new Value(Symbol.iterator);
+    const result2 = valueInstance2.isSymbol();
+    // Результат: true
+    ```
+
+2. Проверка значений других типов:
+
+    ```js
+    const valueInstance = new Value('hello');
+    const result = valueInstance.isSymbol();
+    // Результат: false (строка)
+
+    const valueInstance2 = new Value(42);
+    const result2 = valueInstance2.isSymbol();
+    // Результат: false (число)
+
+    const valueInstance3 = new Value(true);
+    const result3 = valueInstance3.isSymbol();
+    // Результат: false (логическое значение)
+
+    const valueInstance4 = new Value(null);
+    const result4 = valueInstance4.isSymbol();
+    // Результат: false
+
+    const valueInstance5 = new Value(undefined);
+    const result5 = valueInstance5.isSymbol();
+    // Результат: false
+
+    const valueInstance6 = new Value({});
+    const result6 = valueInstance6.isSymbol();
+    // Результат: false (объект)
+
+    const valueInstance7 = new Value([]);
+    const result7 = valueInstance7.isSymbol();
+    // Результат: false (массив)
+
+    const valueInstance8 = new Value(() => {});
+    const result8 = valueInstance8.isSymbol();
+    // Результат: false (функция)
+    ```
+

package/docs/classes/Value/isUndefined.md

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

package/docs/classes/Value/print.md

@@ -0,0 +1,164 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / print
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.print
+
+`Value.print` — Преобразует значение переменной в строку и выводит его на консоль.
+
+## Сигнатура метода
+
+```ts
+print(): Value;
+```
+
+## Описание
+
+Метод `print` используется для преобразования значения, хранящегося в экземпляре класса `Value`, в
+строку и вывода его на консоль. Он обрабатывает массивы, объекты, классы, функции, символы и другие
+типы данных, возвращая их строковое представление.
+
+Метод использует функцию `print` для выполнения преобразования и вывода значения на консоль.
+
+## Возвращаемое значение
+
+Возвращает текущий экземпляр класса `Value`.
+
+## Примеры использования
+
+1. Преобразование строки:
+
+    ```js
+    const valueInstance = new Value('example');
+    valueInstance.print();
+    ```
+
+    Вывод:
+
+    ```txt
+    "example"
+    ```
+
+2. Преобразование числа:
+
+    ```js
+    const valueInstance = new Value(123);
+    valueInstance.print();
+    ```
+
+    Вывод:
+
+    ```txt
+    123
+    ```
+
+3. Преобразование булевых значений:
+
+    ```js
+    const valueInstance = new Value(true);
+    valueInstance.print();
+    ```
+
+    Вывод:
+
+    ```txt
+    true
+    ```
+
+    ```js
+    const valueInstance = new Value(false);
+    valueInstance.print();
+    ```
+
+    Вывод:
+
+    ```txt
+    false
+    ```
+
+4. Преобразование null и undefined:
+
+    ```js
+    const valueInstance = new Value(null);
+    valueInstance.print();
+    ```
+
+    Вывод:
+
+    ```txt
+    null
+    ```
+
+    ```js
+    const valueInstance = new Value(undefined);
+    valueInstance.print();
+    ```
+
+    Вывод:
+
+    ```txt
+    undefined
+    ```
+
+5. Преобразование массива:
+
+    ```js
+    const arr = [1, 2, 3];
+    const valueInstance = new Value(arr);
+    valueInstance.print();
+    ```
+
+    Вывод:
+
+    ```txt
+    [
+        0: 1,
+        1: 2,
+        2: 3,
+    ]
+    ```
+
+6. Преобразование ассоциативного массива:
+
+    ```js
+    const obj = { key: 'value' };
+    const valueInstance = new Value(obj);
+    valueInstance.print();
+    ```
+
+    Вывод:
+
+    ```txt
+    {
+        key: "value",
+    }
+    ```
+
+7. Преобразование функции:
+
+    ```js
+    const func = function () {};
+    const valueInstance = new Value(func);
+    valueInstance.print();
+    ```
+
+    Вывод:
+
+    ```txt
+    function func() {}
+    ```
+
+8. Преобразование символа:
+
+    ```js
+    const symbol = Symbol('example');
+    const valueInstance = new Value(symbol);
+    valueInstance.print();
+    ```
+
+    Вывод:
+
+    ```txt
+    Symbol(example)
+    ```
+