@rogolev/value 0.0.1 → 0.0.3

package/docs/classes/Value/printType.md

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

package/docs/classes/Value/setType.md

@@ -0,0 +1,79 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / setType
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.setType
+
+`Value.setType` — Преобразует значение в экземпляре класса `Value` к указанному типу.
+
+## Сигнатура метода
+
+```ts
+setType(type: string): Value;
+```
+
+## Описание
+
+Метод `setType` используется для преобразования значения, хранящегося в экземпляре класса `Value`, к
+указанному типу. Поддерживаются типы: `boolean`, `integer`, `float`, `string`, `array`, `object`.
+
+Метод использует функцию `settype` для выполнения преобразования.
+
+## Параметры
+
+- `type` (string): Тип, к которому необходимо привести значение.
+
+## Возвращаемое значение
+
+Возвращает новый экземпляр класса `Value` с преобразованным значением.
+
+## Примеры использования
+
+1. Преобразование в булевое значение:
+
+    ```js
+    const valueInstance = new Value('true');
+    const result = valueInstance.setType('boolean');
+    // Результат: новый экземпляр класса Value с значением true
+    ```
+
+2. Преобразование в целое число:
+
+    ```js
+    const valueInstance = new Value('123');
+    const result = valueInstance.setType('integer');
+    // Результат: новый экземпляр класса Value с значением 123
+    ```
+
+3. Преобразование в число с плавающей точкой:
+
+    ```js
+    const valueInstance = new Value('123.45');
+    const result = valueInstance.setType('float');
+    // Результат: новый экземпляр класса Value с значением 123.45
+    ```
+
+4. Преобразование в строку:
+
+    ```js
+    const valueInstance = new Value(123);
+    const result = valueInstance.setType('string');
+    // Результат: новый экземпляр класса Value с значением '123'
+    ```
+
+5. Преобразование в массив:
+
+    ```js
+    const valueInstance = new Value('example');
+    const result = valueInstance.setType('array');
+    // Результат: новый экземпляр класса Value с значением ['example']
+    ```
+
+6. Преобразование в объект:
+
+    ```js
+    const valueInstance = new Value('example');
+    const result = valueInstance.setType('object');
+    // Результат: новый экземпляр класса Value с значением { value: 'example' }
+    ```
+

package/docs/classes/Value/toArray.md

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

package/docs/classes/Value/toAssoc.md

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

package/docs/classes/Value/toBool.md

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

package/docs/classes/Value/toBoolean.md

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

package/docs/classes/Value/toFloat.md

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

package/docs/classes/Value/toInt.md

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