@rogolev/value 0.0.4 → 0.0.5

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` не является строкой.

package/docs/helpers/expect_null.md

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

package/docs/helpers/expect_number.md

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

package/docs/helpers/expect_numeric.md

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

package/docs/helpers/expect_object.md

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

package/docs/helpers/expect_scalar.md

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