@rogolev/value 0.0.4 → 0.0.5

package/docs/helpers/expect_string.md

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

package/docs/helpers/expect_symbol.md

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

package/docs/helpers/expect_undefined.md

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

package/docs/helpers/is_equal.md

@@ -0,0 +1,75 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / is_equal
+
+[Исходный код](../../src/helpers/is_equal.mjs)
+
+# is_equal
+
+`is_equal` — Проверяет, являются ли два значения равными.
+
+## Сигнатура функции
+
+```ts
+function is_equal(actual: any, expected: any, strict: boolean = false): boolean;
+```
+
+## Описание
+
+Функция `is_equal` используется для проверки равенства двух значений. Она поддерживает сравнение
+примитивных типов данных, а также объектов и массивов. Для объектов и массивов функция рекурсивно
+сравнивает их ключи и значения. Функция также поддерживает строгий режим сравнения, который
+учитывает типы значений.
+
+## Параметры
+
+- `actual` (any): Первое значение для сравнения.
+- `expected` (any): Второе значение для сравнения.
+- `strict` (boolean): Флаг строгого сравнения. По умолчанию `false`.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значения равны, иначе `false`.
+
+## Примеры использования
+
+1. Проверка равенства чисел:
+
+    ```js
+    const result = is_equal(1, 1);
+    console.log(result); // true
+    ```
+
+2. Проверка равенства строк:
+
+    ```js
+    const result = is_equal('hello', 'hello');
+    console.log(result); // true
+    ```
+
+3. Проверка равенства объектов:
+
+    ```js
+    const obj1 = { a: 1, b: 2 };
+    const obj2 = { a: 1, b: 2 };
+    const result = is_equal(obj1, obj2);
+    console.log(result); // true
+    ```
+
+4. Проверка равенства массивов:
+
+    ```js
+    const arr1 = [1, 2, 3];
+    const arr2 = [1, 2, 3];
+    const result = is_equal(arr1, arr2);
+    console.log(result); // true
+    ```
+
+5. Проверка равенства с использованием строгого сравнения:
+
+    ```js
+    const result = is_equal(1, '1', true);
+    console.log(result); // false
+    ```
+
+## Исключения
+
+- `TypeError`: Если значения не являются объектами или массивами.

package/docs/helpers.md

@@ -7,6 +7,52 @@
 - [array](./helpers/array.md) — Создаёт массив из переданных значений, обрабатывая
   ассоциативные массивы (объекты с ключами).
 - [empty](./helpers/empty.md) — Проверяет, является ли переменная пустой.
+- [expect_array](./helpers/expect_array.md) — Проверяет, является ли значение массивом, и
+  выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_assoc](./helpers/expect_assoc.md) — Проверяет, является ли значение ассоциативным
+  массивом, и выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_bigint](./helpers/expect_bigint.md) — Проверяет, является ли значение BigInt, и
+  выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_bool](./helpers/expect_bool.md) — Проверяет, является ли значение логическим типом,
+  и выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_boolean](./helpers/expect_boolean.md) — Проверяет, является ли значение логическим
+  типом, и выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_char](./helpers/expect_char.md) — Проверяет, является ли значение символом, и
+  выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_class](./helpers/expect_class.md) — Проверяет, является ли значение классом, и
+  выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_float](./helpers/expect_float.md) — Проверяет, является ли значение числом с
+  плавающей запятой, и выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_function](./helpers/expect_function.md) — Проверяет, является ли значение функцией,
+  и выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_infinity](./helpers/expect_infinity.md) — Проверяет, является ли значение
+  бесконечностью, и выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_int](./helpers/expect_int.md) — Проверяет, является ли значение целым числом, и
+  выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_integer](./helpers/expect_integer.md) — Проверяет, является ли значение целым
+  числом, и выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_list](./helpers/expect_list.md) — Проверяет, является ли значение списком, и
+  выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_nan](./helpers/expect_nan.md) — Проверяет, является ли значение NaN, и выбрасывает
+  ошибку с указанным сообщением, если это не так.
+- [expect_null](./helpers/expect_null.md) — Проверяет, является ли значение null, и
+  выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_number](./helpers/expect_number.md) — Проверяет, является ли значение числом, и
+  выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_numeric](./helpers/expect_numeric.md) — Проверяет, является ли значение числовым, и
+  выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_object](./helpers/expect_object.md) — Проверяет, является ли значение объектом, и
+  выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_scalar](./helpers/expect_scalar.md) — Проверяет, является ли значение скалярным, и
+  выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_string](./helpers/expect_string.md) — Проверяет, является ли значение строкой, и
+  выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_symbol](./helpers/expect_symbol.md) — Проверяет, является ли значение символом, и
+  выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect_undefined](./helpers/expect_undefined.md) — Проверяет, является ли значение
+  undefined, и выбрасывает ошибку с указанным сообщением, если это не так.
+- [expect](./helpers/expect.md) — Функция, создающая новый экземпляр класса `Expect` для
+  проверки значений.
 - [gettype](./helpers/gettype.md) — Определяет тип переданного значения.
 - [is_array](./helpers/is_array.md) — Проверяет, является ли переданное значение массивом или
   ассоциативным массивом (объектом с ключами и значениями).
@@ -18,6 +64,7 @@
   логическим типом (`boolean`).
 - [is_char](./helpers/is_char.md) — Проверяет, является ли значение одиночным символом.
 - [is_class](./helpers/is_class.md) — Проверяет, является ли переданная переменная классом.
+- [is_equal](./helpers/is_equal.md) — Проверяет, являются ли два значения равными.
 - [is_float](./helpers/is_float.md) — Проверяет, является ли значение числом с плавающей
   точкой.
 - [is_function](./helpers/is_function.md) — Проверяет, что значение является функцией,

package/index.mjs

@@ -106,3 +106,28 @@ export { default as is_digit_char } from './src/helpers/string/is_digit_char.mjs
 export { default as natcompare_numeric } from './src/helpers/string/natcompare_numeric.mjs';
 export { default as natcompare } from './src/helpers/string/natcompare.mjs';
 export { default as natsort } from './src/helpers/array/natsort.mjs';
+export { default as expect_array } from './src/helpers/expect_array.mjs';
+export { default as expect_assoc } from './src/helpers/expect_assoc.mjs';
+export { default as expect_bigint } from './src/helpers/expect_bigint.mjs';
+export { default as expect_bool } from './src/helpers/expect_bool.mjs';
+export { default as expect_boolean } from './src/helpers/expect_boolean.mjs';
+export { default as expect_char } from './src/helpers/expect_char.mjs';
+export { default as expect_class } from './src/helpers/expect_class.mjs';
+export { default as expect_float } from './src/helpers/expect_float.mjs';
+export { default as expect_function } from './src/helpers/expect_function.mjs';
+export { default as expect_infinity } from './src/helpers/expect_infinity.mjs';
+export { default as expect_int } from './src/helpers/expect_int.mjs';
+export { default as expect_integer } from './src/helpers/expect_integer.mjs';
+export { default as expect_list } from './src/helpers/expect_list.mjs';
+export { default as expect_nan } from './src/helpers/expect_nan.mjs';
+export { default as expect_null } from './src/helpers/expect_null.mjs';
+export { default as expect_number } from './src/helpers/expect_number.mjs';
+export { default as expect_numeric } from './src/helpers/expect_numeric.mjs';
+export { default as expect_object } from './src/helpers/expect_object.mjs';
+export { default as expect_scalar } from './src/helpers/expect_scalar.mjs';
+export { default as expect_string } from './src/helpers/expect_string.mjs';
+export { default as expect_symbol } from './src/helpers/expect_symbol.mjs';
+export { default as expect_undefined } from './src/helpers/expect_undefined.mjs';
+export { default as is_equal } from './src/helpers/is_equal.mjs';
+export { default as Expect } from './src/classes/Expect.mjs';
+export { default as expect } from './src/helpers/expect.mjs';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rogolev/value",
-    "version": "0.0.4",
+    "version": "0.0.5",
     "description": "Библиотека, переосмысливающая типы данных и работу с ними.",
     "type": "module",
     "repository": {
@@ -46,4 +46,3 @@
         "test": "jest"
     }
 }
-