@rogolev/value 0.0.1 → 0.0.3

package/docs/classes/Type/isString.md

@@ -0,0 +1,54 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isString
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isString
+
+`Type.isString` — Проверяет, является ли значение строкой.
+
+## Сигнатура метода
+
+```ts
+static isString(value: any): boolean;
+```
+
+## Описание
+
+Метод `Type.isString` проверяет, является ли переданное значение строкой.
+
+Он использует оператор `typeof` для проверки типа значения.
+
+Метод возвращает `false` для значений других типов, таких как числа, объекты или массивы.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является строкой, и `false` в противном случае.
+
+## Примеры использования
+
+1. Проверка строковых значений:
+
+    ```js
+    Type.isString('hello'); // true
+    Type.isString(''); // true
+    Type.isString(`template string`); // true
+    ```
+
+2. Проверка значений других типов:
+
+    ```js
+    Type.isString(42); // false (число)
+    Type.isString(true); // false (логическое значение)
+    Type.isString(null); // false
+    Type.isString(undefined); // false
+    Type.isString({}); // false (объект)
+    Type.isString([]); // false (массив)
+    Type.isString(() => {}); // false (функция)
+    ```
+

package/docs/classes/Type/isSymbol.md

@@ -0,0 +1,56 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isSymbol
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isSymbol
+
+`Type.isSymbol` — Проверяет, является ли значение символом.
+
+## Сигнатура метода
+
+```ts
+static isSymbol(value: any): boolean;
+```
+
+## Описание
+
+Метод `Type.isSymbol` предназначен для проверки, является ли переданное значение символом.
+
+Он проверяет:
+
+1. Что значение имеет тип `symbol`.
+
+Метод возвращает `false` для всех значений, не принадлежащих типу `symbol`.
+
+## Параметры
+
+- `value` (any)
+
+    Проверяемая переменная.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является символом, иначе `false`.
+
+## Примеры использования
+
+1. Проверка символов:
+
+    ```js
+    Type.isSymbol(Symbol('symbol')); // true
+    Type.isSymbol(Symbol.iterator); // true
+    ```
+
+2. Проверка значений других типов:
+
+    ```js
+    Type.isSymbol('hello'); // false (строка)
+    Type.isSymbol(42); // false (число)
+    Type.isSymbol(true); // false (логическое значение)
+    Type.isSymbol(null); // false
+    Type.isSymbol(undefined); // false
+    Type.isSymbol({}); // false (объект)
+    Type.isSymbol([]); // false (массив)
+    Type.isSymbol(() => {}); // false (функция)
+    ```
+

package/docs/classes/Type/isUndefined.md

@@ -0,0 +1,52 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / isUndefined
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.isUndefined
+
+`Type.isUndefined` — Проверяет, является ли значение `undefined`.
+
+## Сигнатура метода
+
+```ts
+static isUndefined(value: any): boolean;
+```
+
+## Описание
+
+Метод `Type.isUndefined` проверяет, является ли переданное значение `undefined`.
+
+Он использует оператор `typeof` для проверки типа значения.
+
+Метод возвращает `false` для всех значений, не принадлежащих типу `undefined`.
+
+## Параметры
+
+- `value` (any)
+
+    Проверяемая переменная.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является `undefined`, иначе `false`.
+
+## Примеры использования
+
+1. Проверка значения `undefined`:
+
+    ```js
+    Type.isUndefined(undefined); // true
+    ```
+
+2. Проверка значений других типов:
+
+    ```js
+    Type.isUndefined(null); // false
+    Type.isUndefined(42); // false (число)
+    Type.isUndefined('hello'); // false (строка)
+    Type.isUndefined(true); // false (логическое значение)
+    Type.isUndefined({}); // false (объект)
+    Type.isUndefined([]); // false (массив)
+    Type.isUndefined(() => {}); // false (функция)
+    ```
+

package/docs/classes/Type.md

@@ -0,0 +1,74 @@
+[Главная](../../README.md) / [Классы](../classes.md) / Type
+
+[Исходный код](../../src/classes/Type.mjs)
+
+# Type
+
+`Type` — Класс, предоставляющий методы для проверки типов данных в JavaScript.
+
+## Сигнатура класса
+
+```ts
+class Type {
+    static isEmpty(value: any): boolean;
+    static isArray(value: any): boolean;
+    static isAssoc(value: any): boolean;
+    static isBigInt(value: any): boolean;
+    static isBool(value: any): boolean;
+    static isBoolean(value: any): boolean;
+    static isClass(value: any): boolean;
+    static isFloat(value: any): boolean;
+    static isFunction(value: any): boolean;
+    static isInfinity(value: any): boolean;
+    static isInt(value: any): boolean;
+    static isInteger(value: any): boolean;
+    static isList(value: any): boolean;
+    static isNaN(value: any): boolean;
+    static isNull(value: any): boolean;
+    static isNumber(value: any): boolean;
+    static isNumeric(value: any): boolean;
+    static isObject(value: any): boolean;
+    static isScalar(value: any): boolean;
+    static isString(value: any): boolean;
+    static isSymbol(value: any): boolean;
+    static isUndefined(value: any): boolean;
+}
+```
+
+## Описание
+
+Класс `Type` включает в себя статические методы, которые позволяют проверять типы различных
+значений. Эти методы охватывают широкий спектр типов данных, включая примитивы, объекты, массивы,
+функции и специальные значения.
+
+### Методы
+
+- [isEmpty](./Type/isEmpty.md) — Проверяет, является ли переменная пустой.
+- [isArray](./Type/isArray.md) — Проверяет, является ли переданное значение массивом или
+  ассоциативным массивом.
+- [isAssoc](./Type/isAssoc.md) — Проверяет, является ли значение ассоциативным массивом.
+- [isBigInt](./Type/isBigInt.md) — Проверяет, является ли значение типом `bigint`.
+- [isBool](./Type/isBool.md) — Проверяет, является ли переданное значение логическим типом
+  (`boolean`).
+- [isBoolean](./Type/isBoolean.md) — Проверяет, является ли переданное значение логическим
+  типом (`boolean`).
+- [isClass](./Type/isClass.md) — Проверяет, является ли переданная переменная классом.
+- [isFloat](./Type/isFloat.md) — Проверяет, является ли значение числом с плавающей точкой.
+- [isFunction](./Type/isFunction.md) — Проверяет, что значение является функцией, исключая
+  классы.
+- [isInfinity](./Type/isInfinity.md) — Проверяет, является ли значение бесконечностью
+  (`Infinity` или `-Infinity`).
+- [isInt](./Type/isInt.md) — Проверяет, является ли значение целым числом.
+- [isInteger](./Type/isInteger.md) — Проверяет, является ли значение целым числом.
+- [isList](./Type/isList.md) — Проверяет, является ли значение списком.
+- [isNaN](./Type/isNaN.md) — Проверяет, является ли значение NaN.
+- [isNull](./Type/isNull.md) — Проверяет, является ли значение `null`.
+- [isNumber](./Type/isNumber.md) — Проверяет, является ли значение числом.
+- [isNumeric](./Type/isNumeric.md) — Проверяет, является ли значение числом или числовой
+  строкой.
+- [isObject](./Type/isObject.md) — Проверяет, является ли переданная переменная объектом.
+- [isScalar](./Type/isScalar.md) — Проверяет, является ли значение скалярным.
+- [isString](./Type/isString.md) — Проверяет, является ли значение строкой.
+- [isSymbol](./Type/isSymbol.md) — Проверяет, является ли значение символом.
+- [isUndefined](./Type/isUndefined.md) — Проверяет, является ли значение `undefined`.
+

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
+    ```
+