@rogolev/value 0.0.1 → 0.0.3

package/docs/classes/Value/toInteger.md

@@ -0,0 +1,72 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / toInteger
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.toInteger
+
+`Value.toInteger` — Преобразует значение в экземпляре класса `Value` к целому числу.
+
+## Сигнатура метода
+
+```ts
+toInteger(): Value;
+```
+
+## Описание
+
+Метод `toInteger` используется для преобразования значения, хранящегося в экземпляре класса `Value`,
+в целое число. Если значение не является числом или строкой, метод возвращает `1` для истинных
+значений и `0` для ложных значений.
+
+Метод использует функцию `to_int` для выполнения преобразования.
+
+## Возвращаемое значение
+
+Возвращает новый экземпляр класса `Value` с преобразованным значением.
+
+## Примеры использования
+
+1. Преобразование строки в целое число:
+
+    ```js
+    const valueInstance = new Value('123');
+    const result = valueInstance.toInteger();
+    // Результат: новый экземпляр класса Value с значением 123
+    ```
+
+2. Преобразование числа с плавающей точкой в целое число:
+
+    ```js
+    const valueInstance = new Value(123.45);
+    const result = valueInstance.toInteger();
+    // Результат: новый экземпляр класса Value с значением 123
+    ```
+
+3. Преобразование булевых значений:
+
+    ```js
+    const valueInstance1 = new Value(true);
+    const result1 = valueInstance1.toInteger();
+    // Результат: новый экземпляр класса Value с значением 1
+
+    const valueInstance2 = new Value(false);
+    const result2 = valueInstance2.toInteger();
+    // Результат: новый экземпляр класса Value с значением 0
+    ```
+
+4. Преобразование других значений:
+
+    ```js
+    const valueInstance1 = new Value(null);
+    const result1 = valueInstance1.toInteger();
+    // Результат: новый экземпляр класса Value с значением 0
+
+    const valueInstance2 = new Value(undefined);
+    const result2 = valueInstance2.toInteger();
+    // Результат: новый экземпляр класса Value с значением 0
+
+    const valueInstance3 = new Value('example');
+    const result3 = valueInstance3.toInteger();
+    // Результат: новый экземпляр класса Value с значением 0
+    ```
+

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'
+    ```
+