@rogolev/value 0.0.1

package/docs/helpers/to_float.md

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

package/docs/helpers/to_int.md

@@ -0,0 +1,87 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / to_int
+
+[Исходный код](../../src/helpers/to_int.mjs)
+
+# `to_int`
+
+`to_int` — Преобразует значение в целое число.
+
+## Сигнатура функции
+
+```ts
+function to_int(value: any, base: number = 10): number;
+```
+
+## Описание
+
+Функция `to_int` используется для преобразования различных типов данных в целое число. Если значение
+не является числом или строкой, функция возвращает `1` для истинных значений и `0` для ложных
+значений.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо преобразовать в целое число.
+
+- `base` (number)
+
+    Основание системы счисления для преобразования строки в число. По умолчанию `10`.
+
+## Возвращаемое значение
+
+Функция возвращает:
+
+- Целое число, соответствующее переданному значению.
+
+## Примеры использования
+
+### Пример 1: Преобразование строки в целое число
+
+```js
+const result = to_int('123');
+// Результат: 123
+```
+
+### Пример 2: Преобразование числа с плавающей точкой в целое число
+
+```js
+const result = to_int(123.45);
+// Результат: 123
+```
+
+### Пример 3: Преобразование булевых значений
+
+```js
+const result1 = to_int(true);
+// Результат: 1
+
+const result2 = to_int(false);
+// Результат: 0
+```
+
+### Пример 4: Преобразование других значений
+
+```js
+const result1 = to_int(null);
+// Результат: 0
+
+const result2 = to_int(undefined);
+// Результат: 0
+
+const result3 = to_int('example');
+// Результат: 0
+```
+
+### Пример 5: Преобразование строки с основанием системы счисления
+
+```js
+const result1 = to_int('10', 2);
+// Результат: 2
+
+const result2 = to_int('A', 16);
+// Результат: 10
+
+const result3 = to_int('7', 8);
+// Результат: 7
+```

package/docs/helpers/to_integer.md

@@ -0,0 +1,87 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / to_integer
+
+[Исходный код](../../src/helpers/to_integer.mjs)
+
+# `to_integer`
+
+`to_integer` — Преобразует значение в целое число.
+
+## Сигнатура функции
+
+```ts
+function to_integer(value: any, base: number = 10): number;
+```
+
+## Описание
+
+Функция `to_integer` является синонимом функции `to_int` и используется для преобразования различных
+типов данных в целое число. Если значение не является числом или строкой, функция возвращает `1` для
+истинных значений и `0` для ложных значений.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо преобразовать в целое число.
+
+- `base` (number)
+
+    Основание системы счисления для преобразования строки в число. По умолчанию `10`.
+
+## Возвращаемое значение
+
+Функция возвращает:
+
+- Целое число, соответствующее переданному значению.
+
+## Примеры использования
+
+### Пример 1: Преобразование строки в целое число
+
+```js
+const result = to_integer('123');
+// Результат: 123
+```
+
+### Пример 2: Преобразование числа с плавающей точкой в целое число
+
+```js
+const result = to_integer(123.45);
+// Результат: 123
+```
+
+### Пример 3: Преобразование булевых значений
+
+```js
+const result1 = to_integer(true);
+// Результат: 1
+
+const result2 = to_integer(false);
+// Результат: 0
+```
+
+### Пример 4: Преобразование других значений
+
+```js
+const result1 = to_integer(null);
+// Результат: 0
+
+const result2 = to_integer(undefined);
+// Результат: 0
+
+const result3 = to_integer('example');
+// Результат: 0
+```
+
+### Пример 5: Преобразование строки с основанием системы счисления
+
+```js
+const result1 = to_integer('10', 2);
+// Результат: 2
+
+const result2 = to_integer('A', 16);
+// Результат: 10
+
+const result3 = to_integer('7', 8);
+// Результат: 7
+```

package/docs/helpers/to_list.md

@@ -0,0 +1,47 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / to_list
+
+[Исходный код](../../src/helpers/to_list.mjs)
+
+# `to_list`
+
+`to_list` — Преобразует значение в список.
+
+## Сигнатура функции
+
+```ts
+function to_list(value: any): Array<any>;
+```
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо преобразовать в список.
+
+## Описание
+
+Функция `to_list` предназначена для преобразования переданного значения в список.
+
+Она выполняет следующие проверки:
+
+1. **Null и Undefined**: Возвращает пустой массив для значений `null` и `undefined`.
+2. **Array**: Возвращает исходный массив, если он передан.
+3. **Object**: Возвращает массив значений объекта, если передан ассоциативный массив.
+4. **Примитивы и другие типы**: Возвращает массив, содержащий переданное значение.
+
+## Возвращаемое значение
+
+Функция возвращает массив, представляющий список значений.
+
+## Примеры использования
+
+### Пример 1: Преобразование различных типов значений в список
+
+```js
+to_list(null); // []
+to_list(undefined); // []
+to_list([1, 2, 3]); // [1, 2, 3]
+to_list({ key: 'value' }); // ['value']
+to_list('example'); // ['example']
+to_list(123); // [123]
+```

package/docs/helpers/to_object.md

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

package/docs/helpers/to_string.md

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

package/docs/helpers.md

@@ -0,0 +1,51 @@
+[Главная](../README.md) / Помощники
+
+# Помощники для работы с типами данных
+
+- [array](./helpers/array.md) — Создаёт массив из переданных значений, обрабатывая
+  ассоциативные массивы (объекты с ключами).
+- [empty](./helpers/empty.md) — Проверяет, является ли переменная пустой.
+- [gettype](./helpers/gettype.md) — Определяет тип переданного значения.
+- [is_array](./helpers/is_array.md) — Проверяет, является ли переданное значение массивом или
+  ассоциативным массивом (объектом с ключами и значениями).
+- [is_assoc](./helpers/is_assoc.md) — Проверяет, является ли значение ассоциативным массивом.
+- [is_bigint](./helpers/is_bigint.md) — Проверяет, является ли значение типом `bigint`.
+- [is_bool](./helpers/is_bool.md) — Проверяет, является ли переданное значение логическим
+  типом (`boolean`).
+- [is_boolean](./helpers/is_boolean.md) — Проверяет, является ли переданное значение
+  логическим типом (`boolean`).
+- [is_class](./helpers/is_class.md) — Проверяет, является ли переданная переменная классом.
+- [is_float](./helpers/is_float.md) — Проверяет, является ли значение числом с плавающей
+  точкой.
+- [is_function](./helpers/is_function.md) — Проверяет, что значение является функцией,
+  исключая классы.
+- [is_infinity](./helpers/is_infinity.md) — Проверяет, является ли значение бесконечностью
+  (Infinity или -Infinity).
+- [is_int](./helpers/is_int.md) — Проверяет, является ли значение целым числом.
+- [is_integer](./helpers/is_integer.md) — Проверяет, является ли значение целым числом.
+- [is_list](./helpers/is_list.md) — Проверяет, является ли значение списком.
+- [is_nan](./helpers/is_nan.md) — Проверяет, является ли значение NaN.
+- [is_null](./helpers/is_null.md) — Проверяет, является ли значение `null`.
+- [is_number](./helpers/is_number.md) — Проверяет, является ли значение числом.
+- [is_numeric](./helpers/is_numeric.md) — Проверяет, является ли значение числом или числовой
+  строкой.
+- [is_object](./helpers/is_object.md) — Проверяет, является ли переданная переменная объектом,
+  созданным с использованием класса.
+- [is_scalar](./helpers/is_scalar.md) — Проверяет, является ли значение скалярным.
+- [is_string](./helpers/is_string.md) — Проверяет, является ли значение строкой.
+- [is_symbol](./helpers/is_symbol.md) — Проверяет, является ли значение символом.
+- [is_undefined](./helpers/is_undefined.md) — Проверяет, является ли значение `undefined`.
+- [print](./helpers/print.md) — Преобразует значение в строку и выводит его на консоль.
+- [print_type](./helpers/print_type.md) — Преобразует значение в строку с указанием типа и
+  выводит его на консоль.
+- [settype](./helpers/settype.md) — Преобразует значение в указанный тип.
+- [to_array](./helpers/to_array.md) — Преобразует значение в массив.
+- [to_assoc](./helpers/to_assoc.md) — Преобразует значение в ассоциативный массив.
+- [to_bool](./helpers/to_bool.md) — Преобразует значение в логическое значение.
+- [to_boolean](./helpers/to_bool.md) — Преобразует значение в логическое значение.
+- [to_float](./helpers/to_float.md) — Преобразует значение в число с плавающей точкой.
+- [to_int](./helpers/to_int.md) — Преобразует значение в целое число.
+- [to_integer](./helpers/to_integer.md) — Преобразует значение в целое число.
+- [to_list](./helpers/to_list.md) — Преобразует значение в список.
+- [to_object](./helpers/to_object.md) — Преобразует значение в объект.
+- [to_string](./helpers/to_string.md) — Преобразует значение в строку.

package/docs/types/NaN.md

@@ -0,0 +1,30 @@
+[Главная](../../README.md) / [Типы данных](../types.md) / Не число
+
+# Не число
+
+## Не число в JavaScript
+
+Глобальное свойство **NaN** является значением, представляющим не-число (Not-A-Number).
+
+Значение `NaN` имеет тип `number`.
+
+```js
+typeof NaN; // "number"
+```
+
+[Подробнее...](https://developer.mozilla.org/ru/docs/Web/JavaScript/Reference/Global_Objects/NaN)
+
+## Не число в value.js
+
+Библиотека не вносит ни каких изменений в определение не числа, а лишь выделяет значение `NaN` в
+отдельный тип `NaN`.
+
+### Проверка типа
+
+Проверить, является ли значение не числом, можно с помощью функции [is_nan](../helpers/is_nan.md).
+
+```js
+is_nan(NaN); // true
+
+gettype(NaN); // "NaN"
+```