@rogolev/value 0.0.3 → 0.0.5

package/docs/classes/Type/expectList.md

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

package/docs/classes/Type/expectNaN.md

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

package/docs/classes/Type/expectNull.md

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

package/docs/classes/Type/expectNumber.md

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

package/docs/classes/Type/expectNumeric.md

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

package/docs/classes/Type/expectObject.md

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

package/docs/classes/Type/expectScalar.md

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

package/docs/classes/Type/expectString.md

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

package/docs/classes/Type/expectSymbol.md

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

package/docs/classes/Type/expectUndefined.md

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