@rogolev/value 0.0.1 → 0.0.2

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.md

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

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