@rogolev/value 0.0.2 → 0.0.3

package/docs/classes/Value/toList.md

@@ -0,0 +1,77 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / toList
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.toList
+
+`Value.toList` — Преобразует значение в экземпляре класса `Value` к списку.
+
+## Сигнатура метода
+
+```ts
+toList(): Value;
+```
+
+## Описание
+
+Метод `toList` используется для преобразования значения, хранящегося в экземпляре класса `Value`, в
+список. Если значение является `null` или `undefined`, возвращается пустой массив. Если значение уже
+является массивом, возвращается оно же. Если значение является ассоциативным массивом, возвращается
+массив значений объекта. Для других значений создается массив, содержащий это значение.
+
+Метод использует функцию `to_list` для выполнения преобразования.
+
+## Возвращаемое значение
+
+Возвращает новый экземпляр класса `Value` с преобразованным значением.
+
+## Примеры использования
+
+1. Преобразование `null` в пустой массив:
+
+    ```js
+    const valueInstance = new Value(null);
+    const result = valueInstance.toList();
+    // Результат: новый экземпляр класса Value с значением []
+    ```
+
+2. Преобразование `undefined` в пустой массив:
+
+    ```js
+    const valueInstance = new Value(undefined);
+    const result = valueInstance.toList();
+    // Результат: новый экземпляр класса Value с значением []
+    ```
+
+3. Преобразование массива (без изменений):
+
+    ```js
+    const valueInstance = new Value([1, 2, 3]);
+    const result = valueInstance.toList();
+    // Результат: новый экземпляр класса Value с значением [1, 2, 3]
+    ```
+
+4. Преобразование ассоциативного массива в массив значений:
+
+    ```js
+    const valueInstance = new Value({ key: 'value' });
+    const result = valueInstance.toList();
+    // Результат: новый экземпляр класса Value с значением ['value']
+    ```
+
+5. Преобразование строки в массив:
+
+    ```js
+    const valueInstance = new Value('example');
+    const result = valueInstance.toList();
+    // Результат: новый экземпляр класса Value с значением ['example']
+    ```
+
+6. Преобразование числа в массив:
+
+    ```js
+    const valueInstance = new Value(123);
+    const result = valueInstance.toList();
+    // Результат: новый экземпляр класса Value с значением [123]
+    ```
+

package/docs/classes/Value/toObject.md

@@ -0,0 +1,78 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / toObject
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.toObject
+
+`Value.toObject` — Преобразует значение в экземпляре класса `Value` к объекту.
+
+## Сигнатура метода
+
+```ts
+toObject(): Value;
+```
+
+## Описание
+
+Метод `toObject` используется для преобразования значения, хранящегося в экземпляре класса `Value`,
+в объект. Если значение уже является объектом, оно возвращается без изменений. Если значение
+является классом, возвращается новый экземпляр этого класса. Если значение является массивом,
+элементы массива копируются в новый объект. Для других значений создается объект с полем `value`,
+содержащим это значение.
+
+Метод использует функцию `to_object` для выполнения преобразования.
+
+## Возвращаемое значение
+
+Возвращает новый экземпляр класса `Value` с преобразованным значением.
+
+## Примеры использования
+
+1. Преобразование объекта:
+
+    ```js
+    class MyClass {}
+    const obj = new MyClass();
+    const valueInstance = new Value(obj);
+    const result = valueInstance.toObject();
+    // Результат: новый экземпляр класса Value с значением obj
+    ```
+
+2. Преобразование класса:
+
+    ```js
+    class MyClass {}
+    const valueInstance = new Value(MyClass);
+    const result = valueInstance.toObject();
+    // Результат: новый экземпляр класса Value с значением экземпляра MyClass
+    ```
+
+3. Преобразование null и undefined:
+
+    ```js
+    const valueInstance1 = new Value(null);
+    const result1 = valueInstance1.toObject();
+    // Результат: новый экземпляр класса Value с значением экземпляра анонимного класса
+
+    const valueInstance2 = new Value(undefined);
+    const result2 = valueInstance2.toObject();
+    // Результат: новый экземпляр класса Value с значением экземпляра анонимного класса
+    ```
+
+4. Преобразование массива:
+
+    ```js
+    const arr = [1, 2, 3];
+    const valueInstance = new Value(arr);
+    const result = valueInstance.toObject();
+    // Результат: новый экземпляр класса Value с значением объекта с элементами массива
+    ```
+
+5. Преобразование других значений:
+
+    ```js
+    const valueInstance = new Value('example');
+    const result = valueInstance.toObject();
+    // Результат: новый экземпляр класса Value с значением объекта с полем value, содержащим 'example'
+    ```
+

package/docs/classes/Value/toPrint.md

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

package/docs/classes/Value/toPrintType.md

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

package/docs/classes/Value/toString.md

@@ -0,0 +1,134 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / toString
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.toString
+
+`Value.toString` — Преобразует значение в экземпляре класса `Value` к строке.
+
+## Сигнатура метода
+
+```ts
+toString(): Value;
+```
+
+## Описание
+
+Метод `toString` используется для преобразования значения, хранящегося в экземпляре класса `Value`,
+в строку. Он обрабатывает массивы, объекты, классы, функции, символы и другие типы данных, возвращая
+их строковое представление.
+
+Метод использует функцию `to_string` для выполнения преобразования.
+
+## Возвращаемое значение
+
+Возвращает новый экземпляр класса `Value` с преобразованным значением.
+
+## Примеры использования
+
+1. Преобразование строки:
+
+    ```js
+    const valueInstance = new Value('example');
+    const result = valueInstance.toString();
+    // Результат: новый экземпляр класса Value с значением 'example'
+    ```
+
+2. Преобразование числа:
+
+    ```js
+    const valueInstance = new Value(123);
+    const result = valueInstance.toString();
+    // Результат: новый экземпляр класса Value с значением '123'
+    ```
+
+3. Преобразование булевых значений:
+
+    ```js
+    const valueInstance1 = new Value(true);
+    const result1 = valueInstance1.toString();
+    // Результат: новый экземпляр класса Value с значением 'true'
+
+    const valueInstance2 = new Value(false);
+    const result2 = valueInstance2.toString();
+    // Результат: новый экземпляр класса Value с значением 'false'
+    ```
+
+4. Преобразование null и undefined:
+
+    ```js
+    const valueInstance1 = new Value(null);
+    const result1 = valueInstance1.toString();
+    // Результат: новый экземпляр класса Value с значением 'null'
+
+    const valueInstance2 = new Value(undefined);
+    const result2 = valueInstance2.toString();
+    // Результат: новый экземпляр класса Value с значением 'undefined'
+    ```
+
+5. Преобразование массива:
+
+    ```js
+    const arr = [1, 2, 3];
+    const valueInstance = new Value(arr);
+    const result = valueInstance.toString();
+    // Результат: новый экземпляр класса Value с значением '[\n    1,\n    2,\n    3,\n]'
+    ```
+
+6. Преобразование объекта:
+
+    ```js
+    const obj = { key: 'value' };
+    const valueInstance = new Value(obj);
+    const result = valueInstance.toString();
+    // Результат: новый экземпляр класса Value с значением '{\n    key: 'value',\n}'
+    ```
+
+7. Преобразование функции:
+
+    ```js
+    const func = function () {};
+    const valueInstance = new Value(func);
+    const result = valueInstance.toString();
+    // Результат: новый экземпляр класса Value с значением 'function func() {}'
+    ```
+
+8. Преобразование символа:
+
+    ```js
+    const symbol = Symbol('example');
+    const valueInstance = new Value(symbol);
+    const result = valueInstance.toString();
+    // Результат: новый экземпляр класса Value с значением 'Symbol(example)'
+    ```
+
+9. Преобразование BigInt:
+
+    ```js
+    const bigInt = BigInt(123);
+    const valueInstance = new Value(bigInt);
+    const result = valueInstance.toString();
+    // Результат: новый экземпляр класса Value с значением '123'
+    ```
+
+10. Преобразование класса:
+
+    ```js
+    class MyClass {
+        static test = 'test';
+    }
+    const valueInstance = new Value(MyClass);
+    const result = valueInstance.toString();
+    // Результат: новый экземпляр класса Value с значением 'class MyClass {}'
+    ```
+
+11. Преобразование экземпляра класса:
+
+    ```js
+    class MyClass {}
+    const instance = new MyClass();
+    const valueInstance = new Value(instance);
+    const result = valueInstance.toString();
+    // Результат: новый экземпляр класса Value с значением 'object MyClass'
+    ```
+

package/docs/classes/Value.md

@@ -0,0 +1,113 @@
+[Главная](../../README.md) / [Классы](../classes.md) / Value
+
+[Исходный код](../../src/classes/Value.mjs)
+
+# Value
+
+`Value` — Класс, представляющий обертку для значений различных типов и предоставляющий методы
+для работы с ними.
+
+## Сигнатура класса
+
+```ts
+class Value {
+    constructor(value: any);
+    get(): any;
+    getType(): string;
+    setType(type: string): Value;
+    isEmpty(): boolean;
+    print(): Value;
+    toPrint(): Value;
+    printType(): Value;
+    toPrintType(): Value;
+    isArray(): boolean;
+    isAssoc(): boolean;
+    isBigInt(): boolean;
+    isBool(): boolean;
+    isBoolean(): boolean;
+    isClass(): boolean;
+    isFloat(): boolean;
+    isFunction(): boolean;
+    isInfinity(): boolean;
+    isInt(): boolean;
+    isInteger(): boolean;
+    isList(): boolean;
+    isNaN(): boolean;
+    isNull(): boolean;
+    isNumber(): boolean;
+    isNumeric(): boolean;
+    isObject(): boolean;
+    isScalar(): boolean;
+    isString(): boolean;
+    isSymbol(): boolean;
+    isUndefined(): boolean;
+    toArray(): Value;
+    toAssoc(): Value;
+    toBool(): Value;
+    toBoolean(): Value;
+    toFloat(): Value;
+    toInt(): Value;
+    toInteger(): Value;
+    toList(): Value;
+    toObject(): Value;
+    toString(): Value;
+}
+```
+
+## Описание
+
+Класс `Value` используется для хранения значения и предоставления методов для работы с этим
+значением. Значение хранится в приватном свойстве `#value` и не может быть изменено после создания
+экземпляра класса. Класс также предоставляет методы для получения типа значения, проверки значения
+на пустоту, преобразования значения в другие типы и другие операции.
+
+### Методы
+
+- [constructor](#constructor) — Создает экземпляр класса `Value` с заданным значением.
+- [get](#get) — Возвращает значение, хранящееся в экземпляре класса `Value`.
+- [getType](#getType) — Возвращает тип значения, хранящегося в экземпляре класса `Value`.
+- [setType](#setType) — Преобразует значение в экземпляре класса `Value` к указанному типу.
+- [isEmpty](#isEmpty) — Проверяет, является ли значение, хранящееся в экземпляре класса
+  `Value`, пустым.
+- [print](#print) — Преобразует значение переменной в строку и выводит его на консоль.
+- [toPrint](#toPrint) — Преобразует значение переменной в строку и возвращает новый экземпляр
+  класса `Value` с этим значением.
+- [printType](#printType) — Преобразует тип значения переменной в строку и выводит его на
+  консоль.
+- [toPrintType](#toPrintType) — Преобразует тип значения переменной в строку и возвращает
+  новый экземпляр класса `Value` с этим значением.
+- [isArray](#isArray) — Проверяет, является ли значение массивом.
+- [isAssoc](#isAssoc) — Проверяет, является ли значение ассоциативным массивом.
+- [isBigInt](#isBigInt) — Проверяет, является ли значение типом BigInt.
+- [isBool](#isBool) — Проверяет, является ли значение логическим (булевым).
+- [isBoolean](#isBoolean) — Проверяет, является ли значение логическим (булевым).
+- [isClass](#isClass) — Проверяет, является ли значение классом.
+- [isFloat](#isFloat) — Проверяет, является ли значение числом с плавающей точкой.
+- [isFunction](#isFunction) — Проверяет, является ли значение функцией.
+- [isInfinity](#isInfinity) — Проверяет, является ли значение бесконечностью.
+- [isInt](#isInt) — Проверяет, является ли значение целым числом.
+- [isInteger](#isInteger) — Проверяет, является ли значение целым числом.
+- [isList](#isList) — Проверяет, является ли значение списком.
+- [isNaN](#isNaN) — Проверяет, является ли значение NaN.
+- [isNull](#isNull) — Проверяет, является ли значение null.
+- [isNumber](#isNumber) — Проверяет, является ли значение числом.
+- [isNumeric](#isNumeric) — Проверяет, является ли значение числом или числовой строкой.
+- [isObject](#isObject) — Проверяет, является ли значение объектом.
+- [isScalar](#isScalar) — Проверяет, является ли значение скалярным.
+- [isString](#isString) — Проверяет, является ли значение строкой.
+- [isSymbol](#isSymbol) — Проверяет, является ли значение символом.
+- [isUndefined](#isUndefined) — Проверяет, является ли значение undefined.
+- [toArray](#toArray) — Преобразует значение в экземпляре класса `Value` к массиву.
+- [toAssoc](#toAssoc) — Преобразует значение в экземпляре класса `Value` к ассоциативному
+  массиву.
+- [toBool](#toBool) — Преобразует значение в экземпляре класса `Value` к логическому типу.
+- [toBoolean](#toBoolean) — Преобразует значение в экземпляре класса `Value` к логическому
+  типу.
+- [toFloat](#toFloat) — Преобразует значение в экземпляре класса `Value` к числу с плавающей
+  точкой.
+- [toInt](#toInt) — Преобразует значение в экземпляре класса `Value` к целому числу.
+- [toInteger](#toInteger) — Преобразует значение в экземпляре класса `Value` к целому числу.
+- [toList](#toList) — Преобразует значение в экземпляре класса `Value` к списку.
+- [toObject](#toObject) — Преобразует значение в экземпляре класса `Value` к объекту.
+- [toString](#toString) — Преобразует значение в экземпляре класса `Value` к строке.
+

package/docs/classes.md

@@ -6,4 +6,6 @@
   типов данных в JavaScript.
 - [Type](./classes/Type.md) — Класс, предоставляющий методы для проверки типов данных в
   JavaScript.
+- [Value](./classes/Value.md) — Класс, представляющий обертку для значений различных типов и
+  предоставляющий методы для работы с ними.