@rogolev/value 0.0.4 → 0.0.5

package/docs/classes/Expect/toBeFloat.md

@@ -0,0 +1,53 @@
+[Главная](../../../README.md) / [Классы](../classes.md) / [Expect](./Expect.md) / toBeFloat
+
+[Исходный код](../../../src/classes/Expect.mjs)
+
+# toBeFloat
+
+`toBeFloat` — Метод класса `Expect`, который проверяет, что фактическое значение является
+числом с плавающей запятой (float).
+
+## Сигнатура метода
+
+```ts
+toBeFloat(message?: string): boolean;
+```
+
+## Описание
+
+Метод `toBeFloat` используется для проверки, что фактическое значение (`actual`) является числом с
+плавающей запятой (float). Если значение не является числом с плавающей запятой, выбрасывается
+ошибка типа `TypeError` с указанным сообщением.
+
+## Параметры
+
+- `message` (string): Сообщение об ошибке, если значение не является числом с плавающей запятой. По
+  умолчанию пустая строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является числом с плавающей запятой.
+
+## Примеры использования
+
+1. Проверка значения, являющегося числом с плавающей запятой:
+
+    ```js
+    const expect = new Expect(3.14);
+    expect.toBeFloat(); // true
+    ```
+
+2. Проверка значения, не являющегося числом с плавающей запятой:
+
+    ```js
+    const expect = new Expect(3);
+    try {
+        expect.toBeFloat('Значение должно быть числом с плавающей запятой');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть числом с плавающей запятой
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является числом с плавающей запятой.

package/docs/classes/Expect/toBeFunction.md

@@ -0,0 +1,52 @@
+[Главная](../../../README.md) / [Классы](../classes.md) / [Expect](./Expect.md) / toBeFunction
+
+[Исходный код](../../../src/classes/Expect.mjs)
+
+# toBeFunction
+
+`toBeFunction` — Метод класса `Expect`, который проверяет, является ли значение функцией.
+
+## Сигнатура метода
+
+```ts
+toBeFunction(message?: string): boolean;
+```
+
+## Описание
+
+Метод `toBeFunction` используется для проверки, является ли переданное значение функцией. Если
+значение не является функцией, выбрасывается ошибка типа `TypeError` с указанным сообщением.
+
+## Параметры
+
+- `message` (string): Сообщение об ошибке, если значение не является функцией. По умолчанию пустая
+  строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является функцией.
+
+## Примеры использования
+
+1. Проверка значения, являющегося функцией:
+
+    ```js
+    function myFunction() {}
+    const expect = new Expect(myFunction);
+    expect.toBeFunction(); // true
+    ```
+
+2. Проверка значения, не являющегося функцией:
+
+    ```js
+    const expect = new Expect(123);
+    try {
+        expect.toBeFunction('Значение должно быть функцией');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть функцией
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является функцией.

package/docs/classes/Expect/toBeInfinity.md

@@ -0,0 +1,53 @@
+[Главная](../../../README.md) / [Классы](../classes.md) / [Expect](./Expect.md) / toBeInfinity
+
+[Исходный код](../../../src/classes/Expect.mjs)
+
+# toBeInfinity
+
+`toBeInfinity` — Метод класса `Expect`, который проверяет, что фактическое значение является
+бесконечностью (Infinity).
+
+## Сигнатура метода
+
+```ts
+toBeInfinity(message?: string): boolean;
+```
+
+## Описание
+
+Метод `toBeInfinity` используется для проверки, что фактическое значение (`actual`) является
+бесконечностью (Infinity). Если значение не является бесконечностью, выбрасывается ошибка типа
+`TypeError` с указанным сообщением.
+
+## Параметры
+
+- `message` (string): Сообщение об ошибке, если значение не является бесконечностью. По умолчанию
+  пустая строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является бесконечностью.
+
+## Примеры использования
+
+1. Проверка значения, являющегося бесконечностью:
+
+    ```js
+    const expect = new Expect(Infinity);
+    expect.toBeInfinity(); // true
+    ```
+
+2. Проверка значения, не являющегося бесконечностью:
+
+    ```js
+    const expect = new Expect(123);
+    try {
+        expect.toBeInfinity('Значение должно быть бесконечностью');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть бесконечностью
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является бесконечностью.

package/docs/classes/Expect/toBeInt.md

@@ -0,0 +1,53 @@
+[Главная](../../../README.md) / [Классы](../classes.md) / [Expect](./Expect.md) / toBeInt
+
+[Исходный код](../../../src/classes/Expect.mjs)
+
+# toBeInt
+
+`toBeInt` — Метод класса `Expect`, который проверяет, что фактическое значение является целым
+числом (integer).
+
+## Сигнатура метода
+
+```ts
+toBeInt(message?: string): boolean;
+```
+
+## Описание
+
+Метод `toBeInt` используется для проверки, что фактическое значение (`actual`) является целым числом
+(integer). Если значение не является целым числом, выбрасывается ошибка типа `TypeError` с указанным
+сообщением.
+
+## Параметры
+
+- `message` (string): Сообщение об ошибке, если значение не является целым числом. По умолчанию
+  пустая строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является целым числом.
+
+## Примеры использования
+
+1. Проверка значения, являющегося целым числом:
+
+    ```js
+    const expect = new Expect(123);
+    expect.toBeInt(); // true
+    ```
+
+2. Проверка значения, не являющегося целым числом:
+
+    ```js
+    const expect = new Expect(123.45);
+    try {
+        expect.toBeInt('Значение должно быть целым числом');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть целым числом
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является целым числом.

package/docs/classes/Expect/toBeInteger.md

@@ -0,0 +1,53 @@
+[Главная](../../../README.md) / [Классы](../classes.md) / [Expect](./Expect.md) / toBeInteger
+
+[Исходный код](../../../src/classes/Expect.mjs)
+
+# toBeInteger
+
+`toBeInteger` — Метод класса `Expect`, который проверяет, что фактическое значение является
+целым числом (integer).
+
+## Сигнатура метода
+
+```ts
+toBeInteger(message?: string): boolean;
+```
+
+## Описание
+
+Метод `toBeInteger` используется для проверки, что фактическое значение (`actual`) является целым
+числом (integer). Если значение не является целым числом, выбрасывается ошибка типа `TypeError` с
+указанным сообщением.
+
+## Параметры
+
+- `message` (string): Сообщение об ошибке, если значение не является целым числом. По умолчанию
+  пустая строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является целым числом.
+
+## Примеры использования
+
+1. Проверка значения, являющегося целым числом:
+
+    ```js
+    const expect = new Expect(123);
+    expect.toBeInteger(); // true
+    ```
+
+2. Проверка значения, не являющегося целым числом:
+
+    ```js
+    const expect = new Expect(123.45);
+    try {
+        expect.toBeInteger('Значение должно быть целым числом');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть целым числом
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является целым числом.

package/docs/classes/Expect/toBeList.md

@@ -0,0 +1,53 @@
+[Главная](../../../README.md) / [Классы](../classes.md) / [Expect](./Expect.md) / toBeList
+
+[Исходный код](../../../src/classes/Expect.mjs)
+
+# toBeList
+
+`toBeList` — Метод класса `Expect`, который проверяет, что фактическое значение является
+списком (list).
+
+## Сигнатура метода
+
+```ts
+toBeList(message?: string): boolean;
+```
+
+## Описание
+
+Метод `toBeList` используется для проверки, что фактическое значение (`actual`) является списком
+(list). Если значение не является списком, выбрасывается ошибка типа `TypeError` с указанным
+сообщением.
+
+## Параметры
+
+- `message` (string): Сообщение об ошибке, если значение не является списком. По умолчанию пустая
+  строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является списком.
+
+## Примеры использования
+
+1. Проверка значения, являющегося списком:
+
+    ```js
+    const expect = new Expect([1, 2, 3]);
+    expect.toBeList(); // true
+    ```
+
+2. Проверка значения, не являющегося списком:
+
+    ```js
+    const expect = new Expect('not a list');
+    try {
+        expect.toBeList('Значение должно быть списком');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть списком
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является списком.

package/docs/classes/Expect/toBeNaN.md

@@ -0,0 +1,53 @@
+[Главная](../../../README.md) / [Классы](../classes.md) / [Expect](./Expect.md) / toBeNaN
+
+[Исходный код](../../../src/classes/Expect.mjs)
+
+# toBeNaN
+
+`toBeNaN` — Метод класса `Expect`, который проверяет, что фактическое значение является NaN
+(Not-a-Number).
+
+## Сигнатура метода
+
+```ts
+toBeNaN(message?: string): boolean;
+```
+
+## Описание
+
+Метод `toBeNaN` используется для проверки, что фактическое значение (`actual`) является NaN
+(Not-a-Number). Если значение не является NaN, выбрасывается ошибка типа `TypeError` с указанным
+сообщением.
+
+## Параметры
+
+- `message` (string): Сообщение об ошибке, если значение не является NaN. По умолчанию пустая
+  строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является NaN.
+
+## Примеры использования
+
+1. Проверка значения, являющегося NaN:
+
+    ```js
+    const expect = new Expect(NaN);
+    expect.toBeNaN(); // true
+    ```
+
+2. Проверка значения, не являющегося NaN:
+
+    ```js
+    const expect = new Expect(123);
+    try {
+        expect.toBeNaN('Значение должно быть NaN');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть NaN
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является NaN.

package/docs/classes/Expect/toBeNull.md

@@ -0,0 +1,51 @@
+[Главная](../../../README.md) / [Классы](../classes.md) / [Expect](./Expect.md) / toBeNull
+
+[Исходный код](../../../src/classes/Expect.mjs)
+
+# toBeNull
+
+`toBeNull` — Метод класса `Expect`, который проверяет, что фактическое значение является null.
+
+## Сигнатура метода
+
+```ts
+toBeNull(message?: string): boolean;
+```
+
+## Описание
+
+Метод `toBeNull` используется для проверки, что фактическое значение (`actual`) является null. Если
+значение не является null, выбрасывается ошибка типа `TypeError` с указанным сообщением.
+
+## Параметры
+
+- `message` (string): Сообщение об ошибке, если значение не является null. По умолчанию пустая
+  строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является null.
+
+## Примеры использования
+
+1. Проверка значения, являющегося null:
+
+    ```js
+    const expect = new Expect(null);
+    expect.toBeNull(); // true
+    ```
+
+2. Проверка значения, не являющегося null:
+
+    ```js
+    const expect = new Expect(123);
+    try {
+        expect.toBeNull('Значение должно быть null');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть null
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является null.

package/docs/classes/Expect/toBeNumber.md

@@ -0,0 +1,52 @@
+[Главная](../../../README.md) / [Классы](../classes.md) / [Expect](./Expect.md) / toBeNumber
+
+[Исходный код](../../../src/classes/Expect.mjs)
+
+# toBeNumber
+
+`toBeNumber` — Метод класса `Expect`, который проверяет, что фактическое значение является
+числом.
+
+## Сигнатура метода
+
+```ts
+toBeNumber(message?: string): boolean;
+```
+
+## Описание
+
+Метод `toBeNumber` используется для проверки, что фактическое значение (`actual`) является числом.
+Если значение не является числом, выбрасывается ошибка типа `TypeError` с указанным сообщением.
+
+## Параметры
+
+- `message` (string): Сообщение об ошибке, если значение не является числом. По умолчанию пустая
+  строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является числом.
+
+## Примеры использования
+
+1. Проверка значения, являющегося числом:
+
+    ```js
+    const expect = new Expect(123);
+    expect.toBeNumber(); // true
+    ```
+
+2. Проверка значения, не являющегося числом:
+
+    ```js
+    const expect = new Expect('123');
+    try {
+        expect.toBeNumber('Значение должно быть числом');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть числом
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является числом.

package/docs/classes/Expect/toBeNumeric.md

@@ -0,0 +1,53 @@
+[Главная](../../../README.md) / [Классы](../classes.md) / [Expect](./Expect.md) / toBeNumeric
+
+[Исходный код](../../../src/classes/Expect.mjs)
+
+# toBeNumeric
+
+`toBeNumeric` — Метод класса `Expect`, который проверяет, что фактическое значение является
+числовым.
+
+## Сигнатура метода
+
+```ts
+toBeNumeric(message?: string): boolean;
+```
+
+## Описание
+
+Метод `toBeNumeric` используется для проверки, что фактическое значение (`actual`) является
+числовым. Если значение не является числовым, выбрасывается ошибка типа `TypeError` с указанным
+сообщением.
+
+## Параметры
+
+- `message` (string): Сообщение об ошибке, если значение не является числовым. По умолчанию пустая
+  строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является числовым.
+
+## Примеры использования
+
+1. Проверка значения, являющегося числовым:
+
+    ```js
+    const expect = new Expect('123');
+    expect.toBeNumeric(); // true
+    ```
+
+2. Проверка значения, не являющегося числовым:
+
+    ```js
+    const expect = new Expect('abc');
+    try {
+        expect.toBeNumeric('Значение должно быть числовым');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть числовым
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является числовым.

package/docs/classes/Expect/toBeObject.md

@@ -0,0 +1,52 @@
+[Главная](../../../README.md) / [Классы](../classes.md) / [Expect](./Expect.md) / toBeObject
+
+[Исходный код](../../../src/classes/Expect.mjs)
+
+# toBeObject
+
+`toBeObject` — Метод класса `Expect`, который проверяет, что фактическое значение является
+объектом.
+
+## Сигнатура метода
+
+```ts
+toBeObject(message?: string): boolean;
+```
+
+## Описание
+
+Метод `toBeObject` используется для проверки, что фактическое значение (`actual`) является объектом.
+Если значение не является объектом, выбрасывается ошибка типа `TypeError` с указанным сообщением.
+
+## Параметры
+
+- `message` (string): Сообщение об ошибке, если значение не является объектом. По умолчанию пустая
+  строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является объектом.
+
+## Примеры использования
+
+1. Проверка значения, являющегося объектом:
+
+    ```js
+    const expect = new Expect({ a: 1, b: 2 });
+    expect.toBeObject(); // true
+    ```
+
+2. Проверка значения, не являющегося объектом:
+
+    ```js
+    const expect = new Expect(123);
+    try {
+        expect.toBeObject('Значение должно быть объектом');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть объектом
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является объектом.

package/docs/classes/Expect/toBeScalar.md

@@ -0,0 +1,53 @@
+[Главная](../../../README.md) / [Классы](../classes.md) / [Expect](./Expect.md) / toBeScalar
+
+[Исходный код](../../../src/classes/Expect.mjs)
+
+# toBeScalar
+
+`toBeScalar` — Метод класса `Expect`, который проверяет, что фактическое значение является
+скалярным (boolean, number, string, или symbol).
+
+## Сигнатура метода
+
+```ts
+toBeScalar(message?: string): boolean;
+```
+
+## Описание
+
+Метод `toBeScalar` используется для проверки, что фактическое значение (`actual`) является скалярным
+(boolean, number, string, или symbol). Если значение не является скалярным, выбрасывается ошибка
+типа `TypeError` с указанным сообщением.
+
+## Параметры
+
+- `message` (string): Сообщение об ошибке, если значение не является скалярным. По умолчанию пустая
+  строка.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является скалярным.
+
+## Примеры использования
+
+1. Проверка значения, являющегося скалярным:
+
+    ```js
+    const expect = new Expect(123);
+    expect.toBeScalar(); // true
+    ```
+
+2. Проверка значения, не являющегося скалярным:
+
+    ```js
+    const expect = new Expect([1, 2, 3]);
+    try {
+        expect.toBeScalar('Значение должно быть скалярным');
+    } catch (e) {
+        console.error(e.message); // Значение должно быть скалярным
+    }
+    ```
+
+## Исключения
+
+- `TypeError`: Если значение не является скалярным.