@rogolev/value 0.0.4 → 0.0.5

package/src/constants.mjs

@@ -1,14 +1,83 @@
-export const TYPE_NULL = 'null';
-export const TYPE_NAN = 'NaN';
-export const TYPE_UNDEFINED = 'undefined';
-export const TYPE_INFINITY = 'infinity';
-export const TYPE_BOOLEAN = 'boolean';
-export const TYPE_INTEGER = 'integer';
-export const TYPE_BIGINT = 'bigint';
-export const TYPE_FLOAT = 'float';
-export const TYPE_STRING = 'string';
-export const TYPE_SYMBOL = 'symbol';
-export const TYPE_CLASS = 'class';
-export const TYPE_FUNCTION = 'function';
-export const TYPE_ARRAY = 'array';
-export const TYPE_OBJECT = 'object';
+/**
+ * Константа, представляющая значение null.
+ * @type {string}
+ */
+export const TYPE_NULL = 'null';
+
+/**
+ * Константа, представляющая значение NaN (Not-a-Number).
+ * @type {string}
+ */
+export const TYPE_NAN = 'NaN';
+
+/**
+ * Константа, представляющая значение undefined.
+ * @type {string}
+ */
+export const TYPE_UNDEFINED = 'undefined';
+
+/**
+ * Константа, представляющая значение Infinity.
+ * @type {string}
+ */
+export const TYPE_INFINITY = 'infinity';
+
+/**
+ * Константа, представляющая тип boolean.
+ * @type {string}
+ */
+export const TYPE_BOOLEAN = 'boolean';
+
+/**
+ * Константа, представляющая тип integer (целое число).
+ * @type {string}
+ */
+export const TYPE_INTEGER = 'integer';
+
+/**
+ * Константа, представляющая тип bigint (большое целое число).
+ * @type {string}
+ */
+export const TYPE_BIGINT = 'bigint';
+
+/**
+ * Константа, представляющая тип float (число с плавающей запятой).
+ * @type {string}
+ */
+export const TYPE_FLOAT = 'float';
+
+/**
+ * Константа, представляющая тип string (строка).
+ * @type {string}
+ */
+export const TYPE_STRING = 'string';
+
+/**
+ * Константа, представляющая тип symbol (символ).
+ * @type {string}
+ */
+export const TYPE_SYMBOL = 'symbol';
+
+/**
+ * Константа, представляющая тип class (класс).
+ * @type {string}
+ */
+export const TYPE_CLASS = 'class';
+
+/**
+ * Константа, представляющая тип function (функция).
+ * @type {string}
+ */
+export const TYPE_FUNCTION = 'function';
+
+/**
+ * Константа, представляющая тип array (массив).
+ * @type {string}
+ */
+export const TYPE_ARRAY = 'array';
+
+/**
+ * Константа, представляющая тип object (объект).
+ * @type {string}
+ */
+export const TYPE_OBJECT = 'object';

package/src/helpers/expect.mjs

@@ -0,0 +1,44 @@
+import Expect from '../classes/Expect.mjs';
+
+/**
+ * Создает новый экземпляр класса `Expect` для проверки значений.
+ *
+ * ### Описание
+ *
+ * Функция `expect` используется для создания нового экземпляра класса `Expect`, который предоставляет методы для проверки различных свойств и типов значений.
+ * Она принимает одно значение, которое будет проверяться методами класса `Expect`.
+ *
+ * ### Параметры
+ *
+ * - `actual` (any): Значение, которое будет проверяться методами класса `Expect`.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает новый экземпляр класса `Expect`.
+ *
+ * ### Примеры использования
+ *
+ * 1. Создание экземпляра класса `Expect` и проверка значения:
+ *
+ *    ```js
+ *    expect(5).toBe(5); // true
+ *    ```
+ *
+ * 2. Проверка значения, являющегося массивом:
+ *
+ *    ```js
+ *    expect([1, 2, 3]).toBeArray(); // true
+ *    ```
+ *
+ * 3. Проверка значения, являющегося BigInt:
+ *
+ *    ```js
+ *    expect(123n).toBeBigInt(); // true
+ *    ```
+ *
+ * @param {any} actual Значение, которое будет проверяться методами класса `Expect`.
+ * @returns {Expect} Возвращает новый экземпляр класса `Expect`.
+ */
+export default function expect(actual) {
+    return new Expect(actual);
+}

package/src/helpers/expect_array.mjs

@@ -0,0 +1,66 @@
+import is_array from './is_array.mjs';
+import is_string from './is_string.mjs';
+
+/**
+ * Проверяет, является ли значение массивом, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `expect_array` используется для проверки, является ли переданное значение массивом.
+ * Если значение не является массивом, функция выбрасывает ошибку типа `TypeError` с указанным сообщением.
+ *
+ * ### Параметры
+ *
+ * - `arr` (any): Значение для проверки.
+ * - `message` (string): Сообщение об ошибке, если значение не является массивом. По умолчанию пустая строка.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение является массивом.
+ *
+ * ### Примеры использования
+ *
+ * 1. Проверка значения, являющегося массивом:
+ *
+ *    ```js
+ *    const array = [1, 2, 3];
+ *    const result = expect_array(array);
+ *    console.log(result); // true
+ *    ```
+ *
+ * 2. Проверка значения, не являющегося массивом:
+ *
+ *    ```js
+ *    try {
+ *        const result = expect_array('not an array', 'Значение должно быть массивом.');
+ *    } catch (e) {
+ *        console.error(e.message); // Значение должно быть массивом.
+ *    }
+ *    ```
+ *
+ * 3. Проверка значения с использованием пользовательского сообщения об ошибке:
+ *
+ *    ```js
+ *    try {
+ *        const result = expect_array(123, 'Ожидался массив.');
+ *    } catch (e) {
+ *        console.error(e.message); // Ожидался массив.
+ *    }
+ *    ```
+ *
+ * @param {any} arr Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является массивом.
+ * @returns {boolean} Возвращает `true`, если значение является массивом.
+ * @throws {TypeError} Если значение не является массивом или если параметр `message` не является строкой.
+ */
+export default function expect_array(arr, message = '') {
+    if (!is_string(message)) {
+        throw new TypeError('Параметр "message" должен быть строкой.');
+    }
+
+    if (!is_array(arr)) {
+        throw new TypeError(message);
+    }
+
+    return true;
+}

package/src/helpers/expect_assoc.mjs

@@ -0,0 +1,66 @@
+import is_assoc from './is_assoc.mjs';
+import is_string from './is_string.mjs';
+
+/**
+ * Проверяет, является ли значение ассоциативным массивом, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `expect_assoc` используется для проверки, является ли переданное значение ассоциативным массивом.
+ * Если значение не является ассоциативным массивом, функция выбрасывает ошибку типа `TypeError` с указанным сообщением.
+ *
+ * ### Параметры
+ *
+ * - `arr` (any): Значение для проверки.
+ * - `message` (string): Сообщение об ошибке, если значение не является ассоциативным массивом. По умолчанию пустая строка.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение является ассоциативным массивом.
+ *
+ * ### Примеры использования
+ *
+ * 1. Проверка значения, являющегося ассоциативным массивом:
+ *
+ *    ```js
+ *    const assoc = { a: 1, b: 2, c: 3 };
+ *    const result = expect_assoc(assoc);
+ *    console.log(result); // true
+ *    ```
+ *
+ * 2. Проверка значения, не являющегося ассоциативным массивом:
+ *
+ *    ```js
+ *    try {
+ *        const result = expect_assoc([1, 2, 3], 'Значение должно быть ассоциативным массивом.');
+ *    } catch (e) {
+ *        console.error(e.message); // Значение должно быть ассоциативным массивом.
+ *    }
+ *    ```
+ *
+ * 3. Проверка значения с использованием пользовательского сообщения об ошибке:
+ *
+ *    ```js
+ *    try {
+ *        const result = expect_assoc(123, 'Ожидался ассоциативный массив.');
+ *    } catch (e) {
+ *        console.error(e.message); // Ожидался ассоциативный массив.
+ *    }
+ *    ```
+ *
+ * @param {any} arr Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является ассоциативным массивом.
+ * @returns {boolean} Возвращает `true`, если значение является ассоциативным массивом.
+ * @throws {TypeError} Если значение не является ассоциативным массивом или если параметр `message` не является строкой.
+ */
+export default function expect_assoc(arr, message = '') {
+    if (!is_string(message)) {
+        throw new TypeError('Параметр "message" должен быть строкой.');
+    }
+
+    if (!is_assoc(arr)) {
+        throw new TypeError(message);
+    }
+
+    return true;
+}

package/src/helpers/expect_bigint.mjs

@@ -0,0 +1,66 @@
+import is_bigint from './is_bigint.mjs';
+import is_string from './is_string.mjs';
+
+/**
+ * Проверяет, является ли значение BigInt, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `expect_bigint` используется для проверки, является ли переданное значение BigInt.
+ * Если значение не является BigInt, функция выбрасывает ошибку типа `TypeError` с указанным сообщением.
+ *
+ * ### Параметры
+ *
+ * - `value` (any): Значение для проверки.
+ * - `message` (string): Сообщение об ошибке, если значение не является BigInt. По умолчанию пустая строка.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение является BigInt.
+ *
+ * ### Примеры использования
+ *
+ * 1. Проверка значения, являющегося BigInt:
+ *
+ *    ```js
+ *    const value = 123n;
+ *    const result = expect_bigint(value);
+ *    console.log(result); // true
+ *    ```
+ *
+ * 2. Проверка значения, не являющегося BigInt:
+ *
+ *    ```js
+ *    try {
+ *        const result = expect_bigint(123, 'Значение должно быть BigInt.');
+ *    } catch (e) {
+ *        console.error(e.message); // Значение должно быть BigInt.
+ *    }
+ *    ```
+ *
+ * 3. Проверка значения с использованием пользовательского сообщения об ошибке:
+ *
+ *    ```js
+ *    try {
+ *        const result = expect_bigint('123', 'Ожидался BigInt.');
+ *    } catch (e) {
+ *        console.error(e.message); // Ожидался BigInt.
+ *    }
+ *    ```
+ *
+ * @param {any} value Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является BigInt.
+ * @returns {boolean} Возвращает `true`, если значение является BigInt.
+ * @throws {TypeError} Если значение не является BigInt или если параметр `message` не является строкой.
+ */
+export default function expect_bigint(value, message = '') {
+    if (!is_string(message)) {
+        throw new TypeError('Параметр "message" должен быть строкой.');
+    }
+
+    if (!is_bigint(value)) {
+        throw new TypeError(message);
+    }
+
+    return true;
+}

package/src/helpers/expect_bool.mjs

@@ -0,0 +1,66 @@
+import is_bool from './is_bool.mjs';
+import is_string from './is_string.mjs';
+
+/**
+ * Проверяет, является ли значение логическим типом, и выбрасывает ошибку с указанным сообщением, если это не так.
+ *
+ * ### Описание
+ *
+ * Функция `expect_bool` используется для проверки, является ли переданное значение логическим типом.
+ * Если значение не является логическим типом, функция выбрасывает ошибку типа `TypeError` с указанным сообщением.
+ *
+ * ### Параметры
+ *
+ * - `value` (any): Значение для проверки.
+ * - `message` (string): Сообщение об ошибке, если значение не является логическим типом. По умолчанию пустая строка.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если значение является логическим типом.
+ *
+ * ### Примеры использования
+ *
+ * 1. Проверка значения, являющегося логическим типом:
+ *
+ *    ```js
+ *    const value = true;
+ *    const result = expect_bool(value);
+ *    console.log(result); // true
+ *    ```
+ *
+ * 2. Проверка значения, не являющегося логическим типом:
+ *
+ *    ```js
+ *    try {
+ *        const result = expect_bool(123, 'Значение должно быть логическим типом.');
+ *    } catch (e) {
+ *        console.error(e.message); // Значение должно быть логическим типом.
+ *    }
+ *    ```
+ *
+ * 3. Проверка значения с использованием пользовательского сообщения об ошибке:
+ *
+ *    ```js
+ *    try {
+ *        const result = expect_bool('true', 'Ожидался логический тип.');
+ *    } catch (e) {
+ *        console.error(e.message); // Ожидался логический тип.
+ *    }
+ *    ```
+ *
+ * @param {any} value Значение для проверки.
+ * @param {string} [message=''] Сообщение об ошибке, если значение не является логическим типом.
+ * @returns {boolean} Возвращает `true`, если значение является логическим типом.
+ * @throws {TypeError} Если значение не является логическим типом или если параметр `message` не является строкой.
+ */
+export default function expect_bool(value, message = '') {
+    if (!is_string(message)) {
+        throw new TypeError('Параметр "message" должен быть строкой.');
+    }
+
+    if (!is_bool(value)) {
+        throw new TypeError(message);
+    }
+
+    return true;
+}

package/src/helpers/expect_boolean.mjs

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

package/src/helpers/expect_char.mjs

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

package/src/helpers/expect_class.mjs

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

package/src/helpers/expect_float.mjs

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