@dxtmisha/wiki 0.39.1 → 0.39.3

package/src/media/functional/functional-basic/geo/geo.en.mdx

@@ -0,0 +1,99 @@
+import {Meta} from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/en/functional-basic/# Geo and Formatting'/>
+
+# Geo and Formatting
+
+Tools for managing localization (i18n), geographic data, and smart formatting. The system automatically detects user settings and ensures correct display of currencies, dates, and numbers according to government standards.
+
+## Localization (Geo)
+Manage global state for country, language, and timezone. Supports browser auto-detection and session persistence.
+
+```javascript
+import { Geo } from '@dxtmisha/functional-basic'
+
+// Global Settings
+Geo.set('en-US', true)      // Set locale and persist in browser
+Geo.setTimezone('-05:00')   // Override timezone offset
+Geo.getCountry()            // 'US'
+
+// Reference data
+const list = Geo.getList()  // Full list of countries and languages
+const current = Geo.getItem() // Current locale data object
+const hasFR = Geo.hasCountry('FR') // Check if country is supported
+```
+
+## Formatting (GeoIntl)
+A universal engine for data formatting built on native `Intl`.
+
+```javascript
+import { GeoIntl } from '@dxtmisha/functional-basic'
+
+const intl = GeoIntl.getInstance()
+
+// Numbers & Currencies
+intl.currency(1000, 'USD')          // '$1,000.00'
+intl.percent(0.15)                  // '15%'
+
+// Dates & Time
+intl.date(new Date(), 'full')       // Full long-form date
+intl.relative(new Date() - 3600000) // '1 hour ago'
+intl.relativeLimit(pastDate, 7)     // Relative (up to 7 days) or absolute date
+
+// Utilities
+intl.plural(5, 'apple|apples')      // Pluralization
+intl.sizeFile(1024 * 1024)          // '1 MB'
+intl.sort(['apple', 'Zebra', 'banana']) // Locale-aware smart sorting
+intl.displayNames('DE', 'region')   // 'Germany' (localized)
+```
+
+## Country Flags (GeoFlag)
+Retrieve flag icons and country names in native or system language.
+
+```javascript
+import { GeoFlag } from '@dxtmisha/functional-basic'
+
+const geoFlag = new GeoFlag('en-US')
+
+// Specific country data
+const ru = geoFlag.get('RU') // { icon: 'f-ru', country: 'Russia', area: '7', ... }
+
+// List names in their native language
+const native = geoFlag.getNational(['DE']) 
+// [{ country: 'Germany', nationalCountry: 'Deutschland', ... }]
+```
+
+## Phones (GeoPhone)
+Auto-detect country by phone number and work with international masks.
+
+```javascript
+import { GeoPhone } from '@dxtmisha/functional-basic'
+
+// Smart Detection
+const { item, phone } = GeoPhone.getByPhone('14155552671') 
+// item — country data (US), phone — cleaned number
+
+// Formatting
+GeoPhone.toMask(phone, item.mask) // '+1 (415) 555-2671'
+GeoPhone.clear(' +1 (415) 555-2671 ') // '14155552671' (cleaning)
+```
+
+## Lists (Formatters)
+Bulk transformation of object arrays. Automatically creates new properties with a `Format` suffix.
+
+```javascript
+import { Formatters } from '@dxtmisha/functional-basic'
+
+const options = {
+  price: { type: 'currency', options: 'USD' },
+  birthday: { type: 'date' },
+  'user.name': { type: 'name' }, // Combines firstName/lastName
+  count: { type: 'plural', options: 'item|items' },
+  status: { 
+    transformation: (v) => v === 1 ? 'Ok' : 'Error' 
+  }
+}
+
+// transformed — copy of data with priceFormat, birthdayFormat, etc.
+const transformed = new Formatters(options, data).to()
+```

package/src/media/functional/functional-basic/geo/geo.ru.mdx

@@ -0,0 +1,99 @@
+import {Meta} from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/ru/functional-basic/# Geo и форматирование'/>
+
+# Geo и форматирование
+
+Инструменты для управления локализацией (i18n), географическими данными и умного форматирования. Система автоматически определяет настройки пользователя и обеспечивает корректное отображение валют, дат и чисел по государственным стандартам.
+
+## Локализация (Geo)
+Управление глобальным состоянием страны, языка и временной зоны. Поддерживает автоопределение по браузеру и сохранение в сессии.
+
+```javascript
+import { Geo } from '@dxtmisha/functional-basic'
+
+// Глобальные настройки
+Geo.set('en-US', true)      // Установить локаль и сохранить в браузере
+Geo.setTimezone('+05:00')   // Переопределить временную зону
+Geo.getCountry()            // 'US'
+
+// Работа со справочниками
+const list = Geo.getList()  // Полный список стран и языков
+const current = Geo.getItem() // Объект с данными текущей локали
+const hasRU = Geo.hasCountry('RU') // Проверка поддержки страны
+```
+
+## Форматирование (GeoIntl)
+Универсальный движок для работы с данными на основе нативного `Intl`.
+
+```javascript
+import { GeoIntl } from '@dxtmisha/functional-basic'
+
+const intl = GeoIntl.getInstance()
+
+// Числа и валюты
+intl.currency(1000, 'USD')          // '$1,000.00'
+intl.percent(0.15)                  // '15%'
+
+// Даты и время
+intl.date(new Date(), 'full')       // Полноформатная дата
+intl.relative(new Date() - 3600000) // '1 час назад'
+intl.relativeLimit(pastDate, 7)     // Относительно (до 7 дней) или дата
+
+// Утилиты
+intl.plural(5, 'яблоко|яблока|яблок') // Склонение
+intl.sizeFile(1024 * 1024)           // '1 МБ'
+intl.sort(['яблоко', 'Ёж', 'арбуз'])  // Умная сортировка списка
+intl.displayNames('DE', 'region')    // 'Германия' (локализовано)
+```
+
+## Флаги стран (GeoFlag)
+Получение иконок флагов и названий стран на родном языке или языке системы.
+
+```javascript
+import { GeoFlag } from '@dxtmisha/functional-basic'
+
+const geoFlag = new GeoFlag('ru-RU')
+
+// Данные конкретной страны
+const ru = geoFlag.get('RU') // { icon: 'f-ru', country: 'Россия', area: '7', ... }
+
+// Список имен на языке оригинала
+const native = geoFlag.getNational(['DE']) 
+// [{ country: 'Германия', nationalCountry: 'Deutschland', ... }]
+```
+
+## Телефоны (GeoPhone)
+Автоопределение страны по номеру и работа с международными масками.
+
+```javascript
+import { GeoPhone } from '@dxtmisha/functional-basic'
+
+// Умная детекция
+const { item, phone } = GeoPhone.getByPhone('79001234567') 
+// item — данные страны (RU), phone — очищенный номер
+
+// Форматирование
+GeoPhone.toMask(phone, item.mask) // '+7 (900) 123-45-67'
+GeoPhone.clear(' +7 (900) 123-45-67 ') // '79001234567' (очистка)
+```
+
+## Списки (Formatters)
+Массовое форматирование массивов объектов. Автоматически создает новые свойства с суффиксом `Format`.
+
+```javascript
+import { Formatters } from '@dxtmisha/functional-basic'
+
+const options = {
+  price: { type: 'currency', options: 'USD' },
+  birthday: { type: 'date' },
+  'user.name': { type: 'name' }, // Объединяет firstName/lastName
+  count: { type: 'plural', options: 'штука|штуки|штук' },
+  status: { 
+    transformation: (v) => v === 1 ? 'Ок' : 'Ошибка' 
+  }
+}
+
+// transformed — копия data с полями priceFormat, birthdayFormat и т.д.
+const transformed = new Formatters(options, data).to()
+```

package/src/media/functional/functional-basic/geo/geo.vi.mdx

@@ -0,0 +1,99 @@
+import {Meta} from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/vi/functional-basic/# Geo và Định dạng'/>
+
+# Geo và Định dạng
+
+Công cụ quản lý địa phương hóa (i18n), dữ liệu địa lý và định dạng thông minh. Hệ thống tự động phát hiện cài đặt người dùng, đảm bảo hiển thị con số, ngày tháng và tiền tệ chuẩn xác.
+
+## Địa phương hóa (Geo)
+Quản lý trạng thái quốc gia, ngôn ngữ và múi giờ. Hỗ trợ tự động phát hiện và lưu trữ trình duyệt.
+
+```javascript
+import { Geo } from '@dxtmisha/functional-basic'
+
+// Cài đặt toàn cục
+Geo.set('vi-VN', true)      // Thiết lập locale và lưu lại
+Geo.setTimezone('+07:00')   // Ghi đè múi giờ
+Geo.getCountry()            // 'VN'
+
+// Dữ liệu tham khảo
+const list = Geo.getList()  // Danh sách đầy đủ quốc gia và ngôn ngữ
+const current = Geo.getItem() // Đối tượng dữ liệu locale hiện tại
+const hasJP = Geo.hasCountry('JP') // Kiểm tra hỗ trợ quốc gia
+```
+
+## Định dạng (GeoIntl)
+Công cụ vạn năng để định dạng dữ liệu dựa trên native `Intl`.
+
+```javascript
+import { GeoIntl } from '@dxtmisha/functional-basic'
+
+const intl = GeoIntl.getInstance()
+
+// Số & Tiền tệ
+intl.currency(1000, 'VND')          // '1.000 ₫'
+intl.percent(0.15)                  // '15%'
+
+// Ngày & Giờ
+intl.date(new Date(), 'full')       // Ngày định dạng đầy đủ
+intl.relative(new Date() - 3600000) // '1 giờ trước'
+intl.relativeLimit(pastDate, 7)     // Tương đối (tới 7 ngày) hoặc tuyệt đối
+
+// Tiện ích
+intl.plural(5, 'quả táo|quả táo')   // Chia số nhiều
+intl.sizeFile(1024 * 1024)          // '1 MB'
+intl.sort(['táo', 'Voi', 'chuối'])  // Sắp xếp thông minh theo locale
+intl.displayNames('DE', 'region')   // 'Đức' (đã địa phương hóa)
+```
+
+## Cờ quốc gia (GeoFlag)
+Lấy biểu tượng cờ và tên quốc gia bằng ngôn ngữ bản địa hoặc hệ thống.
+
+```javascript
+import { GeoFlag } from '@dxtmisha/functional-basic'
+
+const geoFlag = new GeoFlag('vi-VN')
+
+// Dữ liệu quốc gia cụ thể
+const ru = geoFlag.get('RU') // { icon: 'f-ru', country: 'Nga', area: '7', ... }
+
+// Danh sách tên bằng ngôn ngữ gốc
+const native = geoFlag.getNational(['DE']) 
+// [{ country: 'Đức', nationalCountry: 'Deutschland', ... }]
+```
+
+## Điện thoại (GeoPhone)
+Tự động xác định quốc gia qua số điện thoại và làm việc với mặt nạ quốc tế.
+
+```javascript
+import { GeoPhone } from '@dxtmisha/functional-basic'
+
+// Nhận diện thông minh
+const { item, phone } = GeoPhone.getByPhone('84900123456') 
+// item — dữ liệu VN, phone — số đã làm sạch
+
+// Định dạng
+GeoPhone.toMask(phone, item.mask) // '+84 (900) 123-456'
+GeoPhone.clear(' +84 (900) 123-456 ') // '84900123456' (làm sạch)
+```
+
+## Danh sách (Formatters)
+Chuyển đổi hàng loạt mảng đối tượng. Tự động tạo các thuộc tính mới với hậu tố `Format`.
+
+```javascript
+import { Formatters } from '@dxtmisha/functional-basic'
+
+const options = {
+  price: { type: 'currency', options: 'VND' },
+  birthday: { type: 'date' },
+  'user.name': { type: 'name' }, // Kết hợp firstName/lastName
+  count: { type: 'plural', options: 'quả|quả' },
+  status: { 
+    transformation: (v) => v === 1 ? 'Ok' : 'Lỗi' 
+  }
+}
+
+// transformed — bản sao của data với các trường priceFormat, birthdayFormat...
+const transformed = new Formatters(options, data).to()
+```

package/src/media/functional/functional-basic/icons/icons.en.mdx

@@ -0,0 +1,47 @@
+import {Meta} from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/en/functional-basic/# Icons'/>
+
+# Icons
+
+The `Icons` class is a centralized registry for registering, storing, and lazy-loading icons. It manages asset paths, supports dynamic imports, and synchronizes state across different parts of the application via a global object.
+
+```javascript
+import { Icons } from '@dxtmisha/functional-basic'
+
+// 1. Setting the base path (default is /icons/)
+Icons.setUrl('/assets/icons/')
+
+// 2. Registering icons
+Icons.add('home', 'home-icon.svg')
+Icons.addByList({
+  'search': 'search.svg',
+  'close': 'close.svg'
+})
+
+// 3. Checking and retrieving
+if (Icons.is('home')) {
+  const path = await Icons.get('home')
+}
+```
+
+## Lazy Loading
+
+A key feature is the support for `Promise` and functions, allowing icons to be loaded only when they are actually needed, reducing the initial bundle size.
+
+```javascript
+// Registration via dynamic import
+Icons.add('user', () => import('./user.svg'))
+
+// Automatic wait for loading when calling get
+const iconData = await Icons.get('user')
+```
+
+## Global Synchronization
+
+The tool automatically maintains data relevance in `window.__UI_ICON`. This allows icons to be registered in one place (e.g., during app initialization) and accessed instantly anywhere in the code.
+
+```javascript
+// Adding an icon relative to the global path
+Icons.addGlobal('logo', 'logo.svg')
+```

package/src/media/functional/functional-basic/icons/icons.ru.mdx

@@ -0,0 +1,47 @@
+import {Meta} from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/ru/functional-basic/# Иконки'/>
+
+# Иконки
+
+Класс `Icons` — это централизованный реестр для регистрации, хранения и ленивой загрузки иконок. Он позволяет управлять путями к ассетам, поддерживает динамические импорты и синхронизирует состояние между различными частями приложения через глобальный объект.
+
+```javascript
+import { Icons } from '@dxtmisha/functional-basic'
+
+// 1. Настройка базового пути (по умолчанию /icons/)
+Icons.setUrl('/assets/icons/')
+
+// 2. Регистрация иконок
+Icons.add('home', 'home-icon.svg')
+Icons.addByList({
+  'search': 'search.svg',
+  'close': 'close.svg'
+})
+
+// 3. Проверка и получение
+if (Icons.is('home')) {
+  const path = await Icons.get('home')
+}
+```
+
+## Ленивая загрузка
+
+Одной из ключевых особенностей является поддержка `Promise` и функций, что позволяет подгружать иконки только в момент их реального использования, снижая объем начальной загрузки приложения.
+
+```javascript
+// Регистрация через динамический импорт
+Icons.add('user', () => import('./user.svg'))
+
+// Автоматическое ожидание загрузки при вызове get
+const iconData = await Icons.get('user')
+```
+
+## Глобальная синхронизация
+
+Инструмент автоматически поддерживает актуальность данных в `window.__UI_ICON`. Это позволяет регистрировать иконки в одном месте (например, при инициализации приложения) и мгновенно получать к ним доступ в любой части кода.
+
+```javascript
+// Добавление иконки относительно глобального пути
+Icons.addGlobal('logo', 'logo.svg')
+```

package/src/media/functional/functional-basic/icons/icons.vi.mdx

@@ -0,0 +1,47 @@
+import {Meta} from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/vi/functional-basic/# Icons'/>
+
+# Icons
+
+Lớp `Icons` là một registry tập trung để đăng ký, lưu trữ và tải chậm (lazy-loading) các icon. Nó quản lý đường dẫn tài nguyên, hỗ trợ import động và đồng bộ hóa trạng thái giữa các phần khác nhau của ứng dụng thông qua một đối tượng toàn cục.
+
+```javascript
+import { Icons } from '@dxtmisha/functional-basic'
+
+// 1. Thiết lập đường dẫn cơ sở (mặc định là /icons/)
+Icons.setUrl('/assets/icons/')
+
+// 2. Đăng ký icon
+Icons.add('home', 'home-icon.svg')
+Icons.addByList({
+  'search': 'search.svg',
+  'close': 'close.svg'
+})
+
+// 3. Kiểm tra và lấy dữ liệu
+if (Icons.is('home')) {
+  const path = await Icons.get('home')
+}
+```
+
+## Tải chậm (Lazy Loading)
+
+Một tính năng chính là hỗ trợ `Promise` và các hàm, cho phép các icon chỉ được tải khi chúng thực sự cần thiết, giúp giảm dung lượng tải ban đầu của ứng dụng.
+
+```javascript
+// Đăng ký qua import động
+Icons.add('user', () => import('./user.svg'))
+
+// Tự động đợi khi gọi get
+const iconData = await Icons.get('user')
+```
+
+## Đồng bộ hóa toàn cục
+
+Công cụ tự động duy trì tính phù hợp của dữ liệu trong `window.__UI_ICON`. Điều này cho phép đăng ký icon ở một nơi (ví dụ: khi khởi tạo ứng dụng) và truy cập ngay lập tức ở bất kỳ đâu trong mã nguồn.
+
+```javascript
+// Thêm icon tương đối với đường dẫn toàn cục
+Icons.addGlobal('logo', 'logo.svg')
+```

package/src/media/functional/functional-basic/regex/regex.en.mdx

@@ -0,0 +1,60 @@
+import {Meta} from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/en/functional-basic/# Regular Expressions'/>
+
+# Regular Expressions
+
+A set of utilities for simplifying work with regular expressions. Includes methods for safely escaping user input and generating complex patterns for "contains all words" or "contains any word" searches.
+
+## Escaping and Creation
+
+Safely use strings inside regular expressions without the risk of syntax errors.
+
+```javascript
+import { escapeExp, getExp } from '@dxtmisha/functional-basic'
+
+// 1. Escaping special characters (.*+?^${}()|[\]\)
+const safeText = escapeExp('price block ($)') // 'price block \(\$\)'
+
+// 2. Quick RegExp object creation with flags
+const regex = getExp('search-term', 'ig') 
+```
+
+## Search Patterns
+
+Specialized generators for implementing search and filtering functionality.
+
+```javascript
+import { 
+  getSearchExp, 
+  getSeparatingSearchExp, 
+  getExactSearchExp 
+} from '@dxtmisha/functional-basic'
+
+// 1. "Contains all words" search (any order)
+// Good for: "red car buy" -> matches "buy red car"
+const searchAll = getSearchExp('red car')
+
+// 2. "Contains any word" search (OR-based)
+const searchAny = getSeparatingSearchExp('apple orange') // (apple|orange)
+
+// 3. Exact word match
+const exact = getExactSearchExp('React') // Matches 'React', but not 'Reactions'
+```
+
+## Practical Example
+
+Usage in data array filtering:
+
+```javascript
+const search = 'John Developer'
+const regex = getSearchExp(search)
+
+const users = [
+  { name: 'John Doe', job: 'Senior Developer' },
+  { name: 'Peter Johnson', job: 'Designer' }
+]
+
+// Will find the first user, as their data contains both words
+const filtered = users.filter(u => `${u.name} ${u.job}`.match(regex))
+```

package/src/media/functional/functional-basic/regex/regex.ru.mdx

@@ -0,0 +1,60 @@
+import {Meta} from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/ru/functional-basic/# Регулярные выражения'/>
+
+# Регулярные выражения
+
+Набор утилит для упрощения работы с регулярными выражениями. Включает методы для безопасного экранирования пользовательского ввода и генерации сложных паттернов для поиска "по всем словам" или "хотя бы по одному".
+
+## Экранирование и создание
+
+Безопасное использование строк внутри регулярных выражений без риска синтаксических ошибок.
+
+```javascript
+import { escapeExp, getExp } from '@dxtmisha/functional-basic'
+
+// 1. Экранирование спецсимволов (.*+?^${}()|[\]\)
+const safeText = escapeExp('price block ($)') // 'price block \(\$\)'
+
+// 2. Быстрое создание объекта RegExp с флагами
+const regex = getExp('search-term', 'ig') 
+```
+
+## Поисковые паттерны
+
+Специализированные генераторы для реализации функционала поиска и фильтрации.
+
+```javascript
+import { 
+  getSearchExp, 
+  getSeparatingSearchExp, 
+  getExactSearchExp 
+} from '@dxtmisha/functional-basic'
+
+// 1. Поиск "содержит все слова" (в любом порядке)
+// Подойдет для: "купить машину красную" -> найдет "красную машину купить"
+const searchAll = getSearchExp('красная машина')
+
+// 2. Поиск "хотя бы одно слово" (через ИЛИ)
+const searchAny = getSeparatingSearchExp('apple orange') // (apple|orange)
+
+// 3. Точное совпадение слова целиком
+const exact = getExactSearchExp('React') // Найдет 'React', но не 'Reactions'
+```
+
+## Практический пример
+
+Использование в фильтрации массивов данных:
+
+```javascript
+const search = 'Иван Разработчик'
+const regex = getSearchExp(search)
+
+const users = [
+  { name: 'Иван Сергеев', job: 'Ведущий разработчик' },
+  { name: 'Петр Иванов', job: 'Дизайнер' }
+]
+
+// Найдет первого пользователя, так как его данные содержат оба слова
+const filtered = users.filter(u => `${u.name} ${u.job}`.match(regex))
+```

package/src/media/functional/functional-basic/regex/regex.vi.mdx

@@ -0,0 +1,60 @@
+import {Meta} from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/vi/functional-basic/# Biểu thức chính quy'/>
+
+# Biểu thức chính quy
+
+Bộ tiện ích để đơn giản hóa công việc với biểu thức chính quy. Bao gồm các phương thức để thoát đầu vào của người dùng một cách an toàn và tạo các mẫu phức tạp cho các tìm kiếm "chứa tất cả các từ" hoặc "chứa bất kỳ từ nào".
+
+## Thoát và Tạo
+
+Sử dụng chuỗi bên trong biểu thức chính quy một cách an toàn mà không có nguy cơ lỗi cú pháp.
+
+```javascript
+import { escapeExp, getExp } from '@dxtmisha/functional-basic'
+
+// 1. Thoát các ký tự đặc biệt (.*+?^${}()|[\]\)
+const safeText = escapeExp('price block ($)') // 'price block \(\$\)'
+
+// 2. Tạo đối tượng RegExp nhanh chóng với các cờ
+const regex = getExp('search-term', 'ig') 
+```
+
+## Mẫu Tìm kiếm
+
+Các bộ tạo chuyên dụng để triển khai chức năng tìm kiếm và lọc.
+
+```javascript
+import { 
+  getSearchExp, 
+  getSeparatingSearchExp, 
+  getExactSearchExp 
+} from '@dxtmisha/functional-basic'
+
+// 1. Tìm kiếm "chứa tất cả các từ" (thứ tự bất kỳ)
+// Phù hợp cho: "mua xe đỏ" -> khớp với "xe đỏ mua"
+const searchAll = getSearchExp('xe đỏ')
+
+// 2. Tìm kiếm "chứa bất kỳ từ nào" (dựa trên OR)
+const searchAny = getSeparatingSearchExp('apple orange') // (apple|orange)
+
+// 3. Khớp từ chính xác
+const exact = getExactSearchExp('React') // Khớp 'React', nhưng không khớp 'Reactions'
+```
+
+## Ví dụ thực tế
+
+Sử dụng trong lọc mảng dữ liệu:
+
+```javascript
+const search = 'John Developer'
+const regex = getSearchExp(search)
+
+const users = [
+  { name: 'John Doe', job: 'Senior Developer' },
+  { name: 'Peter Johnson', job: 'Designer' }
+]
+
+// Sẽ tìm thấy người dùng đầu tiên, vì dữ liệu của họ chứa cả hai từ
+const filtered = users.filter(u => `${u.name} ${u.job}`.match(regex))
+```

package/src/media/functional/functional-basic/search-list/search-list.en.mdx

@@ -0,0 +1,52 @@
+import {Meta} from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/en/functional-basic/# Search List'/>
+
+# Search List
+
+The `SearchList` class is a powerful tool for organizing reactive search and filtering within object arrays. It encapsulates matcher logic, query state management, and result formatting, including match highlighting.
+
+```javascript
+import { SearchList } from '@dxtmisha/functional-basic'
+
+const data = [
+  { id: 1, name: 'Apple', Category: 'Fruit' },
+  { id: 2, name: 'Banana', Category: 'Fruit' }
+]
+
+// 1. Initializing search on 'name' and 'Category' fields
+const search = new SearchList(data, ['name', 'Category'])
+
+// 2. Setting the search value
+search.setValue('app')
+
+// 3. Retrieving the filtered list
+const results = search.to()
+// [{ item: { id: 1, ... }, selected: true, ... }]
+```
+
+## Data Management
+
+You can dynamically change both the data list and the set of search columns without needing to restart the search logic.
+
+```javascript
+// Updating the data list
+search.setList(newData)
+
+// Changing target columns
+search.setColumns(['Category'])
+```
+
+## Fine-Tuning
+
+Search behavior can be managed via options, such as forcing the system to return all items while marking matches with a `selected` flag.
+
+```javascript
+const search = new SearchList(data, ['name'], '', {
+  returnEverything: true // Return the entire list, not just matches
+})
+
+search.setValue('apple')
+const list = search.to() 
+// list will contain all items, but 'Apple' will have selected: true
+```