@rogolev/value 0.0.1 → 0.0.3

package/docs/helpers/to_list.md

@@ -1,47 +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]
-```
+[Главная](../../README.md) / [Помощники](../helpers.md) / to_list
+
+[Исходный код](../../src/helpers/to_list.mjs)
+
+# `to_list`
+
+`to_list` &mdash; Преобразует значение в список.
+
+## Сигнатура функции
+
+```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

@@ -1,76 +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'
-```
+[Главная](../../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

@@ -1,134 +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 {}'
-```
+[Главная](../../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/value.md

@@ -0,0 +1,95 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / value
+
+[Исходный код](../../src/helpers/value.mjs)
+
+# value
+
+`value` — Создает новый экземпляр класса `Value` с заданным значением.
+
+## Сигнатура функции
+
+```ts
+value(val: any): Value;
+```
+
+## Описание
+
+Функция `value` используется для создания нового экземпляра класса `Value` с переданным значением.
+Это позволяет легко обернуть значение в экземпляр класса `Value` и использовать методы класса для
+работы с этим значением.
+
+## Параметры
+
+- `val` (any): Значение, которое необходимо обернуть в экземпляр класса `Value`.
+
+## Возвращаемое значение
+
+Возвращает новый экземпляр класса `Value` с переданным значением.
+
+## Примеры использования
+
+1. Создание экземпляра класса `Value` с числом:
+
+    ```js
+    const valueInstance = value(123);
+    console.log(valueInstance.get()); // 123
+    console.log(valueInstance.getType()); // 'integer'
+    console.log(valueInstance.isNumber()); // true
+    ```
+
+2. Создание экземпляра класса `Value` со строкой:
+
+    ```js
+    const valueInstance = value('example');
+    console.log(valueInstance.get()); // 'example'
+    console.log(valueInstance.getType()); // 'string'
+    console.log(valueInstance.isString()); // true
+    ```
+
+3. Создание экземпляра класса `Value` с объектом:
+
+    ```js
+    const obj = { key: 'value' };
+    const valueInstance = value(obj);
+    console.log(valueInstance.get()); // { key: 'value' }
+    console.log(valueInstance.getType()); // 'object'
+    console.log(valueInstance.isObject()); // true
+    ```
+
+4. Создание экземпляра класса `Value` с массивом:
+
+    ```js
+    const arr = [1, 2, 3];
+    const valueInstance = value(arr);
+    console.log(valueInstance.get()); // [1, 2, 3]
+    console.log(valueInstance.getType()); // 'array'
+    console.log(valueInstance.isArray()); // true
+    ```
+
+5. Создание экземпляра класса `Value` с булевым значением:
+
+    ```js
+    const valueInstance = value(true);
+    console.log(valueInstance.get()); // true
+    console.log(valueInstance.getType()); // 'boolean'
+    console.log(valueInstance.isBool()); // true
+    ```
+
+6. Создание экземпляра класса `Value` с null:
+
+    ```js
+    const valueInstance = value(null);
+    console.log(valueInstance.get()); // null
+    console.log(valueInstance.getType()); // 'null'
+    console.log(valueInstance.isNull()); // true
+    ```
+
+7. Создание экземпляра класса `Value` с undefined:
+
+    ```js
+    const valueInstance = value(undefined);
+    console.log(valueInstance.get()); // undefined
+    console.log(valueInstance.getType()); // 'undefined'
+    console.log(valueInstance.isUndefined()); // true
+    ```
+