@rogolev/value 0.0.3 → 0.0.5

package/docs/classes/Type/expectBigInt.md

@@ -0,0 +1,63 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / expectBigInt
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.expectBigInt
+
+`Type.expectBigInt` — Проверяет, является ли значение BigInt, и выбрасывает ошибку с указанным
+сообщением, если это не так.
+
+## Сигнатура метода
+
+```ts
+static expectBigInt(value: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Метод `expectBigInt` используется для проверки, является ли переданное значение BigInt. Если
+значение не является BigInt, метод выбрасывает ошибку типа `TypeError` с указанным сообщением.
+
+## Параметры
+
+- `value` (any): Значение для проверки.
+- `message` (string): Сообщение об ошибке, если значение не является BigInt. По умолчанию пустая
+  строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является BigInt.
+
+## Примеры использования
+
+1. Проверка значения, являющегося BigInt:
+
+    ```js
+    const value = 123n;
+    const result = Type.expectBigInt(value);
+    console.log(result); // true
+    ```
+
+2. Проверка значения, не являющегося BigInt:
+
+    ```js
+    try {
+        const result = Type.expectBigInt(123, 'Значение должно быть BigInt.');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть BigInt.
+    }
+    ```
+
+3. Проверка значения с использованием пользовательского сообщения об ошибке:
+
+    ```js
+    try {
+        const result = Type.expectBigInt('123', 'Ожидался BigInt.');
+    } catch (e) {
+        console.error(e.message); // Ожидался BigInt.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является BigInt или если параметр `message` не является строкой.

package/docs/classes/Type/expectBool.md

@@ -0,0 +1,65 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / expectBool
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.expectBool
+
+`Type.expectBool` — Проверяет, является ли значение логическим типом, и выбрасывает ошибку с
+указанным сообщением, если это не так.
+
+## Сигнатура метода
+
+```ts
+static expectBool(value: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Метод `expectBool` используется для проверки, является ли переданное значение логическим типом. Если
+значение не является логическим типом, метод выбрасывает ошибку типа `TypeError` с указанным
+сообщением.
+
+## Параметры
+
+- `value` (any): Значение для проверки.
+- `message` (string): Сообщение об ошибке, если значение не является логическим типом. По умолчанию
+  пустая строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является логическим типом.
+
+## Примеры использования
+
+1. Проверка значения, являющегося логическим типом:
+
+    ```js
+    const value = true;
+    const result = Type.expectBool(value);
+    console.log(result); // true
+    ```
+
+2. Проверка значения, не являющегося логическим типом:
+
+    ```js
+    try {
+        const result = Type.expectBool(123, 'Значение должно быть логическим типом.');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть логическим типом.
+    }
+    ```
+
+3. Проверка значения с использованием пользовательского сообщения об ошибке:
+
+    ```js
+    try {
+        const result = Type.expectBool('true', 'Ожидался логический тип.');
+    } catch (e) {
+        console.error(e.message); // Ожидался логический тип.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является логическим типом или если параметр `message` не является
+  строкой.

package/docs/classes/Type/expectBoolean.md

@@ -0,0 +1,65 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / expectBoolean
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.expectBoolean
+
+`Type.expectBoolean` — Проверяет, является ли значение логическим типом, и выбрасывает ошибку
+с указанным сообщением, если это не так.
+
+## Сигнатура метода
+
+```ts
+static expectBoolean(value: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Метод `expectBoolean` используется для проверки, является ли переданное значение логическим типом.
+Если значение не является логическим типом, метод выбрасывает ошибку типа `TypeError` с указанным
+сообщением.
+
+## Параметры
+
+- `value` (any): Значение для проверки.
+- `message` (string): Сообщение об ошибке, если значение не является логическим типом. По умолчанию
+  пустая строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является логическим типом.
+
+## Примеры использования
+
+1. Проверка значения, являющегося логическим типом:
+
+    ```js
+    const value = true;
+    const result = Type.expectBoolean(value);
+    console.log(result); // true
+    ```
+
+2. Проверка значения, не являющегося логическим типом:
+
+    ```js
+    try {
+        const result = Type.expectBoolean(123, 'Значение должно быть логическим типом.');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть логическим типом.
+    }
+    ```
+
+3. Проверка значения с использованием пользовательского сообщения об ошибке:
+
+    ```js
+    try {
+        const result = Type.expectBoolean('true', 'Ожидался логический тип.');
+    } catch (e) {
+        console.error(e.message); // Ожидался логический тип.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является логическим типом или если параметр `message` не является
+  строкой.

package/docs/classes/Type/expectChar.md

@@ -0,0 +1,63 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / expectChar
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.expectChar
+
+`Type.expectChar` — Проверяет, является ли значение символом, и выбрасывает ошибку с указанным
+сообщением, если это не так.
+
+## Сигнатура метода
+
+```ts
+static expectChar(value: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Метод `expectChar` используется для проверки, является ли переданное значение символом. Если
+значение не является символом, метод выбрасывает ошибку типа `TypeError` с указанным сообщением.
+
+## Параметры
+
+- `value` (any): Значение для проверки.
+- `message` (string): Сообщение об ошибке, если значение не является символом. По умолчанию пустая
+  строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является символом.
+
+## Примеры использования
+
+1. Проверка значения, являющегося символом:
+
+    ```js
+    const value = 'a';
+    const result = Type.expectChar(value);
+    console.log(result); // true
+    ```
+
+2. Проверка значения, не являющегося символом:
+
+    ```js
+    try {
+        const result = Type.expectChar('abc', 'Значение должно быть символом.');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть символом.
+    }
+    ```
+
+3. Проверка значения с использованием пользовательского сообщения об ошибке:
+
+    ```js
+    try {
+        const result = Type.expectChar(123, 'Ожидался символ.');
+    } catch (e) {
+        console.error(e.message); // Ожидался символ.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является символом или если параметр `message` не является строкой.

package/docs/classes/Type/expectClass.md

@@ -0,0 +1,63 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / expectClass
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.expectClass
+
+`Type.expectClass` — Проверяет, является ли значение классом, и выбрасывает ошибку с указанным
+сообщением, если это не так.
+
+## Сигнатура метода
+
+```ts
+static expectClass(value: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Метод `expectClass` используется для проверки, является ли переданное значение классом. Если
+значение не является классом, метод выбрасывает ошибку типа `TypeError` с указанным сообщением.
+
+## Параметры
+
+- `value` (any): Значение для проверки.
+- `message` (string): Сообщение об ошибке, если значение не является классом. По умолчанию пустая
+  строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является классом.
+
+## Примеры использования
+
+1. Проверка значения, являющегося классом:
+
+    ```js
+    class MyClass {}
+    const result = Type.expectClass(MyClass);
+    console.log(result); // true
+    ```
+
+2. Проверка значения, не являющегося классом:
+
+    ```js
+    try {
+        const result = Type.expectClass('not a class', 'Значение должно быть классом.');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть классом.
+    }
+    ```
+
+3. Проверка значения с использованием пользовательского сообщения об ошибке:
+
+    ```js
+    try {
+        const result = Type.expectClass(123, 'Ожидался класс.');
+    } catch (e) {
+        console.error(e.message); // Ожидался класс.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является классом или если параметр `message` не является строкой.

package/docs/classes/Type/expectFloat.md

@@ -0,0 +1,68 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / expectFloat
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.expectFloat
+
+`Type.expectFloat` — Проверяет, является ли значение числом с плавающей запятой, и выбрасывает
+ошибку с указанным сообщением, если это не так.
+
+## Сигнатура метода
+
+```ts
+static expectFloat(value: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Метод `expectFloat` используется для проверки, является ли переданное значение числом с плавающей
+запятой. Если значение не является числом с плавающей запятой, метод выбрасывает ошибку типа
+`TypeError` с указанным сообщением.
+
+## Параметры
+
+- `value` (any): Значение для проверки.
+- `message` (string): Сообщение об ошибке, если значение не является числом с плавающей запятой. По
+  умолчанию пустая строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является числом с плавающей запятой.
+
+## Примеры использования
+
+1. Проверка значения, являющегося числом с плавающей запятой:
+
+    ```js
+    const value = 123.45;
+    const result = Type.expectFloat(value);
+    console.log(result); // true
+    ```
+
+2. Проверка значения, не являющегося числом с плавающей запятой:
+
+    ```js
+    try {
+        const result = Type.expectFloat(
+            '123.45',
+            'Значение должно быть числом с плавающей запятой.',
+        );
+    } catch (e) {
+        console.error(e.message); // Значение должно быть числом с плавающей запятой.
+    }
+    ```
+
+3. Проверка значения с использованием пользовательского сообщения об ошибке:
+
+    ```js
+    try {
+        const result = Type.expectFloat(123, 'Ожидалось число с плавающей запятой.');
+    } catch (e) {
+        console.error(e.message); // Ожидалось число с плавающей запятой.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является числом с плавающей запятой или если параметр `message` не
+  является строкой.

package/docs/classes/Type/expectFunction.md

@@ -0,0 +1,63 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / expectFunction
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.expectFunction
+
+`Type.expectFunction` — Проверяет, является ли значение функцией, и выбрасывает ошибку с
+указанным сообщением, если это не так.
+
+## Сигнатура метода
+
+```ts
+static expectFunction(value: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Метод `expectFunction` используется для проверки, является ли переданное значение функцией. Если
+значение не является функцией, метод выбрасывает ошибку типа `TypeError` с указанным сообщением.
+
+## Параметры
+
+- `value` (any): Значение для проверки.
+- `message` (string): Сообщение об ошибке, если значение не является функцией. По умолчанию пустая
+  строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является функцией.
+
+## Примеры использования
+
+1. Проверка значения, являющегося функцией:
+
+    ```js
+    function myFunction() {}
+    const result = Type.expectFunction(myFunction);
+    console.log(result); // true
+    ```
+
+2. Проверка значения, не являющегося функцией:
+
+    ```js
+    try {
+        const result = Type.expectFunction(123, 'Значение должно быть функцией.');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть функцией.
+    }
+    ```
+
+3. Проверка значения с использованием пользовательского сообщения об ошибке:
+
+    ```js
+    try {
+        const result = Type.expectFunction('not a function', 'Ожидалась функция.');
+    } catch (e) {
+        console.error(e.message); // Ожидалась функция.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является функцией или если параметр `message` не является строкой.

package/docs/classes/Type/expectInfinity.md

@@ -0,0 +1,65 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / expectInfinity
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.expectInfinity
+
+`Type.expectInfinity` — Проверяет, является ли значение бесконечностью, и выбрасывает ошибку с
+указанным сообщением, если это не так.
+
+## Сигнатура метода
+
+```ts
+static expectInfinity(value: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Метод `expectInfinity` используется для проверки, является ли переданное значение бесконечностью.
+Если значение не является бесконечностью, метод выбрасывает ошибку типа `TypeError` с указанным
+сообщением.
+
+## Параметры
+
+- `value` (any): Значение для проверки.
+- `message` (string): Сообщение об ошибке, если значение не является бесконечностью. По умолчанию
+  пустая строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является бесконечностью.
+
+## Примеры использования
+
+1. Проверка значения, являющегося бесконечностью:
+
+    ```js
+    const value = Infinity;
+    const result = Type.expectInfinity(value);
+    console.log(result); // true
+    ```
+
+2. Проверка значения, не являющегося бесконечностью:
+
+    ```js
+    try {
+        const result = Type.expectInfinity(123, 'Значение должно быть бесконечностью.');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть бесконечностью.
+    }
+    ```
+
+3. Проверка значения с использованием пользовательского сообщения об ошибке:
+
+    ```js
+    try {
+        const result = Type.expectInfinity('123', 'Ожидалась бесконечность.');
+    } catch (e) {
+        console.error(e.message); // Ожидалась бесконечность.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является бесконечностью или если параметр `message` не является
+  строкой.

package/docs/classes/Type/expectInt.md

@@ -0,0 +1,64 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / expectInt
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.expectInt
+
+`Type.expectInt` — Проверяет, является ли значение целым числом, и выбрасывает ошибку с
+указанным сообщением, если это не так.
+
+## Сигнатура метода
+
+```ts
+static expectInt(value: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Метод `expectInt` используется для проверки, является ли переданное значение целым числом. Если
+значение не является целым числом, метод выбрасывает ошибку типа `TypeError` с указанным сообщением.
+
+## Параметры
+
+- `value` (any): Значение для проверки.
+- `message` (string): Сообщение об ошибке, если значение не является целым числом. По умолчанию
+  пустая строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является целым числом.
+
+## Примеры использования
+
+1. Проверка значения, являющегося целым числом:
+
+    ```js
+    const value = 123;
+    const result = Type.expectInt(value);
+    console.log(result); // true
+    ```
+
+2. Проверка значения, не являющегося целым числом:
+
+    ```js
+    try {
+        const result = Type.expectInt(123.45, 'Значение должно быть целым числом.');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть целым числом.
+    }
+    ```
+
+3. Проверка значения с использованием пользовательского сообщения об ошибке:
+
+    ```js
+    try {
+        const result = Type.expectInt('123', 'Ожидалось целое число.');
+    } catch (e) {
+        console.error(e.message); // Ожидалось целое число.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является целым числом или если параметр `message` не является
+  строкой.

package/docs/classes/Type/expectInteger.md

@@ -0,0 +1,64 @@
+[Главная](../../../README.md) / [Классы](../../classes.md) / [Type](../Type.md) / expectInteger
+
+[Исходный код](../../../src/classes/Type.mjs)
+
+# Type.expectInteger
+
+`Type.expectInteger` — Проверяет, является ли значение целым числом, и выбрасывает ошибку с
+указанным сообщением, если это не так.
+
+## Сигнатура метода
+
+```ts
+static expectInteger(value: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Метод `expectInteger` используется для проверки, является ли переданное значение целым числом. Если
+значение не является целым числом, метод выбрасывает ошибку типа `TypeError` с указанным сообщением.
+
+## Параметры
+
+- `value` (any): Значение для проверки.
+- `message` (string): Сообщение об ошибке, если значение не является целым числом. По умолчанию
+  пустая строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является целым числом.
+
+## Примеры использования
+
+1. Проверка значения, являющегося целым числом:
+
+    ```js
+    const value = 123;
+    const result = Type.expectInteger(value);
+    console.log(result); // true
+    ```
+
+2. Проверка значения, не являющегося целым числом:
+
+    ```js
+    try {
+        const result = Type.expectInteger(123.45, 'Значение должно быть целым числом.');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть целым числом.
+    }
+    ```
+
+3. Проверка значения с использованием пользовательского сообщения об ошибке:
+
+    ```js
+    try {
+        const result = Type.expectInteger('123', 'Ожидалось целое число.');
+    } catch (e) {
+        console.error(e.message); // Ожидалось целое число.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является целым числом или если параметр `message` не является
+  строкой.