@rogolev/value 0.0.1 → 0.0.2

package/src/helpers/settype.mjs

@@ -1,101 +1,101 @@
-import to_array from './to_array.mjs';
-import to_bool from './to_bool.mjs';
-import to_float from './to_float.mjs';
-import to_int from './to_int.mjs';
-import to_object from './to_object.mjs';
-import to_string from './to_string.mjs';
-
-/**
- * Приводит значение переменной к указанному типу.
- *
- * ### Описание
- *
- * Функция `settype` используется для преобразования значения переменной к указанному типу. Поддерживаются типы: `boolean`, `integer`, `float`, `string`, `array`, `object`.
- *
- * ### Параметры
- *
- * - `value` (any)
- *      Переменная, значение которой необходимо привести к указанному типу.
- *
- * - `type` (string)
- *      Тип, к которому необходимо привести значение переменной.
- *
- * ### Возвращаемое значение
- *
- * Возвращает значение переменной, приведенное к указанному типу.
- *
- * ### Примеры использования
- *
- * 1. Преобразование в булевое значение:
- *
- *    ```js
- *    const result = settype('true', 'boolean');
- *    // Результат: true
- *    ```
- *
- * 2. Преобразование в целое число:
- *
- *    ```js
- *    const result = settype('123', 'integer');
- *    // Результат: 123
- *    ```
- *
- * 3. Преобразование в число с плавающей точкой:
- *
- *    ```js
- *    const result = settype('123.45', 'float');
- *    // Результат: 123.45
- *    ```
- *
- * 4. Преобразование в строку:
- *
- *    ```js
- *    const result = settype(123, 'string');
- *    // Результат: '123'
- *    ```
- *
- * 5. Преобразование в массив:
- *
- *    ```js
- *    const result = settype('example', 'array');
- *    // Результат: ['example']
- *    ```
- *
- * 6. Преобразование в объект:
- *
- *    ```js
- *    const result = settype('example', 'object');
- *    // Результат: { value: 'example' }
- *    ```
- *
- * @param {any} value Переменная, значение которой необходимо привести к указанному типу.
- * @param {string} type Тип, к которому необходимо привести значение переменной.
- * @returns {any} Возвращает значение переменной, приведенное к указанному типу.
- */
-export default function settype(value, type) {
-    if (type === 'boolean' || type === 'bool') {
-        return to_bool(value);
-    }
-
-    if (type === 'integer' || type === 'int') {
-        return to_int(value);
-    }
-
-    if (type === 'float') {
-        return to_float(value);
-    }
-
-    if (type === 'string') {
-        return to_string(value);
-    }
-
-    if (type === 'array') {
-        return to_array(value);
-    }
-
-    if (type === 'object') {
-        return to_object(value);
-    }
-
-    return value;
-}
+import to_array from './to_array.mjs';
+import to_bool from './to_bool.mjs';
+import to_float from './to_float.mjs';
+import to_int from './to_int.mjs';
+import to_object from './to_object.mjs';
+import to_string from './to_string.mjs';
+
+/**
+ * Приводит значение переменной к указанному типу.
+ *
+ * ### Описание
+ *
+ * Функция `settype` используется для преобразования значения переменной к указанному типу. Поддерживаются типы: `boolean`, `integer`, `float`, `string`, `array`, `object`.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Переменная, значение которой необходимо привести к указанному типу.
+ *
+ * - `type` (string)
+ *      Тип, к которому необходимо привести значение переменной.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает значение переменной, приведенное к указанному типу.
+ *
+ * ### Примеры использования
+ *
+ * 1. Преобразование в булевое значение:
+ *
+ *    ```js
+ *    const result = settype('true', 'boolean');
+ *    // Результат: true
+ *    ```
+ *
+ * 2. Преобразование в целое число:
+ *
+ *    ```js
+ *    const result = settype('123', 'integer');
+ *    // Результат: 123
+ *    ```
+ *
+ * 3. Преобразование в число с плавающей точкой:
+ *
+ *    ```js
+ *    const result = settype('123.45', 'float');
+ *    // Результат: 123.45
+ *    ```
+ *
+ * 4. Преобразование в строку:
+ *
+ *    ```js
+ *    const result = settype(123, 'string');
+ *    // Результат: '123'
+ *    ```
+ *
+ * 5. Преобразование в массив:
+ *
+ *    ```js
+ *    const result = settype('example', 'array');
+ *    // Результат: ['example']
+ *    ```
+ *
+ * 6. Преобразование в объект:
+ *
+ *    ```js
+ *    const result = settype('example', 'object');
+ *    // Результат: { value: 'example' }
+ *    ```
+ *
+ * @param {any} value Переменная, значение которой необходимо привести к указанному типу.
+ * @param {string} type Тип, к которому необходимо привести значение переменной.
+ * @returns {any} Возвращает значение переменной, приведенное к указанному типу.
+ */
+export default function settype(value, type) {
+    if (type === 'boolean' || type === 'bool') {
+        return to_bool(value);
+    }
+
+    if (type === 'integer' || type === 'int') {
+        return to_int(value);
+    }
+
+    if (type === 'float') {
+        return to_float(value);
+    }
+
+    if (type === 'string') {
+        return to_string(value);
+    }
+
+    if (type === 'array') {
+        return to_array(value);
+    }
+
+    if (type === 'object') {
+        return to_object(value);
+    }
+
+    return value;
+}

package/src/helpers/to_array.mjs

@@ -1,118 +1,118 @@
-import array from './array.mjs';
-import is_array from './is_array.mjs';
-import is_null from './is_null.mjs';
-import is_undefined from './is_undefined.mjs';
-
-/**
- * Приводит значение переменной к массиву.
- *
- * ### Описание
- *
- * Функция `to_array` используется для преобразования различных типов данных в массив. Если значение
- * уже является массивом (тип `Array` или ассоциативный массив), возвращается оно же. Объекты
- * (экземпляры классов) преобразуются в массив с одним элементом.
- *
- * #### Примечание
- *
- * Функция `to_array` для объектов (ассоциативных массивов) возвращает результат
- * работы функции `array`, которая создает объект-контейнер пар ключ-значение
- * (ассоциативный массив) с помощью конструкции `Object.create(null)`,
- * копирует все видимые пары в этот контейнер, а также добавляет итератор
- * `Symbol.iterator` для перебора контейнера в цикле `for-of`.
- *
- * ### Параметры
- *
- * - `value` (any)
- *      Переменная, значение которой необходимо привести к массиву.
- *
- * ### Возвращаемое значение
- *
- * Возвращает массив, содержащий переданное значение. Если значение уже является массивом, возвращается оно же.
- *
- * ### Примеры использования
- *
- * 1. Преобразование строки в массив:
- *
- *    ```js
- *    const result = to_array('example');
- *    // Результат: ["example"]
- *    ```
- *
- * 2. Преобразование числа в массив:
- *
- *    ```js
- *    const result = to_array(123);
- *    // Результат: [123]
- *    ```
- *
- * 3. Преобразование массива (без изменений):
- *
- *    ```js
- *    const result = to_array([1, 2, 3]);
- *    // Результат: [1, 2, 3]
- *    ```
- *
- * 4. Преобразование объекта в массив:
- *
- * Функция `to_array` для объектов (ассоциативных массивов) возвращает
- * результат работы функции `array`, которая создает объект-контейнер
- * пар ключ-значение (ассоциативный массив) с помощью конструкции
- * `Object.create(null)`, копирует все видимые пары в этот контейнер,
- * а также добавляет итератор `Symbol.iterator` для перебора контейнера
- * в цикле `for-of`.
- *
- *    ```js
- *    const result = to_array({ key: 'value' });
- *    // Результат: { key: "value" }
- *
- *    const proto = Object.getPrototypeOf(result);
- *    // Результат: null
- *
- *    for (const [key, value] of result) {
- *        console.log(key, value);
- *    }
- *    // Результат: 'key', 'value'
- *    ```
- *
- * 5. Преобразование экземпляра класса в массив:
- *
- *    ```js
- *    class MyClass {}
- *
- *    const instance = new MyClass();
- *    const result = to_array(instance);
- *    // Результат: [instance]
- *    ```
- *
- * 6. Преобразование null:
- *
- *    ```js
- *    const result = to_array(null);
- *    // Результат: []
- *    ```
- *
- * 7. Преобразование undefined:
- *
- *    ```js
- *    const result = to_array(undefined);
- *    // Результат: []
- *    ```
- *
- * @param {any} value Переменная, значение которой необходимо привести к массиву.
- * @returns {Array|Object} Возвращает приведенное к массиву значение переменной `value`.
- */
-export default function to_array(value) {
-    if (is_null(value) || is_undefined(value)) {
-        return [];
-    }
-
-    if (Array.isArray(value)) {
-        return value;
-    }
-
-    if (is_array(value)) {
-        return array(value);
-    }
-
-    return [value];
-}
+import array from './array.mjs';
+import is_array from './is_array.mjs';
+import is_null from './is_null.mjs';
+import is_undefined from './is_undefined.mjs';
+
+/**
+ * Приводит значение переменной к массиву.
+ *
+ * ### Описание
+ *
+ * Функция `to_array` используется для преобразования различных типов данных в массив. Если значение
+ * уже является массивом (тип `Array` или ассоциативный массив), возвращается оно же. Объекты
+ * (экземпляры классов) преобразуются в массив с одним элементом.
+ *
+ * #### Примечание
+ *
+ * Функция `to_array` для объектов (ассоциативных массивов) возвращает результат
+ * работы функции `array`, которая создает объект-контейнер пар ключ-значение
+ * (ассоциативный массив) с помощью конструкции `Object.create(null)`,
+ * копирует все видимые пары в этот контейнер, а также добавляет итератор
+ * `Symbol.iterator` для перебора контейнера в цикле `for-of`.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Переменная, значение которой необходимо привести к массиву.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает массив, содержащий переданное значение. Если значение уже является массивом, возвращается оно же.
+ *
+ * ### Примеры использования
+ *
+ * 1. Преобразование строки в массив:
+ *
+ *    ```js
+ *    const result = to_array('example');
+ *    // Результат: ["example"]
+ *    ```
+ *
+ * 2. Преобразование числа в массив:
+ *
+ *    ```js
+ *    const result = to_array(123);
+ *    // Результат: [123]
+ *    ```
+ *
+ * 3. Преобразование массива (без изменений):
+ *
+ *    ```js
+ *    const result = to_array([1, 2, 3]);
+ *    // Результат: [1, 2, 3]
+ *    ```
+ *
+ * 4. Преобразование объекта в массив:
+ *
+ * Функция `to_array` для объектов (ассоциативных массивов) возвращает
+ * результат работы функции `array`, которая создает объект-контейнер
+ * пар ключ-значение (ассоциативный массив) с помощью конструкции
+ * `Object.create(null)`, копирует все видимые пары в этот контейнер,
+ * а также добавляет итератор `Symbol.iterator` для перебора контейнера
+ * в цикле `for-of`.
+ *
+ *    ```js
+ *    const result = to_array({ key: 'value' });
+ *    // Результат: { key: "value" }
+ *
+ *    const proto = Object.getPrototypeOf(result);
+ *    // Результат: null
+ *
+ *    for (const [key, value] of result) {
+ *        console.log(key, value);
+ *    }
+ *    // Результат: 'key', 'value'
+ *    ```
+ *
+ * 5. Преобразование экземпляра класса в массив:
+ *
+ *    ```js
+ *    class MyClass {}
+ *
+ *    const instance = new MyClass();
+ *    const result = to_array(instance);
+ *    // Результат: [instance]
+ *    ```
+ *
+ * 6. Преобразование null:
+ *
+ *    ```js
+ *    const result = to_array(null);
+ *    // Результат: []
+ *    ```
+ *
+ * 7. Преобразование undefined:
+ *
+ *    ```js
+ *    const result = to_array(undefined);
+ *    // Результат: []
+ *    ```
+ *
+ * @param {any} value Переменная, значение которой необходимо привести к массиву.
+ * @returns {Array|Object} Возвращает приведенное к массиву значение переменной `value`.
+ */
+export default function to_array(value) {
+    if (is_null(value) || is_undefined(value)) {
+        return [];
+    }
+
+    if (Array.isArray(value)) {
+        return value;
+    }
+
+    if (is_array(value)) {
+        return array(value);
+    }
+
+    return [value];
+}

package/src/helpers/to_assoc.mjs

@@ -1,98 +1,98 @@
-import is_array from './is_array.mjs';
-import is_null from './is_null.mjs';
-import is_undefined from './is_undefined.mjs';
-
-/**
- * Преобразует значение в ассоциативный массив.
- *
- * ### Описание
- *
- * Функция `to_assoc` используется для преобразования различных типов данных в ассоциативный массив.
- * Если значение уже является объектом, возвращается оно же. Массивы преобразуются в объекты с
- * индексами в качестве ключей.
- *
- * #### Примечание
- *
- * Функция `to_assoc` для массивов возвращает объект, где ключами являются индексы элементов массива.
- *
- * ### Параметры
- *
- * - `value` (any)
- *      Значение, которое необходимо преобразовать в ассоциативный массив.
- *
- * ### Возвращаемое значение
- *
- * Возвращает объект, представляющий ассоциативный массив. Если значение уже является объектом, возвращается оно же.
- *
- * ### Примеры использования
- *
- * 1. Преобразование строки в ассоциативный массив:
- *
- *    ```js
- *    const result = to_assoc('example');
- *    // Результат: { 0: 'example' }
- *    ```
- *
- * 2. Преобразование числа в ассоциативный массив:
- *
- *    ```js
- *    const result = to_assoc(123);
- *    // Результат: { 0: 123 }
- *    ```
- *
- * 3. Преобразование массива в ассоциативный массив:
- *
- *    ```js
- *    const result = to_assoc([1, 2, 3]);
- *    // Результат: { 0: 1, 1: 2, 2: 3 }
- *    ```
- *
- * 4. Преобразование ассоциативного массива (без изменений):
- *
- *    ```js
- *    const result = to_assoc({ key: 'value' });
- *    // Результат: { key: 'value' }
- *    ```
- *
- * 5. Преобразование экземпляра класса в ассоциативный массив:
- *
- *    ```js
- *    class MyClass {}
- *
- *    const instance = new MyClass();
- *    const result = to_assoc(instance);
- *    // Результат: { 0: instance }
- *    ```
- *
- * 6. Преобразование null:
- *
- *    ```js
- *    const result = to_assoc(null);
- *    // Результат: {}
- *    ```
- *
- * 7. Преобразование undefined:
- *
- *    ```js
- *    const result = to_assoc(undefined);
- *    // Результат: {}
- *    ```
- *
- * @param {any} value Значение, которое необходимо преобразовать.
- * @returns {Object} Возвращает объект, представляющий ассоциативный массив.
- */
-export default function to_assoc(value) {
-    if (is_null(value) || is_undefined(value)) {
-        return {};
-    }
-
-    if (Array.isArray(value)) {
-        return { ...value };
-    }
-
-    if (is_array(value)) {
-        return value;
-    }
-
-    return { 0: value };
-}
+import is_array from './is_array.mjs';
+import is_null from './is_null.mjs';
+import is_undefined from './is_undefined.mjs';
+
+/**
+ * Преобразует значение в ассоциативный массив.
+ *
+ * ### Описание
+ *
+ * Функция `to_assoc` используется для преобразования различных типов данных в ассоциативный массив.
+ * Если значение уже является объектом, возвращается оно же. Массивы преобразуются в объекты с
+ * индексами в качестве ключей.
+ *
+ * #### Примечание
+ *
+ * Функция `to_assoc` для массивов возвращает объект, где ключами являются индексы элементов массива.
+ *
+ * ### Параметры
+ *
+ * - `value` (any)
+ *      Значение, которое необходимо преобразовать в ассоциативный массив.
+ *
+ * ### Возвращаемое значение
+ *
+ * Возвращает объект, представляющий ассоциативный массив. Если значение уже является объектом, возвращается оно же.
+ *
+ * ### Примеры использования
+ *
+ * 1. Преобразование строки в ассоциативный массив:
+ *
+ *    ```js
+ *    const result = to_assoc('example');
+ *    // Результат: { 0: 'example' }
+ *    ```
+ *
+ * 2. Преобразование числа в ассоциативный массив:
+ *
+ *    ```js
+ *    const result = to_assoc(123);
+ *    // Результат: { 0: 123 }
+ *    ```
+ *
+ * 3. Преобразование массива в ассоциативный массив:
+ *
+ *    ```js
+ *    const result = to_assoc([1, 2, 3]);
+ *    // Результат: { 0: 1, 1: 2, 2: 3 }
+ *    ```
+ *
+ * 4. Преобразование ассоциативного массива (без изменений):
+ *
+ *    ```js
+ *    const result = to_assoc({ key: 'value' });
+ *    // Результат: { key: 'value' }
+ *    ```
+ *
+ * 5. Преобразование экземпляра класса в ассоциативный массив:
+ *
+ *    ```js
+ *    class MyClass {}
+ *
+ *    const instance = new MyClass();
+ *    const result = to_assoc(instance);
+ *    // Результат: { 0: instance }
+ *    ```
+ *
+ * 6. Преобразование null:
+ *
+ *    ```js
+ *    const result = to_assoc(null);
+ *    // Результат: {}
+ *    ```
+ *
+ * 7. Преобразование undefined:
+ *
+ *    ```js
+ *    const result = to_assoc(undefined);
+ *    // Результат: {}
+ *    ```
+ *
+ * @param {any} value Значение, которое необходимо преобразовать.
+ * @returns {Object} Возвращает объект, представляющий ассоциативный массив.
+ */
+export default function to_assoc(value) {
+    if (is_null(value) || is_undefined(value)) {
+        return {};
+    }
+
+    if (Array.isArray(value)) {
+        return { ...value };
+    }
+
+    if (is_array(value)) {
+        return value;
+    }
+
+    return { 0: value };
+}