@rogolev/value 0.0.4 → 0.0.5

package/src/helpers/expect_function.mjs

@@ -0,0 +1,66 @@
+import is_function from './is_function.mjs';
+import is_string from './is_string.mjs';
+
+/**
+ * Проверяет, является ли значение функцией, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `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); // Ожидалась функция.
+ *    }
+ *    ```
+ *
+ * @param {any} value Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является функцией.
+ * @returns {boolean} Возвращает `true`, если значение является функцией.
+ * @throws {TypeError} Если значение не является функцией или если параметр `message` не является строкой.
+ */
+export default function expect_function(value, message = '') {
+    if (!is_string(message)) {
+        throw new TypeError('Параметр "message" должен быть строкой.');
+    }
+
+    if (!is_function(value)) {
+        throw new TypeError(message);
+    }
+
+    return true;
+}

package/src/helpers/expect_infinity.mjs

@@ -0,0 +1,66 @@
+import is_infinity from './is_infinity.mjs';
+import is_string from './is_string.mjs';
+
+/**
+ * Проверяет, является ли значение бесконечностью, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `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); // Ожидалась бесконечность.
+ *    }
+ *    ```
+ *
+ * @param {any} value Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является бесконечностью.
+ * @returns {boolean} Возвращает `true`, если значение является бесконечностью.
+ * @throws {TypeError} Если значение не является бесконечностью или если параметр `message` не является строкой.
+ */
+export default function expect_infinity(value, message = '') {
+    if (!is_string(message)) {
+        throw new TypeError('Параметр "message" должен быть строкой.');
+    }
+
+    if (!is_infinity(value)) {
+        throw new TypeError(message);
+    }
+
+    return true;
+}

package/src/helpers/expect_int.mjs

@@ -0,0 +1,66 @@
+import is_int from './is_int.mjs';
+import is_string from './is_string.mjs';
+
+/**
+ * Проверяет, является ли значение целым числом, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `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); // Ожидалось целое число.
+ *    }
+ *    ```
+ *
+ * @param {any} value Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является целым числом.
+ * @returns {boolean} Возвращает `true`, если значение является целым числом.
+ * @throws {TypeError} Если значение не является целым числом или если параметр `message` не является строкой.
+ */
+export default function expect_int(value, message = '') {
+    if (!is_string(message)) {
+        throw new TypeError('Параметр "message" должен быть строкой.');
+    }
+
+    if (!is_int(value)) {
+        throw new TypeError(message);
+    }
+
+    return true;
+}

package/src/helpers/expect_integer.mjs

@@ -0,0 +1,57 @@
+import expect_int from './expect_int.mjs';
+
+/**
+ * Проверяет, является ли значение целым числом, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `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); // Ожидалось целое число.
+ *    }
+ *    ```
+ *
+ * @param {any} value Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является целым числом.
+ * @returns {boolean} Возвращает `true`, если значение является целым числом.
+ * @throws {TypeError} Если значение не является целым числом или если параметр `message` не является строкой.
+ */
+export default function expect_integer(value, message = '') {
+    return expect_int(value, message);
+}

package/src/helpers/expect_list.mjs

@@ -0,0 +1,66 @@
+import is_list from './is_list.mjs';
+import is_string from './is_string.mjs';
+
+/**
+ * Проверяет, является ли значение списком, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `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); // Ожидался список.
+ *    }
+ *    ```
+ *
+ * @param {any} value Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является списком.
+ * @returns {boolean} Возвращает `true`, если значение является списком.
+ * @throws {TypeError} Если значение не является списком или если параметр `message` не является строкой.
+ */
+export default function expect_list(value, message = '') {
+    if (!is_string(message)) {
+        throw new TypeError('Параметр "message" должен быть строкой.');
+    }
+
+    if (!is_list(value)) {
+        throw new TypeError(message);
+    }
+
+    return true;
+}

package/src/helpers/expect_nan.mjs

@@ -0,0 +1,66 @@
+import is_nan from './is_nan.mjs';
+import is_string from './is_string.mjs';
+
+/**
+ * Проверяет, является ли значение NaN, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `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.
+ *    }
+ *    ```
+ *
+ * @param {any} value Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является NaN.
+ * @returns {boolean} Возвращает `true`, если значение является NaN.
+ * @throws {TypeError} Если значение не является NaN или если параметр `message` не является строкой.
+ */
+export default function expect_nan(value, message = '') {
+    if (!is_string(message)) {
+        throw new TypeError('Параметр "message" должен быть строкой.');
+    }
+
+    if (!is_nan(value)) {
+        throw new TypeError(message);
+    }
+
+    return true;
+}

package/src/helpers/expect_null.mjs

@@ -0,0 +1,66 @@
+import is_null from './is_null.mjs';
+import is_string from './is_string.mjs';
+
+/**
+ * Проверяет, является ли значение null, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `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.
+ *    }
+ *    ```
+ *
+ * @param {any} value Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является null.
+ * @returns {boolean} Возвращает `true`, если значение является null.
+ * @throws {TypeError} Если значение не является null или если параметр `message` не является строкой.
+ */
+export default function expect_null(value, message = '') {
+    if (!is_string(message)) {
+        throw new TypeError('Параметр "message" должен быть строкой.');
+    }
+
+    if (!is_null(value)) {
+        throw new TypeError(message);
+    }
+
+    return true;
+}

package/src/helpers/expect_number.mjs

@@ -0,0 +1,66 @@
+import is_number from './is_number.mjs';
+import is_string from './is_string.mjs';
+
+/**
+ * Проверяет, является ли значение числом, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `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); // Ожидалось число.
+ *    }
+ *    ```
+ *
+ * @param {any} value Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является числом.
+ * @returns {boolean} Возвращает `true`, если значение является числом.
+ * @throws {TypeError} Если значение не является числом или если параметр `message` не является строкой.
+ */
+export default function expect_number(value, message = '') {
+    if (!is_string(message)) {
+        throw new TypeError('Параметр "message" должен быть строкой.');
+    }
+
+    if (!is_number(value)) {
+        throw new TypeError(message);
+    }
+
+    return true;
+}

package/src/helpers/expect_numeric.mjs

@@ -0,0 +1,66 @@
+import is_numeric from './is_numeric.mjs';
+import is_string from './is_string.mjs';
+
+/**
+ * Проверяет, является ли значение числовым, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `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); // Ожидалось числовое значение.
+ *    }
+ *    ```
+ *
+ * @param {any} value Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является числовым.
+ * @returns {boolean} Возвращает `true`, если значение является числовым.
+ * @throws {TypeError} Если значение не является числовым или если параметр `message` не является строкой.
+ */
+export default function expect_numeric(value, message = '') {
+    if (!is_string(message)) {
+        throw new TypeError('Параметр "message" должен быть строкой.');
+    }
+
+    if (!is_numeric(value)) {
+        throw new TypeError(message);
+    }
+
+    return true;
+}

package/src/helpers/expect_object.mjs

@@ -0,0 +1,67 @@
+import is_object from './is_object.mjs';
+import is_string from './is_string.mjs';
+
+/**
+ * Проверяет, является ли значение объектом, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `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); // Ожидался объект.
+ *    }
+ *    ```
+ *
+ * @param {any} value Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является объектом.
+ * @returns {boolean} Возвращает `true`, если значение является объектом.
+ * @throws {TypeError} Если значение не является объектом или если параметр `message` не является строкой.
+ */
+export default function expect_object(value, message = '') {
+    if (!is_string(message)) {
+        throw new TypeError('Параметр "message" должен быть строкой.');
+    }
+
+    if (!is_object(value)) {
+        throw new TypeError(message);
+    }
+
+    return true;
+}