@rogolev/value 0.0.2 → 0.0.3

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# v0.0.3
+
+## Добавлено
+
+### Классы для работы с типами
+
+- [Value](./docs/classes/Value.md) — Класс, представляющий обертку для значений различных
+  типов и предоставляющий методы для работы с ними.
+
+### Помощники для работы с типами данных
+
+- [value](./docs/helpers/value.md) — Создает новый экземпляр класса `Value` с заданным
+  значением.
+
 # v0.0.2
 
 ## Добавлено

package/README.md

@@ -12,7 +12,7 @@
 
 ## Установка
 
-```
+```sh
 npm install @rogolev/value
 ```
 
@@ -28,6 +28,7 @@ import {
     is_int,
     is_float,
     gettype,
+    value,
 } from '@rogolev/value.js';
 
 // Создаем ассоциативный массив - контейнер пар ключ-значение
@@ -84,6 +85,23 @@ console.log(is_float(3.14)); // true
 
 // Получение типа
 console.log(gettype(stdClass)); // "class"
+
+// Использование функции value для создания экземпляра класса Value
+const valInstance = value(123);
+console.log(valInstance.get()); // 123
+console.log(valInstance.getType()); // 'integer'
+console.log(valInstance.isNumber()); // true
+
+// Преобразование значения в строку и вывод на консоль
+valInstance.print(); // 123
+
+// Преобразование значения в массив
+const arrayInstance = valInstance.toArray();
+console.log(arrayInstance.get()); // [123]
+
+// Преобразование значения в объект
+const objectInstance = valInstance.toObject();
+console.log(objectInstance.get()); // { value: 123 }
 ```
 
 ## Автор

package/docs/classes/Value/constructor.md

@@ -0,0 +1,48 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / constructor
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.constructor
+
+`Value.constructor` — Создает экземпляр класса `Value` с заданным значением.
+
+## Сигнатура метода
+
+```ts
+constructor(value: any);
+```
+
+## Описание
+
+Конструктор класса `Value` принимает значение и сохраняет его в приватном свойстве `#value`.
+Значение не может быть изменено после создания экземпляра класса.
+
+## Параметры
+
+- `value` (any): Значение, которое необходимо сохранить в экземпляре класса `Value`.
+
+## Примеры использования
+
+1. Создание экземпляра класса `Value` с числом:
+
+    ```js
+    const valueInstance = new Value(123);
+    // Свойство: #value = 123
+    ```
+
+2. Создание экземпляра класса `Value` с объектом:
+
+    ```js
+    const obj = { key: 'value' };
+    const valueInstance = new Value(obj);
+    // Свойство: #value = { key: 'value' }
+    ```
+
+3. Создание экземпляра класса `Value` с массивом:
+
+    ```js
+    const arr = [1, 2, 3];
+    const valueInstance = new Value(arr);
+    // Свойство: #value = [1, 2, 3]
+    ```
+

package/docs/classes/Value/get.md

@@ -0,0 +1,51 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / get
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.get
+
+`Value.get` — Возвращает значение, хранящееся в экземпляре класса `Value`.
+
+## Сигнатура метода
+
+```ts
+get(): any;
+```
+
+## Описание
+
+Метод `get` используется для получения значения, переданного при создании экземпляра класса `Value`.
+Это значение хранится в свойстве `#value` экземпляра и не может быть изменено после создания.
+
+## Возвращаемое значение
+
+Возвращает значение, переданное при создании экземпляра класса `Value`.
+
+## Примеры использования
+
+1. Создание экземпляра класса `Value` и получение значения:
+
+    ```js
+    const valueInstance = new Value(123);
+    const result = valueInstance.get();
+    // Результат: 123
+    ```
+
+2. Создание экземпляра класса `Value` с объектом:
+
+    ```js
+    const obj = { key: 'value' };
+    const valueInstance = new Value(obj);
+    const result = valueInstance.get();
+    // Результат: { key: 'value' }
+    ```
+
+3. Создание экземпляра класса `Value` с массивом:
+
+    ```js
+    const arr = [1, 2, 3];
+    const valueInstance = new Value(arr);
+    const result = valueInstance.get();
+    // Результат: [1, 2, 3]
+    ```
+

package/docs/classes/Value/getType.md

@@ -0,0 +1,71 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / getType
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.getType
+
+`Value.getType` — Возвращает тип значения, хранящегося в экземпляре класса `Value`.
+
+## Сигнатура метода
+
+```ts
+getType(): string;
+```
+
+## Описание
+
+Метод `getType` используется для получения типа значения, переданного при создании экземпляра класса
+`Value`. Тип значения определяется с помощью функции `gettype`, которая выполняет различные проверки
+для определения типа.
+
+Функция `gettype` выполняет следующие проверки:
+
+1. **Null**: Проверяет, является ли значение `null`.
+2. **NaN**: Проверяет, является ли значение `NaN`.
+3. **Undefined**: Проверяет, является ли значение `undefined`.
+4. **Infinity**: Проверяет, является ли значение бесконечностью.
+5. **Boolean**: Проверяет, является ли значение логическим.
+6. **Integer**: Проверяет, является ли значение целым числом.
+7. **BigInt**: Проверяет, является ли значение типом BigInt.
+8. **Float**: Проверяет, является ли значение числом с плавающей точкой.
+9. **String**: Проверяет, является ли значение строкой.
+10. **Symbol**: Проверяет, является ли значение символом.
+11. **Class**: Проверяет, является ли значение классом.
+12. **Function**: Проверяет, является ли значение функцией.
+13. **Array**: Проверяет, является ли значение массивом.
+14. **Object**: Проверяет, является ли значение объектом.
+
+Если значение не соответствует ни одному из этих типов, функция возвращает результат `typeof value`.
+
+## Возвращаемое значение
+
+Возвращает строку, представляющую тип значения, хранящегося в экземпляре класса `Value`.
+
+## Примеры использования
+
+1. Создание экземпляра класса `Value` и получение типа значения:
+
+    ```js
+    const valueInstance = new Value(123);
+    const result = valueInstance.getType();
+    // Результат: 'integer'
+    ```
+
+2. Создание экземпляра класса `Value` с объектом:
+
+    ```js
+    const obj = { key: 'value' };
+    const valueInstance = new Value(obj);
+    const result = valueInstance.getType();
+    // Результат: 'object'
+    ```
+
+3. Создание экземпляра класса `Value` с массивом:
+
+    ```js
+    const arr = [1, 2, 3];
+    const valueInstance = new Value(arr);
+    const result = valueInstance.getType();
+    // Результат: 'array'
+    ```
+

package/docs/classes/Value/isArray.md

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

package/docs/classes/Value/isAssoc.md

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

package/docs/classes/Value/isBigInt.md

@@ -0,0 +1,52 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isBigInt
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isBigInt
+
+`Value.isBigInt` — Проверяет, является ли значение типом BigInt.
+
+## Сигнатура метода
+
+```ts
+isBigInt(): boolean;
+```
+
+## Описание
+
+Метод `isBigInt` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, типом BigInt. BigInt - это встроенный тип данных в JavaScript, который используется для
+представления целых чисел произвольной длины.
+
+Метод использует функцию `is_bigint` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является типом BigInt, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка значения типа BigInt:
+
+    ```js
+    const valueInstance = new Value(123n);
+    const result = valueInstance.isBigInt();
+    // Результат: true
+    ```
+
+2. Проверка значения типа Number:
+
+    ```js
+    const valueInstance = new Value(123);
+    const result = valueInstance.isBigInt();
+    // Результат: false
+    ```
+
+3. Проверка строки:
+
+    ```js
+    const valueInstance = new Value('123');
+    const result = valueInstance.isBigInt();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isBool.md

@@ -0,0 +1,60 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isBool
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isBool
+
+`Value.isBool` — Проверяет, является ли значение логическим (булевым).
+
+## Сигнатура метода
+
+```ts
+isBool(): boolean;
+```
+
+## Описание
+
+Метод `isBool` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, логическим (булевым). Логическим значением считается значение, которое является `true` или
+`false`.
+
+Метод использует функцию `is_bool` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является логическим, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка значения `true`:
+
+    ```js
+    const valueInstance = new Value(true);
+    const result = valueInstance.isBool();
+    // Результат: true
+    ```
+
+2. Проверка значения `false`:
+
+    ```js
+    const valueInstance = new Value(false);
+    const result = valueInstance.isBool();
+    // Результат: true
+    ```
+
+3. Проверка строки:
+
+    ```js
+    const valueInstance = new Value('true');
+    const result = valueInstance.isBool();
+    // Результат: false
+    ```
+
+4. Проверка числа:
+
+    ```js
+    const valueInstance = new Value(1);
+    const result = valueInstance.isBool();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isBoolean.md

@@ -0,0 +1,60 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isBoolean
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isBoolean
+
+`Value.isBoolean` — Проверяет, является ли значение логическим (булевым).
+
+## Сигнатура метода
+
+```ts
+isBoolean(): boolean;
+```
+
+## Описание
+
+Метод `isBoolean` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, логическим (булевым). Логическим значением считается значение, которое является `true` или
+`false`.
+
+Метод использует функцию `is_bool` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является логическим, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка значения `true`:
+
+    ```js
+    const valueInstance = new Value(true);
+    const result = valueInstance.isBoolean();
+    // Результат: true
+    ```
+
+2. Проверка значения `false`:
+
+    ```js
+    const valueInstance = new Value(false);
+    const result = valueInstance.isBoolean();
+    // Результат: true
+    ```
+
+3. Проверка строки:
+
+    ```js
+    const valueInstance = new Value('true');
+    const result = valueInstance.isBoolean();
+    // Результат: false
+    ```
+
+4. Проверка числа:
+
+    ```js
+    const valueInstance = new Value(1);
+    const result = valueInstance.isBoolean();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isClass.md

@@ -0,0 +1,55 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Value](../Value.md) / isClass
+
+[Исходный код](../../../src/classes/Value.mjs)
+
+# Value.isClass
+
+`Value.isClass` — Проверяет, является ли значение классом.
+
+## Сигнатура метода
+
+```ts
+isClass(): boolean;
+```
+
+## Описание
+
+Метод `isClass` используется для проверки, является ли значение, хранящееся в экземпляре класса
+`Value`, классом. Классом считается значение, которое является функцией и имеет свойство
+`prototype`, являющееся объектом.
+
+Метод использует функцию `is_class` для выполнения проверки.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является классом, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка класса:
+
+    ```js
+    class MyClass {}
+    const valueInstance = new Value(MyClass);
+    const result = valueInstance.isClass();
+    // Результат: true
+    ```
+
+2. Проверка функции:
+
+    ```js
+    const myFunction = function () {};
+    const valueInstance = new Value(myFunction);
+    const result = valueInstance.isClass();
+    // Результат: false
+    ```
+
+3. Проверка объекта:
+
+    ```js
+    const myObject = {};
+    const valueInstance = new Value(myObject);
+    const result = valueInstance.isClass();
+    // Результат: false
+    ```
+

package/docs/classes/Value/isEmpty.md

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