@rogolev/value 0.0.1

package/docs/helpers/is_number.md

@@ -0,0 +1,67 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / is_number
+
+[Исходный код](../../src/helpers/is_number.mjs)
+
+# `is_number`
+
+`is_number` — Проверяет, является ли значение числом.
+
+## Сигнатура функции
+
+```ts
+function is_number(value: any): boolean;
+```
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить на принадлежность к числам.
+
+## Описание
+
+Функция `is_number` предназначена для проверки, является ли переданное значение числом.
+
+Она проверяет:
+
+1. Что значение имеет тип `number`.
+2. Что значение является конечным числом (`Number.isFinite`).
+
+Функция возвращает `false` для бесконечных значений, `NaN`, а также для значений, не принадлежащих
+типу `number`.
+
+## Возвращаемое значение
+
+Функция возвращает:
+
+- `true`, если значение является числом.
+- `false` в противном случае.
+
+## Примеры использования
+
+### Пример 1: Проверка числовых значений
+
+```js
+is_number(42); // true
+is_number(3.14); // true
+is_number(-0.99); // true
+```
+
+### Пример 2: Проверка специальных числовых значений
+
+```js
+is_number(NaN); // false
+is_number(Infinity); // false
+is_number(-Infinity); // false
+```
+
+### Пример 3: Проверка значений других типов
+
+```js
+is_number('42'); // false (строка)
+is_number(true); // false (логическое значение)
+is_number(null); // false
+is_number(undefined); // false
+is_number({}); // false (объект)
+is_number([]); // false (массив)
+```

package/docs/helpers/is_numeric.md

@@ -0,0 +1,76 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / is_numeric
+
+[Исходный код](../../src/helpers/is_numeric.mjs)
+
+# `is_numeric`
+
+`is_numeric` — Проверяет, является ли значение числом или числовой строкой.
+
+## Сигнатура функции
+
+```ts
+function is_numeric(value: any): boolean;
+```
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить на принадлежность к числам или числовым строкам.
+
+## Описание
+
+Функция `is_numeric` предназначена для проверки, является ли переданное значение числом или числовой
+строкой.
+
+Она проверяет:
+
+1. Что значение имеет тип `number` или `string`.
+2. Что значение является конечным числом (`Number.isFinite`).
+3. Что строка может быть преобразована в конечное число.
+
+Функция возвращает `false` для бесконечных значений, `NaN`, а также для значений, не принадлежащих
+типу `number` или `string`.
+
+## Возвращаемое значение
+
+Функция возвращает:
+
+- `true`, если значение является числом или числовой строкой.
+- `false` в противном случае.
+
+## Примеры использования
+
+### Пример 1: Проверка числовых значений
+
+```js
+is_numeric(42); // true
+is_numeric(3.14); // true
+is_numeric(-0.99); // true
+```
+
+### Пример 2: Проверка числовых строк
+
+```js
+is_numeric('42'); // true
+is_numeric('3.14'); // true
+is_numeric('-0.99'); // true
+```
+
+### Пример 3: Проверка специальных числовых значений
+
+```js
+is_numeric(NaN); // false
+is_numeric(Infinity); // false
+is_numeric(-Infinity); // false
+```
+
+### Пример 4: Проверка значений других типов
+
+```js
+is_numeric(true); // false (логическое значение)
+is_numeric(null); // false
+is_numeric(undefined); // false
+is_numeric({}); // false (объект)
+is_numeric([]); // false (массив)
+```

package/docs/helpers/is_object.md

@@ -0,0 +1,69 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / is_object
+
+[Исходный код](../../src/helpers/is_object.mjs)
+
+# is_object
+
+`is_object` — Проверяет, является ли переданная переменная объектом, созданным с
+использованием класса.
+
+## Сигнатура функции
+
+```ts
+function is_object(value: any): boolean;
+```
+
+## Параметры
+
+- `value` (any): Проверяемая переменная.
+
+## Описание
+
+Эта функция использует несколько проверок, чтобы убедиться, что переданное значение:
+
+1. Является объектом (не примитивом, не `null`).
+2. У этого объекта есть прототип, у которого свойство `constructor` ссылается на класс.
+
+Если эти условия выполняются, то функция возвращает `true`, иначе — `false`.
+
+Примечание:
+
+- Функция вернёт `false` для обычных объектов, массивов и функций-конструкторов.
+- Функция вернёт `true` только для объектов, созданных с использованием синтаксиса `class`.
+
+## Возвращаемое значение
+
+Возвращает `true`, если переменная является объектом, созданным с использованием класса, иначе
+`false`.
+
+## Примеры использования
+
+1. Пример с объектом, созданным на основе класса:
+
+```js
+class MyClass {}
+const obj = new MyClass();
+is_object(obj); // true
+```
+
+2. Пример с обычным объектом:
+
+```js
+const obj = {};
+is_object(obj); // false
+```
+
+3. Пример с массивом:
+
+```js
+const arr = [1, 2, 3];
+is_object(arr); // false
+```
+
+4. Пример с функцией-конструктором:
+
+```js
+function MyFunction() {}
+const obj = new MyFunction();
+is_object(obj); // false
+```

package/docs/helpers/is_scalar.md

@@ -0,0 +1,60 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / is_scalar
+
+[Исходный код](../../src/helpers/is_scalar.mjs)
+
+# `is_scalar`
+
+`is_scalar` — Проверяет, является ли значение скалярным.
+
+## Сигнатура функции
+
+```ts
+function is_scalar(value: any): boolean;
+```
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить на принадлежность к скалярным типам.
+
+## Описание
+
+Функция `is_scalar` предназначена для проверки, является ли переданное значение скалярным.
+
+Скалярные типы включают:
+
+- `boolean` (логические значения)
+- `number` (числа)
+- `string` (строки)
+- `symbol` (символы)
+
+Функция возвращает `false` для объектов, массивов, функций, `null` и `undefined`.
+
+## Возвращаемое значение
+
+Функция возвращает:
+
+- `true`, если значение является скалярным.
+- `false` в противном случае.
+
+## Примеры использования
+
+### Пример 1: Проверка скалярных значений
+
+```js
+is_scalar(true); // true
+is_scalar(42); // true
+is_scalar('hello'); // true
+is_scalar(Symbol('symbol')); // true
+```
+
+### Пример 2: Проверка не скалярных значений
+
+```js
+is_scalar(null); // false
+is_scalar(undefined); // false
+is_scalar({}); // false (объект)
+is_scalar([]); // false (массив)
+is_scalar(() => {}); // false (функция)
+```

package/docs/helpers/is_string.md

@@ -0,0 +1,58 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / is_string
+
+[Исходный код](../../src/helpers/is_string.mjs)
+
+# `is_string`
+
+`is_string` — Проверяет, является ли значение строкой.
+
+## Сигнатура функции
+
+```ts
+function is_string(value: any): boolean;
+```
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить на принадлежность к строкам.
+
+## Описание
+
+Функция `is_string` предназначена для проверки, является ли переданное значение строкой.
+
+Она проверяет:
+
+1. Что значение имеет тип `string`.
+
+Функция возвращает `false` для всех значений, не принадлежащих типу `string`.
+
+## Возвращаемое значение
+
+Функция возвращает:
+
+- `true`, если значение является строкой.
+- `false` в противном случае.
+
+## Примеры использования
+
+### Пример 1: Проверка строковых значений
+
+```js
+is_string('hello'); // true
+is_string(''); // true
+is_string(`template string`); // true
+```
+
+### Пример 2: Проверка значений других типов
+
+```js
+is_string(42); // false (число)
+is_string(true); // false (логическое значение)
+is_string(null); // false
+is_string(undefined); // false
+is_string({}); // false (объект)
+is_string([]); // false (массив)
+is_string(() => {}); // false (функция)
+```

package/docs/helpers/is_symbol.md

@@ -0,0 +1,58 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / is_symbol
+
+[Исходный код](../../src/helpers/is_symbol.mjs)
+
+# `is_symbol`
+
+`is_symbol` — Проверяет, является ли значение символом.
+
+## Сигнатура функции
+
+```ts
+function is_symbol(value: any): boolean;
+```
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить на принадлежность к символам.
+
+## Описание
+
+Функция `is_symbol` предназначена для проверки, является ли переданное значение символом.
+
+Она проверяет:
+
+1. Что значение имеет тип `symbol`.
+
+Функция возвращает `false` для всех значений, не принадлежащих типу `symbol`.
+
+## Возвращаемое значение
+
+Функция возвращает:
+
+- `true`, если значение является символом.
+- `false` в противном случае.
+
+## Примеры использования
+
+### Пример 1: Проверка символов
+
+```js
+is_symbol(Symbol('symbol')); // true
+is_symbol(Symbol.iterator); // true
+```
+
+### Пример 2: Проверка значений других типов
+
+```js
+is_symbol('hello'); // false (строка)
+is_symbol(42); // false (число)
+is_symbol(true); // false (логическое значение)
+is_symbol(null); // false
+is_symbol(undefined); // false
+is_symbol({}); // false (объект)
+is_symbol([]); // false (массив)
+is_symbol(() => {}); // false (функция)
+```

package/docs/helpers/is_undefined.md

@@ -0,0 +1,56 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / is_undefined
+
+[Исходный код](../../src/helpers/is_undefined.mjs)
+
+# `is_undefined`
+
+`is_undefined` — Проверяет, является ли значение `undefined`.
+
+## Сигнатура функции
+
+```ts
+function is_undefined(value: any): boolean;
+```
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить на принадлежность к `undefined`.
+
+## Описание
+
+Функция `is_undefined` предназначена для проверки, является ли переданное значение `undefined`.
+
+Она проверяет:
+
+1. Что значение имеет тип `undefined`.
+
+Функция возвращает `false` для всех значений, не принадлежащих типу `undefined`.
+
+## Возвращаемое значение
+
+Функция возвращает:
+
+- `true`, если значение является `undefined`.
+- `false` в противном случае.
+
+## Примеры использования
+
+### Пример 1: Проверка значения `undefined`
+
+```js
+is_undefined(undefined); // true
+```
+
+### Пример 2: Проверка значений других типов
+
+```js
+is_undefined('hello'); // false (строка)
+is_undefined(42); // false (число)
+is_undefined(true); // false (логическое значение)
+is_undefined(null); // false
+is_undefined({}); // false (объект)
+is_undefined([]); // false (массив)
+is_undefined(() => {}); // false (функция)
+```

package/docs/helpers/print.md

@@ -0,0 +1,187 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / print
+
+[Исходный код](../../src/helpers/print.mjs)
+
+# `print`
+
+`print` — Преобразует значение в строку и выводит его на консоль.
+
+## Сигнатура функции
+
+```ts
+function print(value: any, return_result: boolean = false): string | undefined;
+```
+
+## Описание
+
+Функция `print` используется для преобразования различных типов данных в строку и вывода их на
+консоль. Она обрабатывает массивы, объекты, классы, функции, символы и другие типы данных, возвращая
+их строковое представление.
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо преобразовать в строку и вывести на консоль.
+
+- `return_result` (boolean)
+
+    Если `true`, функция возвращает строковое представление значения переменной. Если `false`,
+    функция выводит строковое представление значения переменной на консоль.
+
+## Возвращаемое значение
+
+Функция возвращает:
+
+- Строковое представление значения переменной, если параметр `return_result` равен `true`. В
+  противном случае возвращает `undefined`.
+
+## Примеры использования
+
+### Пример 1: Преобразование строки
+
+```js
+print('example');
+```
+
+Вывод:
+
+    "example"
+
+### Пример 2: Преобразование числа
+
+```js
+print(123);
+```
+
+Вывод:
+
+    123
+
+### Пример 3: Преобразование булевых значений
+
+```js
+print(true);
+```
+
+Вывод:
+
+    true
+
+```js
+print(false);
+```
+
+Вывод:
+
+    false
+
+### Пример 4: Преобразование null и undefined
+
+```js
+print(null);
+```
+
+Вывод:
+
+    null
+
+```js
+print(undefined);
+```
+
+Вывод:
+
+    undefined
+
+### Пример 5: Преобразование массива
+
+```js
+const arr = [1, 2, 3];
+print(arr);
+```
+
+Вывод:
+
+    [
+    	0: 1,
+    	1: 2,
+    	2: 3,
+    ]
+
+### Пример 6: Преобразование ассоциативного массива
+
+```js
+const obj = { key: 'value' };
+print(obj);
+```
+
+Вывод:
+
+    {
+    	key: "value",
+    }
+
+### Пример 7: Преобразование функции
+
+```js
+const func = function () {};
+print(func);
+```
+
+Вывод:
+
+    function func() {}
+
+### Пример 8: Преобразование символа
+
+```js
+const symbol = Symbol('example');
+print(symbol);
+```
+
+Вывод:
+
+    Symbol(example)
+
+### Пример 9: Преобразование класса
+
+```js
+class MyClass {
+    static test = 'test';
+}
+print(MyClass);
+```
+
+Вывод:
+
+    class MyClass {
+    	test = "test";
+    }
+
+### Пример 10: Преобразование экземпляра класса
+
+```js
+class MyClass {
+    test = 'test';
+}
+const instance = new MyClass();
+print(instance);
+```
+
+Вывод:
+
+    object MyClass {
+    	test = "test";
+    }
+
+### Пример 11: Преобразование интерфейса
+
+```js
+class MyContract extends Interface {}
+print(MyContract);
+```
+
+Вывод:
+
+    interface MyContract extends Interface {}