Справочник API

Полный справочник по всем функциям strio.

Категории

Функции strio организованы в логические категории:

🎯 Манипуляции

Преобразование и изменение строк

• capitalize - Капитализация текста
• reverse - Переворот строки
• truncate - Укорачивание текста
• trim - Удаление пробелов
• insert - Вставка текста
• mask - Скрытие чувствительных данных

🔤 Преобразование регистра

Изменение регистра строк

• camelize - Преобразование в camelCase
• pascalize - Преобразование в PascalCase
• dasherize - Преобразование в kebab-case
• underscore - Преобразование в snake_case

✅ Валидация

Проверка и валидация строк

• Руководство по валидации строк - Проверки типов и форматов (isEmpty, isAlpha и т.д.)

🔍 Поиск

Поиск и извлечение текста

• contains - Проверка на подстроки
• count - Подсчёт вхождений
• between - Извлечение текста между разделителями

🎨 Форматирование

Форматирование для отображения

• humanize - Делает читаемым
• slugify - Создание URL slug
• ordinalize - Добавление порядковых суффиксов
• pluralize - Обработка единственного/множественного числа

🛠️ Утилиты

Вспомогательные функции

• words - Операции со словами
• join - Умное соединение массивов
• template - Строковые шаблоны
• random - Генерация случайных строк
• similarity - Сравнение строк
• transliterate - Конвертация кириллицы

📏 Отступы и выравнивание

Добавление пробелов

• padLeft / padRight / padCenter - Выравнивание строк
• indent - Добавление/удаление отступов

🔐 Безопасность

Безопасные операции со строками

• escapeHtml / unescapeHtml / escapeRegExp - Экранирование спецсимволов
• stripTags / stripPrefix / stripSuffix - Удаление тегов и содержимого

✨ Обеспечение

Гарантия формата

• ensureLeft / ensureRight - Обеспечение префикса/суффикса

Быстрый справочник

Наиболее используемые функции

import { 
  capitalize,    // "привет" → "Привет"
  slugify,       // "Привет Мир" → "privet-mir"
  truncate,      // Укорачивание текста
  isEmpty,       // Проверка на пустоту
  contains,      // Проверка подстроки
  template       // "Привет {{name}}" → "Привет Иван"
} from 'strio'

Распространённые паттерны

Преобразование строк

import { capitalize, trim, collapseWhitespace } from 'strio'

const clean = capitalize(trim(collapseWhitespace(input)))

Валидация

import { isEmpty, isNumeric } from 'strio'

if (!isEmpty(value) && isNumeric(value)) {
  // Валидное число
}

Форматирование

import { slugify, ensureRight } from 'strio'

const filename = ensureRight(slugify(title), '.md')

Определения типов

strio полностью типизирована. Импортируйте типы по необходимости:

import type { 
  StringValidator,
  CaseConverter,
  TemplateOptions 
} from 'strio'

Именование функций

strio использует последовательные соглашения об именовании:

• Глаголы для действий: capitalize, reverse, truncate
• Префикс is для проверок: isEmpty, isAlpha
• has/contains для присутствия: contains, containsAll
• ensure для гарантий: ensureLeft, ensureRight

Возвращаемые значения

Большинство функций возвращают:

• String - преобразованный результат
• Boolean - для проверок валидации
• Number - для подсчётов и измерений
• Array - для функций извлечения

Обработка ошибок

Функции strio защищены:

import { capitalize } from 'strio'

capitalize(null)      // Возвращает пустую строку
capitalize(undefined) // Возвращает пустую строку
capitalize('')        // Возвращает пустую строку
capitalize('привет')  // Возвращает "Привет"

Советы по производительности

1. Tree Shaking

Импортируйте только то, что нужно:

// ✅ Хорошо - в бандл попадёт только capitalize
import { capitalize } from 'strio'

// ❌ Плохо - в бандл попадёт всё
import * as strio from 'strio'

2. Мемоизация

Для повторяющихся операций на одном и том же вводе:

const cache = new Map()

function memoizedSlugify(text: string): string {
  if (cache.has(text)) {
    return cache.get(text)
  }
  const result = slugify(text)
  cache.set(text, result)
  return result
}

Совместимость с браузерами

Все функции работают в:

• ✅ Chrome/Edge 90+
• ✅ Firefox 88+
• ✅ Safari 14+
• ✅ Node.js 16+

Следующие шаги

• Просмотрите функции по категориям
• Посмотрите примеры
• Сообщайте о проблемах