@rogolev/value 0.0.2 → 0.0.3

package/src/constants.mjs

@@ -0,0 +1,14 @@
+export const TYPE_NULL = 'null';
+export const TYPE_NAN = 'NaN';
+export const TYPE_UNDEFINED = 'undefined';
+export const TYPE_INFINITY = 'infinity';
+export const TYPE_BOOLEAN = 'boolean';
+export const TYPE_INTEGER = 'integer';
+export const TYPE_BIGINT = 'bigint';
+export const TYPE_FLOAT = 'float';
+export const TYPE_STRING = 'string';
+export const TYPE_SYMBOL = 'symbol';
+export const TYPE_CLASS = 'class';
+export const TYPE_FUNCTION = 'function';
+export const TYPE_ARRAY = 'array';
+export const TYPE_OBJECT = 'object';

package/src/helpers/array.mjs

@@ -1,107 +1,107 @@
-import is_array from './is_array.mjs';
-import is_assoc from './is_assoc.mjs';
-
-/**
- * Создаёт массив из переданных значений, обрабатывая ассоциативные массивы (объекты с ключами).
- *
- * ### Параметры
- *
- * - `values` {...any}
- *
- *      Один или несколько элементов, которые могут быть массивами, объектами или другими значениями.
- *
- * ### Описание
- *
- * Функция принимает произвольное количество аргументов и возвращает массив, содержащий переданные значения.
- * Если среди переданных значений есть ассоциативные массивы (объекты, не являющиеся массивами и с ненулевым прототипом),
- * они преобразуются:
- *
- * - Создаётся новый объект без прототипа.
- * - Добавляются все свойства исходного объекта.
- * - Добавляется итератор, позволяющий использовать объект в цикле `for-of` для получения пар `[ключ, значение]`.
- *
- * Если передано только одно значение, и это массив, функция возвращает его напрямую.
- *
- * ### Возвращаемое значение
- *
- * Массив, содержащий переданные значения, с преобразованием ассоциативных массивов.
- * Если передано одно значение и это массив, возвращается он сам.
- *
- * ### Примеры использования
- *
- * 1. Простые массивы:
- *
- *     ```js
- *     const result = array([1, 2, 3]);
- *     console.log(result); // [1, 2, 3]
- *     ```
- *
- * 2. Ассоциативные массивы (объекты с ключами и значениями):
- *
- *     ```js
- *     const result = array({ foo: 'bar', baz: 42 });
- *     for (const [key, value] of result[0]) {
- *         console.log(key, value);
- *     }
- *     // Вывод:
- *     // foo bar
- *     // baz 42
- *     ```
- *
- * 3. Смешанные значения:
- *
- *     ```js
- *     const result = array([1, 2, 3], { foo: 'bar' }, 'hello');
- *     console.log(result);
- *     // Вывод: [[1, 2, 3], { foo: 'bar' }, 'hello']
- *     ```
- *
- * 4. Объекты, созданные без прототипа:
- *
- *     ```js
- *     const noProtoObject = Object.create(null);
- *     noProtoObject.foo = 'bar';
- *     const result = array(noProtoObject);
- *     for (const [key, value] of result[0]) {
- *         console.log(key, value);
- *     }
- *     // Вывод:
- *     // foo bar
- *     ```
- *
- * @param {...any} values - Один или несколько элементов, которые могут быть массивами, объектами или другими значениями.
- * @returns {Array|Object} Массив, содержащий переданные значения, с преобразованием ассоциативных массивов.
- * Если передано одно значение и это массив, возвращается он сам.
- */
-export default function array(...values) {
-    const result = [];
-
-    for (const value of values) {
-        if (is_assoc(value)) {
-            const assoc = Object.create(null);
-
-            Object.assign(assoc, value);
-
-            Object.defineProperty(assoc, Symbol.iterator, {
-                enumerable: false,
-                writable: true,
-                configurable: true,
-                *value() {
-                    for (const key in this) {
-                        yield [key, this[key]];
-                    }
-                },
-            });
-
-            result.push(assoc);
-        } else {
-            result.push(value);
-        }
-    }
-
-    if (result.length === 1 && is_array(result[0])) {
-        return result[0];
-    }
-
-    return result;
-}
+import is_array from './is_array.mjs';
+import is_assoc from './is_assoc.mjs';
+
+/**
+ * Создаёт массив из переданных значений, обрабатывая ассоциативные массивы (объекты с ключами).
+ *
+ * ### Параметры
+ *
+ * - `values` {...any}
+ *
+ *      Один или несколько элементов, которые могут быть массивами, объектами или другими значениями.
+ *
+ * ### Описание
+ *
+ * Функция принимает произвольное количество аргументов и возвращает массив, содержащий переданные значения.
+ * Если среди переданных значений есть ассоциативные массивы (объекты, не являющиеся массивами и с ненулевым прототипом),
+ * они преобразуются:
+ *
+ * - Создаётся новый объект без прототипа.
+ * - Добавляются все свойства исходного объекта.
+ * - Добавляется итератор, позволяющий использовать объект в цикле `for-of` для получения пар `[ключ, значение]`.
+ *
+ * Если передано только одно значение, и это массив, функция возвращает его напрямую.
+ *
+ * ### Возвращаемое значение
+ *
+ * Массив, содержащий переданные значения, с преобразованием ассоциативных массивов.
+ * Если передано одно значение и это массив, возвращается он сам.
+ *
+ * ### Примеры использования
+ *
+ * 1. Простые массивы:
+ *
+ *     ```js
+ *     const result = array([1, 2, 3]);
+ *     console.log(result); // [1, 2, 3]
+ *     ```
+ *
+ * 2. Ассоциативные массивы (объекты с ключами и значениями):
+ *
+ *     ```js
+ *     const result = array({ foo: 'bar', baz: 42 });
+ *     for (const [key, value] of result[0]) {
+ *         console.log(key, value);
+ *     }
+ *     // Вывод:
+ *     // foo bar
+ *     // baz 42
+ *     ```
+ *
+ * 3. Смешанные значения:
+ *
+ *     ```js
+ *     const result = array([1, 2, 3], { foo: 'bar' }, 'hello');
+ *     console.log(result);
+ *     // Вывод: [[1, 2, 3], { foo: 'bar' }, 'hello']
+ *     ```
+ *
+ * 4. Объекты, созданные без прототипа:
+ *
+ *     ```js
+ *     const noProtoObject = Object.create(null);
+ *     noProtoObject.foo = 'bar';
+ *     const result = array(noProtoObject);
+ *     for (const [key, value] of result[0]) {
+ *         console.log(key, value);
+ *     }
+ *     // Вывод:
+ *     // foo bar
+ *     ```
+ *
+ * @param {...any} values - Один или несколько элементов, которые могут быть массивами, объектами или другими значениями.
+ * @returns {Array|Object} Массив, содержащий переданные значения, с преобразованием ассоциативных массивов.
+ * Если передано одно значение и это массив, возвращается он сам.
+ */
+export default function array(...values) {
+    const result = [];
+
+    for (const value of values) {
+        if (is_assoc(value)) {
+            const assoc = Object.create(null);
+
+            Object.assign(assoc, value);
+
+            Object.defineProperty(assoc, Symbol.iterator, {
+                enumerable: false,
+                writable: true,
+                configurable: true,
+                *value() {
+                    for (const key in this) {
+                        yield [key, this[key]];
+                    }
+                },
+            });
+
+            result.push(assoc);
+        } else {
+            result.push(value);
+        }
+    }
+
+    if (result.length === 1 && is_array(result[0])) {
+        return result[0];
+    }
+
+    return result;
+}

package/src/helpers/empty.mjs

@@ -1,70 +1,70 @@
-import to_bool from './to_bool.mjs';
-
-/**
- * Проверяет, является ли переменная пустой.
- *
- * ### Описание
- *
- * Функция `empty` используется для проверки, является ли переменная пустой. Пустыми считаются значения `null`, `undefined`, пустая строка, `0`, `false`, пустой массив и пустой объект.
- *
- * ### Параметры
- *
- * - `value` (any)
- *      Переменная, которую необходимо проверить на пустоту.
- *
- * ### Возвращаемое значение
- *
- * Возвращает `true`, если переменная пустая, и `false` в противном случае.
- *
- * ### Примеры использования
- *
- * 1. Проверка пустых значений:
- *
- *    ```js
- *    const result1 = empty(null);
- *    // Результат: true
- *
- *    const result2 = empty(undefined);
- *    // Результат: true
- *
- *    const result3 = empty('');
- *    // Результат: true
- *
- *    const result4 = empty(0);
- *    // Результат: true
- *
- *    const result5 = empty(false);
- *    // Результат: true
- *
- *    const result6 = empty([]);
- *    // Результат: true
- *
- *    const result7 = empty({});
- *    // Результат: true
- *    ```
- *
- * 2. Проверка непустых значений:
- *
- *    ```js
- *    const result1 = empty('example');
- *    // Результат: false
- *
- *    const result2 = empty(123);
- *    // Результат: false
- *
- *    const result3 = empty(true);
- *    // Результат: false
- *
- *    const result4 = empty([1, 2, 3]);
- *    // Результат: false
- *
- *    const result5 = empty({ key: 'value' });
- *    // Результат: false
- *    ```
- *
- * @param {any} value Переменная, которую необходимо проверить на пустоту.
- * @returns {boolean} Возвращает `true`, если переменная пустая, и `false` в противном случае.
- */
-export default function empty(value) {
-    return !to_bool(value);
-}
+import to_bool from './to_bool.mjs';
+
+/**
+ * Проверяет, является ли переменная пустой.
+ *
+ * ### Описание
+ *
+ * Функция `empty` используется для проверки, является ли переменная пустой. Пустыми считаются значения `null`, `undefined`, пустая строка, `0`, `false`, пустой массив и пустой объект.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Переменная, которую необходимо проверить на пустоту.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает `true`, если переменная пустая, и `false` в противном случае.
+ *
+ * ### Примеры использования
+ *
+ * 1. Проверка пустых значений:
+ *
+ *    ```js
+ *    const result1 = empty(null);
+ *    // Результат: true
+ *
+ *    const result2 = empty(undefined);
+ *    // Результат: true
+ *
+ *    const result3 = empty('');
+ *    // Результат: true
+ *
+ *    const result4 = empty(0);
+ *    // Результат: true
+ *
+ *    const result5 = empty(false);
+ *    // Результат: true
+ *
+ *    const result6 = empty([]);
+ *    // Результат: true
+ *
+ *    const result7 = empty({});
+ *    // Результат: true
+ *    ```
+ *
+ * 2. Проверка непустых значений:
+ *
+ *    ```js
+ *    const result1 = empty('example');
+ *    // Результат: false
+ *
+ *    const result2 = empty(123);
+ *    // Результат: false
+ *
+ *    const result3 = empty(true);
+ *    // Результат: false
+ *
+ *    const result4 = empty([1, 2, 3]);
+ *    // Результат: false
+ *
+ *    const result5 = empty({ key: 'value' });
+ *    // Результат: false
+ *    ```
+ *
+ * @param {any} value Переменная, которую необходимо проверить на пустоту.
+ * @returns {boolean} Возвращает `true`, если переменная пустая, и `false` в противном случае.
+ */
+export default function empty(value) {
+    return !to_bool(value);
+}

package/src/helpers/gettype.mjs

@@ -1,133 +1,149 @@
-import is_array from './is_array.mjs';
-import is_class from './is_class.mjs';
-import is_float from './is_float.mjs';
-import is_infinity from './is_infinity.mjs';
-import is_int from './is_int.mjs';
-import is_nan from './is_nan.mjs';
-import is_null from './is_null.mjs';
-import is_object from './is_object.mjs';
-import is_bigint from './is_bigint.mjs';
-import is_undefined from './is_undefined.mjs';
-import is_bool from './is_bool.mjs';
-import is_string from './is_string.mjs';
-import is_symbol from './is_symbol.mjs';
-import is_function from './is_function.mjs';
-
-/**
- * Определяет тип переданного значения.
- *
- * ### Параметры
- *
- * - `value` (any)
- *      Значение, тип которого необходимо определить.
- *
- * ### Описание
- *
- * Функция `gettype` определяет тип переданного значения, используя различные проверки.
- *
- * Она выполняет следующие проверки:
- *
- * 1. **Null**: Проверяет, является ли значение `null`.
- * 2. **NaN**: Проверяет, является ли значение `NaN`.
- * 3. **Undefined**: Проверяет, является ли значение `undefined`.
- * 4. **Infinity**: Проверяет, является ли значение бесконечностью.
- * 5. **Boolean**: Проверяет, является ли значение логическим.
- * 6. **Integer**: Проверяет, является ли значение целым числом.
- * 7. **BigInt**: Проверяет, является ли значение типом BigInt.
- * 8. **Float**: Проверяет, является ли значение числом с плавающей точкой.
- * 9. **String**: Проверяет, является ли значение строкой.
- * 10. **Symbol**: Проверяет, является ли значение символом.
- * 11. **Class**: Проверяет, является ли значение классом.
- * 12. **Function**: Проверяет, является ли значение функцией.
- * 13. **Array**: Проверяет, является ли значение массивом.
- * 14. **Object**: Проверяет, является ли значение объектом.
- *
- * Если значение не соответствует ни одному из этих типов, функция возвращает результат `typeof value`.
- *
- * ### Возвращаемое значение
- *
- * Возвращает строку, представляющую тип значения.
- *
- * ### Примеры использования
- *
- * ```js
- * class MyClass {}
- *
- * gettype(null); // "null"
- * gettype(NaN); // "NaN"
- * gettype(undefined); // "undefined"
- * gettype(Infinity); // "infinity"
- * gettype(true); // "boolean"
- * gettype(42); // "integer"
- * gettype(BigInt(123456)); // "bigint"
- * gettype(3.14); // "float"
- * gettype('hello'); // "string"
- * gettype(Symbol('symbol')); // "symbol"
- * gettype(MyClass); // "class"
- * gettype(() => {}); // "function"
- * gettype([]); // "array"
- * gettype(new MyClass()); // "object"
- * ```
- *
- * @param {any} value Значение, тип которого необходимо определить.
- * @returns {string} Возвращает строку, представляющую тип значения.
- */
-export default function gettype(value) {
-    if (is_null(value)) {
-        return 'null';
-    }
-
-    if (is_nan(value)) {
-        return 'NaN';
-    }
-
-    if (is_undefined(value)) {
-        return 'undefined';
-    }
-
-    if (is_infinity(value)) {
-        return 'infinity';
-    }
-
-    if (is_bool(value)) {
-        return 'boolean';
-    }
-
-    if (is_int(value)) {
-        return 'integer';
-    }
-
-    if (is_bigint(value)) {
-        return 'bigint';
-    }
-
-    if (is_float(value)) {
-        return 'float';
-    }
-
-    if (is_string(value)) {
-        return 'string';
-    }
-
-    if (is_symbol(value)) {
-        return 'symbol';
-    }
-
-    if (is_class(value)) {
-        return 'class';
-    }
-
-    if (is_function(value)) {
-        return 'function';
-    }
-
-    if (is_array(value)) {
-        return 'array';
-    }
-
-    if (is_object(value)) {
-        return 'object';
-    }
-
-    return typeof value;
-}
+import is_array from './is_array.mjs';
+import is_class from './is_class.mjs';
+import is_float from './is_float.mjs';
+import is_infinity from './is_infinity.mjs';
+import is_int from './is_int.mjs';
+import is_nan from './is_nan.mjs';
+import is_null from './is_null.mjs';
+import is_object from './is_object.mjs';
+import is_bigint from './is_bigint.mjs';
+import is_undefined from './is_undefined.mjs';
+import is_bool from './is_bool.mjs';
+import is_string from './is_string.mjs';
+import is_symbol from './is_symbol.mjs';
+import is_function from './is_function.mjs';
+import {
+    TYPE_ARRAY,
+    TYPE_BIGINT,
+    TYPE_BOOLEAN,
+    TYPE_CLASS,
+    TYPE_FLOAT,
+    TYPE_FUNCTION,
+    TYPE_INFINITY,
+    TYPE_INTEGER,
+    TYPE_NAN,
+    TYPE_NULL,
+    TYPE_OBJECT,
+    TYPE_STRING,
+    TYPE_SYMBOL,
+    TYPE_UNDEFINED,
+} from '../constants.mjs';
+
+/**
+ * Определяет тип переданного значения.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Значение, тип которого необходимо определить.
+ *
+ * ### Описание
+ *
+ * Функция `gettype` определяет тип переданного значения, используя различные проверки.
+ *
+ * Она выполняет следующие проверки:
+ *
+ * 1. **Null**: Проверяет, является ли значение `null`.
+ * 2. **NaN**: Проверяет, является ли значение `NaN`.
+ * 3. **Undefined**: Проверяет, является ли значение `undefined`.
+ * 4. **Infinity**: Проверяет, является ли значение бесконечностью.
+ * 5. **Boolean**: Проверяет, является ли значение логическим.
+ * 6. **Integer**: Проверяет, является ли значение целым числом.
+ * 7. **BigInt**: Проверяет, является ли значение типом BigInt.
+ * 8. **Float**: Проверяет, является ли значение числом с плавающей точкой.
+ * 9. **String**: Проверяет, является ли значение строкой.
+ * 10. **Symbol**: Проверяет, является ли значение символом.
+ * 11. **Class**: Проверяет, является ли значение классом.
+ * 12. **Function**: Проверяет, является ли значение функцией.
+ * 13. **Array**: Проверяет, является ли значение массивом.
+ * 14. **Object**: Проверяет, является ли значение объектом.
+ *
+ * Если значение не соответствует ни одному из этих типов, функция возвращает результат `typeof value`.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает строку, представляющую тип значения.
+ *
+ * ### Примеры использования
+ *
+ * ```js
+ * class MyClass {}
+ *
+ * gettype(null); // "null"
+ * gettype(NaN); // "NaN"
+ * gettype(undefined); // "undefined"
+ * gettype(Infinity); // "infinity"
+ * gettype(true); // "boolean"
+ * gettype(42); // "integer"
+ * gettype(BigInt(123456)); // "bigint"
+ * gettype(3.14); // "float"
+ * gettype('hello'); // "string"
+ * gettype(Symbol('symbol')); // "symbol"
+ * gettype(MyClass); // "class"
+ * gettype(() => {}); // "function"
+ * gettype([]); // "array"
+ * gettype(new MyClass()); // "object"
+ * ```
+ *
+ * @param {any} value Значение, тип которого необходимо определить.
+ * @returns {string} Возвращает строку, представляющую тип значения.
+ */
+export default function gettype(value) {
+    if (is_null(value)) {
+        return TYPE_NULL;
+    }
+
+    if (is_nan(value)) {
+        return TYPE_NAN;
+    }
+
+    if (is_undefined(value)) {
+        return TYPE_UNDEFINED;
+    }
+
+    if (is_infinity(value)) {
+        return TYPE_INFINITY;
+    }
+
+    if (is_bool(value)) {
+        return TYPE_BOOLEAN;
+    }
+
+    if (is_int(value)) {
+        return TYPE_INTEGER;
+    }
+
+    if (is_bigint(value)) {
+        return TYPE_BIGINT;
+    }
+
+    if (is_float(value)) {
+        return TYPE_FLOAT;
+    }
+
+    if (is_string(value)) {
+        return TYPE_STRING;
+    }
+
+    if (is_symbol(value)) {
+        return TYPE_SYMBOL;
+    }
+
+    if (is_class(value)) {
+        return TYPE_CLASS;
+    }
+
+    if (is_function(value)) {
+        return TYPE_FUNCTION;
+    }
+
+    if (is_array(value)) {
+        return TYPE_ARRAY;
+    }
+
+    if (is_object(value)) {
+        return TYPE_OBJECT;
+    }
+
+    return typeof value;
+}