@rogolev/value 0.0.1 → 0.0.3

package/docs/classes/Value.md

@@ -0,0 +1,113 @@
+[Главная](../../README.md) / [Классы](../classes.md) / Value
+
+[Исходный код](../../src/classes/Value.mjs)
+
+# Value
+
+`Value` — Класс, представляющий обертку для значений различных типов и предоставляющий методы
+для работы с ними.
+
+## Сигнатура класса
+
+```ts
+class Value {
+    constructor(value: any);
+    get(): any;
+    getType(): string;
+    setType(type: string): Value;
+    isEmpty(): boolean;
+    print(): Value;
+    toPrint(): Value;
+    printType(): Value;
+    toPrintType(): Value;
+    isArray(): boolean;
+    isAssoc(): boolean;
+    isBigInt(): boolean;
+    isBool(): boolean;
+    isBoolean(): boolean;
+    isClass(): boolean;
+    isFloat(): boolean;
+    isFunction(): boolean;
+    isInfinity(): boolean;
+    isInt(): boolean;
+    isInteger(): boolean;
+    isList(): boolean;
+    isNaN(): boolean;
+    isNull(): boolean;
+    isNumber(): boolean;
+    isNumeric(): boolean;
+    isObject(): boolean;
+    isScalar(): boolean;
+    isString(): boolean;
+    isSymbol(): boolean;
+    isUndefined(): boolean;
+    toArray(): Value;
+    toAssoc(): Value;
+    toBool(): Value;
+    toBoolean(): Value;
+    toFloat(): Value;
+    toInt(): Value;
+    toInteger(): Value;
+    toList(): Value;
+    toObject(): Value;
+    toString(): Value;
+}
+```
+
+## Описание
+
+Класс `Value` используется для хранения значения и предоставления методов для работы с этим
+значением. Значение хранится в приватном свойстве `#value` и не может быть изменено после создания
+экземпляра класса. Класс также предоставляет методы для получения типа значения, проверки значения
+на пустоту, преобразования значения в другие типы и другие операции.
+
+### Методы
+
+- [constructor](#constructor) — Создает экземпляр класса `Value` с заданным значением.
+- [get](#get) — Возвращает значение, хранящееся в экземпляре класса `Value`.
+- [getType](#getType) — Возвращает тип значения, хранящегося в экземпляре класса `Value`.
+- [setType](#setType) — Преобразует значение в экземпляре класса `Value` к указанному типу.
+- [isEmpty](#isEmpty) — Проверяет, является ли значение, хранящееся в экземпляре класса
+  `Value`, пустым.
+- [print](#print) — Преобразует значение переменной в строку и выводит его на консоль.
+- [toPrint](#toPrint) — Преобразует значение переменной в строку и возвращает новый экземпляр
+  класса `Value` с этим значением.
+- [printType](#printType) — Преобразует тип значения переменной в строку и выводит его на
+  консоль.
+- [toPrintType](#toPrintType) — Преобразует тип значения переменной в строку и возвращает
+  новый экземпляр класса `Value` с этим значением.
+- [isArray](#isArray) — Проверяет, является ли значение массивом.
+- [isAssoc](#isAssoc) — Проверяет, является ли значение ассоциативным массивом.
+- [isBigInt](#isBigInt) — Проверяет, является ли значение типом BigInt.
+- [isBool](#isBool) — Проверяет, является ли значение логическим (булевым).
+- [isBoolean](#isBoolean) — Проверяет, является ли значение логическим (булевым).
+- [isClass](#isClass) — Проверяет, является ли значение классом.
+- [isFloat](#isFloat) — Проверяет, является ли значение числом с плавающей точкой.
+- [isFunction](#isFunction) — Проверяет, является ли значение функцией.
+- [isInfinity](#isInfinity) — Проверяет, является ли значение бесконечностью.
+- [isInt](#isInt) — Проверяет, является ли значение целым числом.
+- [isInteger](#isInteger) — Проверяет, является ли значение целым числом.
+- [isList](#isList) — Проверяет, является ли значение списком.
+- [isNaN](#isNaN) — Проверяет, является ли значение NaN.
+- [isNull](#isNull) — Проверяет, является ли значение null.
+- [isNumber](#isNumber) — Проверяет, является ли значение числом.
+- [isNumeric](#isNumeric) — Проверяет, является ли значение числом или числовой строкой.
+- [isObject](#isObject) — Проверяет, является ли значение объектом.
+- [isScalar](#isScalar) — Проверяет, является ли значение скалярным.
+- [isString](#isString) — Проверяет, является ли значение строкой.
+- [isSymbol](#isSymbol) — Проверяет, является ли значение символом.
+- [isUndefined](#isUndefined) — Проверяет, является ли значение undefined.
+- [toArray](#toArray) — Преобразует значение в экземпляре класса `Value` к массиву.
+- [toAssoc](#toAssoc) — Преобразует значение в экземпляре класса `Value` к ассоциативному
+  массиву.
+- [toBool](#toBool) — Преобразует значение в экземпляре класса `Value` к логическому типу.
+- [toBoolean](#toBoolean) — Преобразует значение в экземпляре класса `Value` к логическому
+  типу.
+- [toFloat](#toFloat) — Преобразует значение в экземпляре класса `Value` к числу с плавающей
+  точкой.
+- [toInt](#toInt) — Преобразует значение в экземпляре класса `Value` к целому числу.
+- [toInteger](#toInteger) — Преобразует значение в экземпляре класса `Value` к целому числу.
+- [toList](#toList) — Преобразует значение в экземпляре класса `Value` к списку.
+- [toObject](#toObject) — Преобразует значение в экземпляре класса `Value` к объекту.
+- [toString](#toString) — Преобразует значение в экземпляре класса `Value` к строке.
+

package/docs/classes.md

@@ -0,0 +1,11 @@
+[Главная](../../README.md) / Классы
+
+# Классы
+
+- [Convert](./classes/Convert.md) — Класс, предоставляющий методы для преобразования различных
+  типов данных в JavaScript.
+- [Type](./classes/Type.md) — Класс, предоставляющий методы для проверки типов данных в
+  JavaScript.
+- [Value](./classes/Value.md) — Класс, представляющий обертку для значений различных типов и
+  предоставляющий методы для работы с ними.
+

package/docs/constants.md

@@ -0,0 +1,47 @@
+[Главная](../README.md) / Константы
+
+# Константы
+
+Этот файл содержит константы, используемые для определения типов данных в библиотеке.
+
+## Сигнатура
+
+```ts
+export const TYPE_NULL: string;
+export const TYPE_NAN: string;
+export const TYPE_UNDEFINED: string;
+export const TYPE_INFINITY: string;
+export const TYPE_BOOLEAN: string;
+export const TYPE_INTEGER: string;
+export const TYPE_BIGINT: string;
+export const TYPE_FLOAT: string;
+export const TYPE_STRING: string;
+export const TYPE_SYMBOL: string;
+export const TYPE_CLASS: string;
+export const TYPE_FUNCTION: string;
+export const TYPE_ARRAY: string;
+export const TYPE_OBJECT: string;
+```
+
+## Описание
+
+Константы используются для определения типов данных в библиотеке. Они представляют собой строки,
+которые описывают различные типы данных.
+
+### Константы
+
+- `TYPE_NULL` — Представляет тип `null`.
+- `TYPE_NAN` — Представляет тип `NaN`.
+- `TYPE_UNDEFINED` — Представляет тип `undefined`.
+- `TYPE_INFINITY` — Представляет тип `infinity`.
+- `TYPE_BOOLEAN` — Представляет тип `boolean`.
+- `TYPE_INTEGER` — Представляет тип `integer`.
+- `TYPE_BIGINT` — Представляет тип `bigint`.
+- `TYPE_FLOAT` — Представляет тип `float`.
+- `TYPE_STRING` — Представляет тип `string`.
+- `TYPE_SYMBOL` — Представляет тип `symbol`.
+- `TYPE_CLASS` — Представляет тип `class`.
+- `TYPE_FUNCTION` — Представляет тип `function`.
+- `TYPE_ARRAY` — Представляет тип `array`.
+- `TYPE_OBJECT` — Представляет тип `object`.
+

package/docs/helpers/array.md

@@ -1,80 +1,80 @@
-[Главная](../../README.md) / [Помощники](../helpers.md) / array
-
-[Исходный код](../../src/helpers/array.mjs)
-
-# array
-
-`array` — Создаёт массив из переданных значений, обрабатывая ассоциативные массивы (объекты с
-ключами).
-
-## Сигнатура функции
-
-```ts
-function array(...values: any[]): Array<any> | Object;
-```
-
-## Описание
-
-Функция принимает произвольное количество аргументов и возвращает массив, содержащий переданные
-значения. Если среди переданных значений есть ассоциативные массивы (объекты, не являющиеся
-массивами и с ненулевым прототипом), они преобразуются:
-
-- Создаётся новый объект без прототипа.
-- Добавляются все свойства исходного объекта.
-- Добавляется итератор, позволяющий использовать объект в цикле `for-of` для получения пар
-  `[ключ, значение]`.
-
-Если передано только одно значение, и это массив, функция возвращает его напрямую.
-
-## Параметры
-
-- `values` (any[])
-
-    Один или несколько элементов, которые могут быть массивами, объектами или другими значениями.
-
-## Возвращаемое значение
-
-Массив, содержащий переданные значения, с преобразованием ассоциативных массивов. Если передано одно
-значение и это массив, возвращается он сам.
-
-## Примеры использования
-
-1. Простые массивы:
-
-    ```js
-    const result = array([1, 2, 3]);
-    console.log(result); // [1, 2, 3]
-    ```
-
-2. Ассоциативные массивы (объекты с ключами и значениями):
-
-    ```js
-    const result = array({ foo: 'bar', baz: 42 });
-    for (const [key, value] of result[0]) {
-        console.log(key, value);
-    }
-    // Вывод:
-    // foo bar
-    // baz 42
-    ```
-
-3. Смешанные значения:
-
-    ```js
-    const result = array([1, 2, 3], { foo: 'bar' }, 'hello');
-    console.log(result);
-    // Вывод: [[1, 2, 3], { foo: 'bar' }, 'hello']
-    ```
-
-4. Объекты, созданные без прототипа:
-
-    ```js
-    const noProtoObject = Object.create(null);
-    noProtoObject.foo = 'bar';
-    const result = array(noProtoObject);
-    for (const [key, value] of result[0]) {
-        console.log(key, value);
-    }
-    // Вывод:
-    // foo bar
-    ```
+[Главная](../../README.md) / [Помощники](../helpers.md) / array
+
+[Исходный код](../../src/helpers/array.mjs)
+
+# array
+
+`array` &mdash; Создаёт массив из переданных значений, обрабатывая ассоциативные массивы (объекты с
+ключами).
+
+## Сигнатура функции
+
+```ts
+function array(...values: any[]): Array<any> | Object;
+```
+
+## Описание
+
+Функция принимает произвольное количество аргументов и возвращает массив, содержащий переданные
+значения. Если среди переданных значений есть ассоциативные массивы (объекты, не являющиеся
+массивами и с ненулевым прототипом), они преобразуются:
+
+- Создаётся новый объект без прототипа.
+- Добавляются все свойства исходного объекта.
+- Добавляется итератор, позволяющий использовать объект в цикле `for-of` для получения пар
+  `[ключ, значение]`.
+
+Если передано только одно значение, и это массив, функция возвращает его напрямую.
+
+## Параметры
+
+- `values` (any[])
+
+    Один или несколько элементов, которые могут быть массивами, объектами или другими значениями.
+
+## Возвращаемое значение
+
+Массив, содержащий переданные значения, с преобразованием ассоциативных массивов. Если передано одно
+значение и это массив, возвращается он сам.
+
+## Примеры использования
+
+1. Простые массивы:
+
+    ```js
+    const result = array([1, 2, 3]);
+    console.log(result); // [1, 2, 3]
+    ```
+
+2. Ассоциативные массивы (объекты с ключами и значениями):
+
+    ```js
+    const result = array({ foo: 'bar', baz: 42 });
+    for (const [key, value] of result[0]) {
+        console.log(key, value);
+    }
+    // Вывод:
+    // foo bar
+    // baz 42
+    ```
+
+3. Смешанные значения:
+
+    ```js
+    const result = array([1, 2, 3], { foo: 'bar' }, 'hello');
+    console.log(result);
+    // Вывод: [[1, 2, 3], { foo: 'bar' }, 'hello']
+    ```
+
+4. Объекты, созданные без прототипа:
+
+    ```js
+    const noProtoObject = Object.create(null);
+    noProtoObject.foo = 'bar';
+    const result = array(noProtoObject);
+    for (const [key, value] of result[0]) {
+        console.log(key, value);
+    }
+    // Вывод:
+    // foo bar
+    ```

package/docs/helpers/empty.md

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

package/docs/helpers/gettype.md

@@ -1,69 +1,69 @@
-[Главная](../../README.md) / [Помощники](../helpers.md) / gettype
-
-[Исходный код](../../src/helpers/gettype.mjs)
-
-# `gettype`
-
-`gettype` — Определяет тип переданного значения.
-
-## Сигнатура функции
-
-```ts
-function gettype(value: any): string;
-```
-
-## Параметры
-
-- `value` (any)
-
-    Значение, тип которого необходимо определить.
-
-## Описание
-
-Функция `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`.
-
-## Возвращаемое значение
-
-Функция возвращает строку, представляющую тип значения.
-
-## Примеры использования
-
-### Пример 1: Проверка различных типов значений
-
-```js
-class MyClass {}
-
-gettype(null); // "null"
-gettype(NaN); // "NaN"
-gettype(undefined); // "undefined"
-gettype(Infinity); // "infinity"
-gettype(true); // "boolean"
-gettype(42); // "integer"
-gettype(BigInt(123456)); // "bigint"
-gettype(3.14); // "float"
-gettype('hello'); // "string"
-gettype(Symbol('symbol')); // "symbol"
-gettype(MyClass); // "class"
-gettype(() => {}); // "function"
-gettype([]); // "array"
-gettype(new MyClass()); // "object"
-```
+[Главная](../../README.md) / [Помощники](../helpers.md) / gettype
+
+[Исходный код](../../src/helpers/gettype.mjs)
+
+# `gettype`
+
+`gettype` — Определяет тип переданного значения.
+
+## Сигнатура функции
+
+```ts
+function gettype(value: any): string;
+```
+
+## Параметры
+
+- `value` (any)
+
+    Значение, тип которого необходимо определить.
+
+## Описание
+
+Функция `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`.
+
+## Возвращаемое значение
+
+Функция возвращает строку, представляющую тип значения.
+
+## Примеры использования
+
+### Пример 1: Проверка различных типов значений
+
+```js
+class MyClass {}
+
+gettype(null); // "null"
+gettype(NaN); // "NaN"
+gettype(undefined); // "undefined"
+gettype(Infinity); // "infinity"
+gettype(true); // "boolean"
+gettype(42); // "integer"
+gettype(BigInt(123456)); // "bigint"
+gettype(3.14); // "float"
+gettype('hello'); // "string"
+gettype(Symbol('symbol')); // "symbol"
+gettype(MyClass); // "class"
+gettype(() => {}); // "function"
+gettype([]); // "array"
+gettype(new MyClass()); // "object"
+```