@rogolev/value 0.0.1

package/docs/helpers/print_type.md

@@ -0,0 +1,225 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / print_type
+
+[Исходный код](../../src/helpers/print_type.mjs)
+
+# `print_type`
+
+`print_type` — Преобразует значение в строку с указанием типа и выводит его на консоль.
+
+## Сигнатура функции
+
+```ts
+function print_type(value: any, return_result: boolean = false): string | undefined;
+```
+
+## Описание
+
+Функция `print_type` используется для преобразования различных типов данных в строку с указанием
+типа и вывода их на консоль. Она обрабатывает массивы, объекты, классы, функции, символы и другие
+типы данных, возвращая их строковое представление с указанием типа.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо преобразовать в строку с указанием типа и вывести на консоль.
+
+- `return_result` (boolean)
+
+    Если `true`, функция возвращает строковое представление значения переменной. Если `false`,
+    функция выводит строковое представление значения переменной на консоль.
+
+## Возвращаемое значение
+
+Функция возвращает:
+
+- Строковое представление значения переменной с указанием типа, если параметр `return_result` равен
+  `true`. В противном случае возвращает `undefined`.
+
+## Примеры использования
+
+### Пример 1: Преобразование строки
+
+```js
+print_type('example');
+```
+
+Вывод:
+
+```txt
+string(7) "example"
+```
+
+### Пример 2: Преобразование числа
+
+```js
+print_type(123);
+```
+
+Вывод:
+
+```txt
+int(123)
+```
+
+```js
+print_type(123.45);
+```
+
+Вывод:
+
+```txt
+float(123.45)
+```
+
+### Пример 3: Преобразование булевых значений
+
+```js
+print_type(true);
+```
+
+Вывод:
+
+```txt
+bool(true)
+```
+
+```js
+print_type(false);
+```
+
+Вывод:
+
+```txt
+bool(false)
+```
+
+### Пример 4: Преобразование null и undefined
+
+```js
+print_type(null);
+```
+
+Вывод:
+
+```txt
+null
+```
+
+```js
+print_type(undefined);
+```
+
+Вывод:
+
+```txt
+undefined
+```
+
+### Пример 5: Преобразование массива
+
+```js
+const arr = [1, 2, 3];
+print_type(arr);
+```
+
+Вывод:
+
+```txt
+array(3) [
+    0: int(1),
+    1: array(1) [
+        0: int(2),
+    ],
+    2: int(3),
+]
+```
+
+### Пример 6: Преобразование ассоциативного массива
+
+```js
+const obj = { key: 'value' };
+print_type(obj);
+```
+
+Вывод:
+
+```txt
+array(1) {
+    key: string(5) "value",
+}
+```
+
+### Пример 7: Преобразование функции
+
+```js
+const func = function () {};
+print_type(func);
+```
+
+Вывод:
+
+```txt
+function func() {}
+```
+
+### Пример 8: Преобразование символа
+
+```js
+const symbol = Symbol('example');
+print_type(symbol);
+```
+
+Вывод:
+
+```txt
+Symbol(example)
+```
+
+### Пример 9: Преобразование класса
+
+```js
+class MyClass {
+    static test = 'test';
+}
+print_type(MyClass);
+```
+
+Вывод:
+
+```txt
+class MyClass {
+    test = string(4) "test";
+}
+```
+
+### Пример 10: Преобразование экземпляра класса
+
+```js
+class MyClass {
+    test = 'test';
+}
+const instance = new MyClass();
+print_type(instance);
+```
+
+Вывод:
+
+```txt
+object(MyClass) (1) {
+    test: string(4) "test",
+}
+```
+
+### Пример 11: Преобразование интерфейса
+
+```js
+class MyContract extends Interface {}
+print_type(MyContract);
+```
+
+Вывод:
+
+```txt
+interface MyContract extends Interface {}
+```

package/docs/helpers/settype.md

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

package/docs/helpers/to_array.md

@@ -0,0 +1,106 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / to_array
+
+[Исходный код](../../src/helpers/to_array.mjs)
+
+# `to_array`
+
+`to_array` — Преобразует значение в массив.
+
+## Сигнатура функции
+
+```ts
+function to_array(value: any): Array<any> | Object;
+```
+
+## Описание
+
+Функция `to_array` используется для преобразования различных типов данных в массив. Если значение
+уже является массивом (тип `Array` или ассоциативный массив), возвращается оно же. Объекты
+(экземпляры классов) преобразуются в массив с одним элементом.
+
+### Примечание
+
+Функция `to_array` для объектов (ассоциативных массивов) возвращает результат работы функции
+[array](../array/array.md), которая создает объект-контейнер пар ключ-значение (ассоциативный
+массив) с помощью конструкции `Object.create(null)`, копирует все видимые пары в этот контейнер, а
+также добавляет итератор `Symbol.iterator` для перебора контейнера в цикле `for-of`.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо преобразовать в массив. Это может быть строка, число, объект или
+    другой массив.
+
+## Возвращаемое значение
+
+Функция возвращает:
+
+- Массив, содержащий переданное значение. Если значение уже является массивом, возвращается оно же.
+
+## Примеры использования
+
+### Пример 1: Преобразование строки в массив
+
+```js
+const result = to_array('example');
+// Результат: ["example"]
+```
+
+### Пример 2: Преобразование числа в массив
+
+```js
+const result = to_array(123);
+// Результат: [123]
+```
+
+### Пример 3: Преобразование массива (без изменений)
+
+```js
+const result = to_array([1, 2, 3]);
+// Результат: [1, 2, 3]
+```
+
+### Пример 4: Преобразование объекта в массив
+
+Функция `to_array` для объектов (ассоциативных массивов) возвращает результат работы функции
+[array](../array/array.md), которая создает объект-контейнер пар ключ-значение (ассоциативный
+массив) с помощью конструкции `Object.create(null)`, копирует все видимые пары в этот контейнер, а
+также добавляет итератор `Symbol.iterator` для перебора контейнера в цикле `for-of`.
+
+```js
+const result = to_array({ key: 'value' });
+// Результат: { key: "value" }
+
+const proto = Object.getPrototypeOf(result);
+// Результат: null
+
+for (const [key, value] of result) {
+    console.log(key, value);
+}
+// Результат: 'key', 'value'
+```
+
+### Пример 5: Преобразование экземпляра класса в массив
+
+```js
+class MyClass {}
+
+const instance = new MyClass();
+const result = to_array(instance);
+// Результат: [instance]
+```
+
+### Пример 6: Преобразование null
+
+```js
+const result = to_array(null);
+// Результат: []
+```
+
+### Пример 7: Преобразование undefined
+
+```js
+const result = to_array(undefined);
+// Результат: []
+```

package/docs/helpers/to_assoc.md

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

package/docs/helpers/to_bool.md

@@ -0,0 +1,76 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / to_bool
+
+[Исходный код](../../src/helpers/to_bool.mjs)
+
+# `to_bool`
+
+`to_bool` — Преобразует значение в логическое значение.
+
+## Сигнатура функции
+
+```ts
+function to_bool(value: any): boolean;
+```
+
+## Описание
+
+Функция `to_bool` используется для преобразования различных типов данных в логическое значение. Если
+значение является пустым массивом, функция возвращает `false`.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо преобразовать в логическое значение.
+
+## Возвращаемое значение
+
+Функция возвращает:
+
+- Логическое значение, соответствующее переданному значению.
+
+## Примеры использования
+
+### Пример 1: Преобразование пустого массива в `false`
+
+```js
+const result = to_bool([]);
+// Результат: false
+```
+
+### Пример 2: Преобразование пустого ассоциативного массива в `false`
+
+```js
+const result = to_bool({});
+// Результат: false
+```
+
+### Пример 3: Преобразование непустого массива в `true`
+
+```js
+const result = to_bool([1, 2, 3]);
+// Результат: true
+```
+
+### Пример 3: Преобразование непустого ассоциативного массива в `true`
+
+```js
+const result = to_bool({ key: 'value' });
+// Результат: true
+```
+
+### Пример 4: Преобразование других значений
+
+```js
+const result1 = to_bool('example');
+// Результат: true
+
+const result2 = to_bool(123);
+// Результат: true
+
+const result3 = to_bool(null);
+// Результат: false
+
+const result4 = to_bool(undefined);
+// Результат: false
+```

package/docs/helpers/to_boolean.md

@@ -0,0 +1,77 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / to_boolean
+
+[Исходный код](../../src/helpers/to_boolean.mjs)
+
+# `to_boolean`
+
+`to_boolean` — Преобразует значение в логическое значение.
+
+## Сигнатура функции
+
+```ts
+function to_boolean(value: any): boolean;
+```
+
+## Описание
+
+Функция `to_boolean` является синонимом функции `to_bool` и используется для преобразования
+различных типов данных в логическое значение. Если значение является пустым массивом, функция
+возвращает `false`.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо преобразовать в логическое значение.
+
+## Возвращаемое значение
+
+Функция возвращает:
+
+- Логическое значение, соответствующее переданному значению.
+
+## Примеры использования
+
+### Пример 1: Преобразование пустого массива в `false`
+
+```js
+const result = to_boolean([]);
+// Результат: false
+```
+
+### Пример 2: Преобразование пустого ассоциативного массива в `false`
+
+```js
+const result = to_boolean({});
+// Результат: false
+```
+
+### Пример 3: Преобразование непустого массива в `true`
+
+```js
+const result = to_boolean([1, 2, 3]);
+// Результат: true
+```
+
+### Пример 4: Преобразование непустого ассоциативного массива в `true`
+
+```js
+const result = to_boolean({ key: 'value' });
+// Результат: true
+```
+
+### Пример 5: Преобразование других значений
+
+```js
+const result1 = to_boolean('example');
+// Результат: true
+
+const result2 = to_boolean(123);
+// Результат: true
+
+const result3 = to_boolean(null);
+// Результат: false
+
+const result4 = to_boolean(undefined);
+// Результат: false
+```