@rogolev/value 0.0.3 → 0.0.5

package/docs/helpers/expect_boolean.md

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

package/docs/helpers/expect_char.md

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

package/docs/helpers/expect_class.md

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

package/docs/helpers/expect_float.md

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

package/docs/helpers/expect_function.md

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

package/docs/helpers/expect_infinity.md

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

package/docs/helpers/expect_int.md

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

package/docs/helpers/expect_integer.md

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

package/docs/helpers/expect_list.md

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

package/docs/helpers/expect_nan.md

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