@rogolev/value 0.0.2 → 0.0.3

package/docs/constants.md

@@ -0,0 +1,47 @@
+[Главная](../README.md) / Константы
+
+# Константы
+
+Этот файл содержит константы, используемые для определения типов данных в библиотеке.
+
+## Сигнатура
+
+```ts
+export const TYPE_NULL: string;
+export const TYPE_NAN: string;
+export const TYPE_UNDEFINED: string;
+export const TYPE_INFINITY: string;
+export const TYPE_BOOLEAN: string;
+export const TYPE_INTEGER: string;
+export const TYPE_BIGINT: string;
+export const TYPE_FLOAT: string;
+export const TYPE_STRING: string;
+export const TYPE_SYMBOL: string;
+export const TYPE_CLASS: string;
+export const TYPE_FUNCTION: string;
+export const TYPE_ARRAY: string;
+export const TYPE_OBJECT: string;
+```
+
+## Описание
+
+Константы используются для определения типов данных в библиотеке. Они представляют собой строки,
+которые описывают различные типы данных.
+
+### Константы
+
+- `TYPE_NULL` — Представляет тип `null`.
+- `TYPE_NAN` — Представляет тип `NaN`.
+- `TYPE_UNDEFINED` — Представляет тип `undefined`.
+- `TYPE_INFINITY` — Представляет тип `infinity`.
+- `TYPE_BOOLEAN` — Представляет тип `boolean`.
+- `TYPE_INTEGER` — Представляет тип `integer`.
+- `TYPE_BIGINT` — Представляет тип `bigint`.
+- `TYPE_FLOAT` — Представляет тип `float`.
+- `TYPE_STRING` — Представляет тип `string`.
+- `TYPE_SYMBOL` — Представляет тип `symbol`.
+- `TYPE_CLASS` — Представляет тип `class`.
+- `TYPE_FUNCTION` — Представляет тип `function`.
+- `TYPE_ARRAY` — Представляет тип `array`.
+- `TYPE_OBJECT` — Представляет тип `object`.
+

package/docs/helpers/value.md

@@ -0,0 +1,95 @@
+[Главная](../../README.md) / [Помощники](../helpers.md) / value
+
+[Исходный код](../../src/helpers/value.mjs)
+
+# value
+
+`value` — Создает новый экземпляр класса `Value` с заданным значением.
+
+## Сигнатура функции
+
+```ts
+value(val: any): Value;
+```
+
+## Описание
+
+Функция `value` используется для создания нового экземпляра класса `Value` с переданным значением.
+Это позволяет легко обернуть значение в экземпляр класса `Value` и использовать методы класса для
+работы с этим значением.
+
+## Параметры
+
+- `val` (any): Значение, которое необходимо обернуть в экземпляр класса `Value`.
+
+## Возвращаемое значение
+
+Возвращает новый экземпляр класса `Value` с переданным значением.
+
+## Примеры использования
+
+1. Создание экземпляра класса `Value` с числом:
+
+    ```js
+    const valueInstance = value(123);
+    console.log(valueInstance.get()); // 123
+    console.log(valueInstance.getType()); // 'integer'
+    console.log(valueInstance.isNumber()); // true
+    ```
+
+2. Создание экземпляра класса `Value` со строкой:
+
+    ```js
+    const valueInstance = value('example');
+    console.log(valueInstance.get()); // 'example'
+    console.log(valueInstance.getType()); // 'string'
+    console.log(valueInstance.isString()); // true
+    ```
+
+3. Создание экземпляра класса `Value` с объектом:
+
+    ```js
+    const obj = { key: 'value' };
+    const valueInstance = value(obj);
+    console.log(valueInstance.get()); // { key: 'value' }
+    console.log(valueInstance.getType()); // 'object'
+    console.log(valueInstance.isObject()); // true
+    ```
+
+4. Создание экземпляра класса `Value` с массивом:
+
+    ```js
+    const arr = [1, 2, 3];
+    const valueInstance = value(arr);
+    console.log(valueInstance.get()); // [1, 2, 3]
+    console.log(valueInstance.getType()); // 'array'
+    console.log(valueInstance.isArray()); // true
+    ```
+
+5. Создание экземпляра класса `Value` с булевым значением:
+
+    ```js
+    const valueInstance = value(true);
+    console.log(valueInstance.get()); // true
+    console.log(valueInstance.getType()); // 'boolean'
+    console.log(valueInstance.isBool()); // true
+    ```
+
+6. Создание экземпляра класса `Value` с null:
+
+    ```js
+    const valueInstance = value(null);
+    console.log(valueInstance.get()); // null
+    console.log(valueInstance.getType()); // 'null'
+    console.log(valueInstance.isNull()); // true
+    ```
+
+7. Создание экземпляра класса `Value` с undefined:
+
+    ```js
+    const valueInstance = value(undefined);
+    console.log(valueInstance.get()); // undefined
+    console.log(valueInstance.getType()); // 'undefined'
+    console.log(valueInstance.isUndefined()); // true
+    ```
+

package/docs/helpers.md

@@ -49,3 +49,5 @@
 - [to_list](./helpers/to_list.md) — Преобразует значение в список.
 - [to_object](./helpers/to_object.md) — Преобразует значение в объект.
 - [to_string](./helpers/to_string.md) — Преобразует значение в строку.
+- [value](./helpers/value.md) — Создает новый экземпляр класса `Value` с заданным значением.
+

package/index.mjs

@@ -35,6 +35,9 @@ export { default as empty } from './src/helpers/empty.mjs';
 export { default as settype } from './src/helpers/settype.mjs';
 export { default as print } from './src/helpers/print.mjs';
 export { default as print_type } from './src/helpers/print_type.mjs';
+export { default as value } from './src/helpers/value.mjs';
 export { default as Type } from './src/classes/Type.mjs';
 export { default as Convert } from './src/classes/Convert.mjs';
+export { default as Value } from './src/classes/Value.mjs';
+export * from './src/constants.mjs';
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rogolev/value",
-    "version": "0.0.2",
+    "version": "0.0.3",
     "description": "Библиотека, переосмысливающая типы данных и работу с ними.",
     "type": "module",
     "repository": {
@@ -35,6 +35,7 @@
         "eslint": "^9.18.0",
         "eslint-config-prettier": "^9.1.0",
         "eslint-plugin-prettier": "^5.2.1",
+        "globals": "^15.14.0",
         "jest": "^29.7.0",
         "jest-environment-jsdom": "^29.7.0",
         "prettier": "3.4.2"
@@ -45,4 +46,3 @@
         "test": "jest"
     }
 }
-