@rogolev/value 0.0.1

package/docs/helpers/is_bool.md

@@ -0,0 +1,50 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / is_bool
+
+[Исходный код](../../src/helpers/is_bool.mjs)
+
+# is_bool
+
+`is_bool` — Проверяет, является ли переданное значение логическим типом (`boolean`).
+
+## Сигнатура функции
+
+```ts
+function is_bool(value: any): boolean;
+```
+
+## Параметры
+
+- `value` (any)
+
+    Проверяемая переменная.
+
+## Описание
+
+В JavaScript логическое значение может быть только двумя состояниями: `true` или `false`.  
+Функция проверяет тип переданного значения с использованием оператора `typeof`.  
+Если значение является примитивом типа `boolean`, функция возвращает `true`.  
+Для всех других типов (включая объекты, строки, числа, `null`, `undefined` и другие) функция вернёт
+`false`.
+
+### Примечание
+
+- Функция возвращает `false` для объектов типа `Boolean`, созданных с помощью конструктора
+  `new Boolean()`.
+- Возвращает `false` для массивов, объектов и других типов данных, отличных от `boolean`.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение `value` — логическое (`boolean`), иначе `false`.
+
+## Примеры использования
+
+```js
+is_bool(true); // Возвращает: true
+is_bool(false); // Возвращает: true
+is_bool(0); // Возвращает: false
+is_bool('true'); // Возвращает: false
+is_bool(null); // Возвращает: false
+is_bool([]); // Возвращает: false
+is_bool({}); // Возвращает: false
+is_bool(new Boolean(true)); // Возвращает: false
+```

package/docs/helpers/is_boolean.md

@@ -0,0 +1,50 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / is_boolean
+
+[Исходный код](../../src/helpers/is_boolean.mjs)
+
+# is_boolean
+
+`is_boolean` — Проверяет, является ли переданное значение логическим типом (`boolean`).
+
+## Сигнатура функции
+
+```ts
+function is_boolean(value: any): boolean;
+```
+
+## Параметры
+
+- `value` (any)
+
+    Проверяемая переменная.
+
+## Описание
+
+В JavaScript логическое значение может быть только двумя состояниями: `true` или `false`.  
+Функция проверяет тип переданного значения с использованием оператора `typeof`.  
+Если значение является примитивом типа `boolean`, функция возвращает `true`.  
+Для всех других типов (включая объекты, строки, числа, `null`, `undefined` и другие) функция вернёт
+`false`.
+
+### Примечание
+
+- Функция возвращает `false` для объектов типа `Boolean`, созданных с помощью конструктора
+  `new Boolean()`.
+- Возвращает `false` для массивов, объектов и других типов данных, отличных от `boolean`.
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение `value` — логическое (`boolean`), иначе `false`.
+
+## Примеры использования
+
+```js
+is_boolean(true); // Возвращает: true
+is_boolean(false); // Возвращает: true
+is_boolean(0); // Возвращает: false
+is_boolean('true'); // Возвращает: false
+is_boolean(null); // Возвращает: false
+is_boolean([]); // Возвращает: false
+is_boolean({}); // Возвращает: false
+is_boolean(new Boolean(true)); // Возвращает: false
+```

package/docs/helpers/is_class.md

@@ -0,0 +1,73 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / is_class
+
+[Исходный код](../../src/helpers/is_class.mjs)
+
+# is_class
+
+`is_class` — Проверяет, является ли переданная переменная классом.
+
+## Сигнатура функции
+
+```ts
+function is_class(value: any): boolean;
+```
+
+## Параметры
+
+- `value` (any): Проверяемая переменная.
+
+## Описание
+
+В JavaScript классы являются функциями, но с уникальным поведением.
+
+Для определения класса функция проверяет:
+
+1. Что переданная переменная является функцией.
+2. Что строковое представление функции начинается с `class `.
+
+### Примечание
+
+Конструкторы функций, созданные с помощью `function`, не будут распознаны как классы.
+
+Пример:
+
+```js
+function Foo() {}
+is_class(Foo); // Возвращает: false
+```
+
+В отличие от классов, которые выглядят так:
+
+```js
+class MyClass {}
+is_class(MyClass); // Возвращает: true
+```
+
+## Возвращаемое значение
+
+Возвращает `true`, если значение является классом, иначе `false`.
+
+## Примеры использования
+
+1. Классы:
+
+```js
+class MyClass {}
+is_class(MyClass); // true
+```
+
+2. Функции-конструкторы:
+
+```js
+function MyFunction() {}
+is_class(MyFunction); // false
+```
+
+3. Объекты и примитивы:
+
+```js
+is_class({}); // false
+is_class([]); // false
+is_class(null); // false
+is_class(42); // false
+```

package/docs/helpers/is_float.md

@@ -0,0 +1,71 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / is_float
+
+[Исходный код](../../src/helpers/is_float.mjs)
+
+# `is_float`
+
+`is_float`
+
+## Сигнатура функции
+
+```ts
+function is_float(value: any): boolean;
+```
+
+## Параметры
+
+- `value` (any)
+
+    Значение, которое необходимо проверить на тип "число с плавающей точкой".
+
+## Описание
+
+Функция `is_float` проверяет, является ли переданное значение числом с дробной частью, которое
+отличается от целого числа. Она работает следующим образом:
+
+1. Проверяет, что значение имеет тип `number`.
+2. Исключает значения `NaN`, которые также относятся к типу `number`, но не считаются числовыми
+   значениями.
+3. Проверяет, что у числа есть дробная часть, проверяя остаток от деления на `1`
+   (`value % 1 !== 0`).
+
+Значения, которые не являются числами или числа без дробной части, не считаются числами с плавающей
+точкой.
+
+## Возвращаемое значение
+
+Функция возвращает `true`, если значение является числом с плавающей точкой, и `false` в противном
+случае.
+
+## Примеры использования
+
+### Пример 1: Проверка чисел с плавающей точкой
+
+```js
+is_float(3.14); // true
+is_float(-0.001); // true
+is_float(2.0); // false (так как 2.0 это эквивалент целому числу)
+```
+
+### Пример 2: Проверка целых чисел
+
+```js
+is_float(5); // false
+is_float(0); // false
+is_float(-10); // false
+```
+
+### Пример 3: Проверка NaN
+
+```js
+is_float(NaN); // false
+```
+
+### Пример 4: Проверка строк и других типов
+
+```js
+is_float('3.14'); // false
+is_float(true); // false
+is_float(null); // false
+is_float(undefined); // false
+```

package/docs/helpers/is_function.md

@@ -0,0 +1,62 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / is_function
+
+[Исходный код](../../src/helpers/is_function.mjs)
+
+# is_function
+
+`is_function` — Проверяет, что значение является функцией, исключая классы.
+
+## Сигнатура функции
+
+```ts
+function is_function(value: any): boolean;
+```
+
+## Параметры
+
+- `value` (any): Проверяемое значение. Может быть любым типом данных.
+
+## Описание
+
+Функция проверяет, является ли переданное значение функцией, исключая классы. В JavaScript функции и
+классы оба являются типом `function`, но классы имеют особый синтаксис и поведение. Функция
+`is_function` различает их, проверяя, начинается ли строковое представление функции с `class`, что
+указывает на то, что это класс, а не обычная функция.
+
+Если значение является функцией (но не классом), функция возвращает `true`. Для всех остальных типов
+данных (включая классы, объекты, примитивы) функция возвращает `false`.
+
+## Возвращаемое значение
+
+Возвращает `true`, если переданное значение является функцией (но не классом). Возвращает `false`,
+если переданное значение является классом или любым другим типом данных.
+
+## Примеры использования
+
+1. Пример 1: обычная функция
+
+```js
+function test() {}
+is_function(test); // Возвращает: true
+```
+
+2. Пример 2: класс
+
+```js
+class MyClass {}
+is_function(MyClass); // Возвращает: false
+```
+
+3. Пример 3: объект
+
+```js
+const obj = {};
+is_function(obj); // Возвращает: false
+```
+
+4. Пример 4: примитив
+
+```js
+is_function(42); // Возвращает: false
+is_function('hello'); // Возвращает: false
+```

package/docs/helpers/is_infinity.md

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

package/docs/helpers/is_int.md

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

package/docs/helpers/is_integer.md

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

package/docs/helpers/is_list.md

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

package/docs/helpers/is_nan.md

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

package/docs/helpers/is_null.md

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