@rogolev/value 0.0.4 → 0.0.5

package/docs/helpers/expect.md

@@ -0,0 +1,58 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / expect
+
+[Исходный код](../../src/helpers/expect.mjs)
+
+# expect
+
+`expect` — Функция, создающая новый экземпляр класса `Expect` для проверки значений.
+
+## Сигнатура функции
+
+```ts
+function expect(actual: any): 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
+    ```
+
+4. Проверка значения, являющегося объектом:
+
+    ```js
+    class stdClass {}
+    expect(new stdClass()).toBeObject(); // true
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не соответствует ожидаемому типу или значению.

package/docs/helpers/expect_array.md

@@ -0,0 +1,63 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / expect_array
+
+[Исходный код](../../src/helpers/expect_array.mjs)
+
+# expect_array
+
+`expect_array` — Проверяет, является ли значение массивом, и выбрасывает ошибку с указанным
+сообщением, если это не так.
+
+## Сигнатура функции
+
+```ts
+function expect_array(arr: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Функция `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); // Ожидался массив.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является массивом или если параметр `message` не является строкой.

package/docs/helpers/expect_assoc.md

@@ -0,0 +1,65 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / expect_assoc
+
+[Исходный код](../../src/helpers/expect_assoc.mjs)
+
+# expect_assoc
+
+`expect_assoc` — Проверяет, является ли значение ассоциативным массивом, и выбрасывает ошибку
+с указанным сообщением, если это не так.
+
+## Сигнатура функции
+
+```ts
+function expect_assoc(arr: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Функция `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); // Ожидался ассоциативный массив.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является ассоциативным массивом или если параметр `message` не
+  является строкой.

package/docs/helpers/expect_bigint.md

@@ -0,0 +1,63 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / expect_bigint
+
+[Исходный код](../../src/helpers/expect_bigint.mjs)
+
+# expect_bigint
+
+`expect_bigint` — Проверяет, является ли значение BigInt, и выбрасывает ошибку с указанным
+сообщением, если это не так.
+
+## Сигнатура функции
+
+```ts
+function expect_bigint(value: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Функция `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.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является BigInt или если параметр `message` не является строкой.

package/docs/helpers/expect_bool.md

@@ -0,0 +1,65 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / expect_bool
+
+[Исходный код](../../src/helpers/expect_bool.mjs)
+
+# expect_bool
+
+`expect_bool` — Проверяет, является ли значение логическим типом, и выбрасывает ошибку с
+указанным сообщением, если это не так.
+
+## Сигнатура функции
+
+```ts
+function expect_bool(value: any, message: string = ''): boolean;
+```
+
+## Описание
+
+Функция `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); // Ожидался логический тип.
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является логическим типом или если параметр `message` не является
+  строкой.

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