# Вспомогательные функции
## Введение
Nylo поставляется с набором статических утилитарных классов — `Arr`, `Str`, `Number` и `Obj` — а также несколькими глобальными вспомогательными функциями для типичных задач. Все они экспортируются из `nylo_framework`:
``` dart
import 'package:nylo_framework/nylo_framework.dart';
Arr.first([1, 2, 3]); // 1
Str.slug('Hello World'); // 'hello-world'
Number.currency(1234.56); // '$1,234.56'
Obj.get(user, 'profile.name'); // 'Anna'
```
> **Примечание:** `Backpack`, `NyStorage`, `NyCache` и `NyLogger` имеют собственные страницы документации: [Backpack](/docs/7.x/backpack), [Storage](/docs/7.x/storage), [Cache](/docs/7.x/cache), [Logging](/docs/7.x/logging).
## Доступные методы
### Массивы
### Строки
### Числа
### Объекты
### Прочее
## Массивы
#### `Arr.accessible()`
Определяет, доступно ли данное значение как массив (`List` или `Map`):
``` dart
Arr.accessible([1, 2, 3]); // true
Arr.accessible({'a': 1}); // true
Arr.accessible('hello'); // false
Arr.accessible(null); // false
```
#### `Arr.average()`
Возвращает среднее арифметическое списка или `0` для пустого. Передайте `by` для извлечения числа из каждого элемента:
``` dart
Arr.average([2, 4, 6]); // 4.0
Arr.average(orders, by: (o) => o.total); // среднее значение суммы
```
#### `Arr.chunk()`
Разбивает список на части заданного размера:
``` dart
Arr.chunk([1, 2, 3, 4, 5], 2);
// [[1, 2], [3, 4], [5]]
```
#### `Arr.collapse()`
Сворачивает список списков в единый список:
``` dart
Arr.collapse([[1, 2], [3, 4], [5]]);
// [1, 2, 3, 4, 5]
```
#### `Arr.countBy()`
Подсчитывает вхождения в списке, опционально группируя по экстрактору значений:
``` dart
Arr.countBy(['a', 'b', 'a', 'c']);
// {'a': 2, 'b': 1, 'c': 1}
Arr.countBy(orders, by: (o) => o.status);
// {'paid': 12, 'pending': 3}
```
#### `Arr.crossJoin()`
Выполняет декартово произведение заданных списков, возвращая все возможные комбинации:
``` dart
Arr.crossJoin([[1, 2], ['a', 'b']]);
// [[1, 'a'], [1, 'b'], [2, 'a'], [2, 'b']]
```
#### `Arr.every()`
Возвращает `true`, когда каждый элемент списка удовлетворяет предикату. Для пустых списков всегда истинно:
``` dart
Arr.every([2, 4, 6], (n) => n.isEven); // true
Arr.every([1, 2, 3], (n) => n.isEven); // false
```
#### `Arr.exceptValues()`
Возвращает список с удалёнными указанными значениями:
``` dart
Arr.exceptValues([1, 2, 3, 4], [2, 4]); // [1, 3]
```
#### `Arr.first()`
Возвращает первый элемент, удовлетворяющий предикату, или значение по умолчанию:
``` dart
Arr.first([1, 2, 3]); // 1
Arr.first([1, 2, 3, 4], predicate: (n) => n.isEven); // 2
Arr.first([], defaultValue: 99); // 99
```
#### `Arr.flatMap()`
Применяет `fn` к каждому элементу и разворачивает результирующие итерируемые объекты:
``` dart
Arr.flatMap(pages, (p) => p.items); // все элементы всех страниц
Arr.flatMap([1, 2, 3], (n) => [n, n * 10]); // [1, 10, 2, 20, 3, 30]
```
#### `Arr.flatten()`
Разворачивает вложенный итерируемый объект в одноуровневый список. `depth` ограничивает глубину; `-1` означает без ограничений:
``` dart
Arr.flatten([1, [2, [3]]]); // [1, 2, 3]
Arr.flatten([1, [2, [3]]], depth: 1); // [1, 2, [3]]
```
#### `Arr.groupBy()`
Группирует список в Map с ключами, возвращаемыми `by`:
``` dart
Arr.groupBy(messages, (m) => m.date);
// {2024-01-01: [...], 2024-01-02: [...]}
```
#### `Arr.indexed()`
Соединяет каждый элемент с его индексом, возвращая список записей `(index, value)`:
``` dart
for (final (i, v) in Arr.indexed(['a', 'b', 'c'])) {
print('$i: $v'); // '0: a', '1: b', '2: c'
}
```
#### `Arr.interleave()`
Вставляет разделитель между каждой парой элементов. Полезно для создания дочерних виджетов с разделителями:
``` dart
Arr.interleave([1, 2, 3], 0); // [1, 0, 2, 0, 3]
Column(children: Arr.interleave(tiles, const Divider()));
```
#### `Arr.isAssoc()`
Возвращает `true`, когда значение является `Map` (ассоциативным):
``` dart
Arr.isAssoc({'a': 1}); // true
Arr.isAssoc([1, 2, 3]); // false
```
#### `Arr.isList()`
Возвращает `true`, когда значение является `List`:
``` dart
Arr.isList([1, 2, 3]); // true
Arr.isList({'a': 1}); // false
```
#### `Arr.join()`
Объединяет список в строку. Последний элемент может быть соединён другим разделителем:
``` dart
Arr.join(['Anna', 'Brad', 'Carol'], ', ', ' and ');
// 'Anna, Brad and Carol'
Arr.join(['a', 'b', 'c']);
// 'a, b, c'
```
#### `Arr.keyBy()`
Индексирует список по значению ключа. Записи со значением `null` по этому ключу пропускаются:
``` dart
Arr.keyBy([
{'id': 1, 'name': 'Anna'},
{'id': 2, 'name': 'Brad'},
], 'id');
// {1: {'id': 1, 'name': 'Anna'}, 2: {'id': 2, 'name': 'Brad'}}
```
#### `Arr.last()`
Возвращает последний элемент, удовлетворяющий предикату, или значение по умолчанию:
``` dart
Arr.last([1, 2, 3, 4], predicate: (n) => n.isEven); // 4
Arr.last([1, 2, 3]); // 3
```
#### `Arr.map()`
Применяет callback к каждому элементу, который также получает индекс:
``` dart
Arr.map(['a', 'b'], (v, i) => '$i:$v'); // ['0:a', '1:b']
```
#### `Arr.mapWithKeys()`
Преобразует каждый элемент в `MapEntry` и возвращает результирующий Map:
``` dart
Arr.mapWithKeys(
[{'id': 1, 'name': 'Anna'}, {'id': 2, 'name': 'Brad'}],
(m) => MapEntry(m['id'], m['name']),
);
// {1: 'Anna', 2: 'Brad'}
```
#### `Arr.max()`
Возвращает элемент с наибольшим значением `by` или наибольший элемент, если `by` не указан:
``` dart
Arr.max([3, 1, 4, 1, 5]); // 5
Arr.max(users, by: (u) => u.age); // пользователь с наибольшим возрастом
```
#### `Arr.median()`
Возвращает медиану списка или `0` для пустого:
``` dart
Arr.median([1, 3, 5]); // 3.0
Arr.median([1, 2, 3, 4]); // 2.5
```
#### `Arr.min()`
Возвращает элемент с наименьшим значением `by` или наименьший элемент, если `by` не указан:
``` dart
Arr.min([3, 1, 4, 1, 5]); // 1
Arr.min(users, by: (u) => u.age); // пользователь с наименьшим возрастом
```
#### `Arr.move()`
Возвращает новый список с элементом из позиции `from`, перемещённым в позицию `to`. `to` ограничивается допустимым диапазоном:
``` dart
Arr.move(['a', 'b', 'c', 'd'], 0, 2); // ['b', 'c', 'a', 'd']
```
#### `Arr.onlyValues()`
Возвращает элементы списка, которые также присутствуют в заданных значениях:
``` dart
Arr.onlyValues([1, 2, 3, 4], [2, 4, 9]); // [2, 4]
```
#### `Arr.partition()`
Делит список на пару `[matching, nonMatching]` на основе предиката:
``` dart
final [evens, odds] = Arr.partition([1, 2, 3, 4], (n) => n.isEven);
// evens: [2, 4], odds: [1, 3]
```
#### `Arr.pluck()`
Извлекает значение по ключу из каждой Map в списке:
``` dart
Arr.pluck([
{'name': 'Anna'},
{'name': 'Brad'},
], 'name');
// ['Anna', 'Brad']
```
#### `Arr.prepend()`
Возвращает новый список со значением, вставленным в начало:
``` dart
Arr.prepend([2, 3], 1); // [1, 2, 3]
```
#### `Arr.push()`
Возвращает новый список со значением, добавленным в конец:
``` dart
Arr.push([1, 2], 3); // [1, 2, 3]
```
#### `Arr.random()`
Возвращает случайный элемент списка. Генерирует исключение для пустого списка:
``` dart
Arr.random(['rock', 'paper', 'scissors']); // один из трёх
```
#### `Arr.randomMany()`
Возвращает до `count` случайных элементов без повторений:
``` dart
Arr.randomMany([1, 2, 3, 4, 5], 2); // например [3, 1]
```
#### `Arr.reject()`
Фильтрует список до элементов, *не* удовлетворяющих предикату (обратное [`where`](#method-arr-where)):
``` dart
Arr.reject([1, 2, 3, 4], (n) => n.isEven); // [1, 3]
```
#### `Arr.replaceAt()`
Возвращает новый список с элементом по `index`, заменённым на `value`. Генерирует `RangeError`, если `index` вне диапазона:
``` dart
Arr.replaceAt(['a', 'b', 'c'], 1, 'B'); // ['a', 'B', 'c']
```
#### `Arr.select()`
Возвращает каждую Map из списка, сведённую к только заданным ключам:
``` dart
Arr.select([
{'name': 'Anna', 'role': 'admin', 'age': 30},
{'name': 'Brad', 'role': 'user', 'age': 25},
], ['name', 'role']);
// [{'name': 'Anna', 'role': 'admin'}, {'name': 'Brad', 'role': 'user'}]
```
#### `Arr.shuffle()`
Возвращает перемешанную копию списка. Передайте `seed` для детерминизма:
``` dart
Arr.shuffle([1, 2, 3, 4, 5]);
Arr.shuffle([1, 2, 3], seed: 42); // детерминированный
```
#### `Arr.sole()`
Возвращает единственный элемент, удовлетворяющий предикату. Генерирует исключение, если ноль или более одного элемента совпадает:
``` dart
Arr.sole([1, 2, 3, 4], predicate: (n) => n == 3); // 3
Arr.sole([1, 2, 3], predicate: (n) => n.isEven); // 2
```
#### `Arr.some()`
Возвращает `true`, если хотя бы один элемент удовлетворяет предикату:
``` dart
Arr.some([1, 2, 3], (n) => n.isEven); // true
Arr.some([1, 3, 5], (n) => n.isEven); // false
```
#### `Arr.sort()`
Возвращает отсортированную копию списка:
``` dart
Arr.sort([3, 1, 2]); // [1, 2, 3]
Arr.sort(users, compare: (a, b) => a.age - b.age); // по возрасту по возрастанию
```
#### `Arr.sortDesc()`
Возвращает отсортированную копию списка в порядке убывания:
``` dart
Arr.sortDesc([3, 1, 2]); // [3, 2, 1]
```
#### `Arr.sortRecursive()`
Рекурсивно сортирует список. Вложенные списки сортируются на каждой глубине:
``` dart
Arr.sortRecursive([[3, 1, 2], [9, 7, 8]]);
// [[1, 2, 3], [7, 8, 9]]
```
#### `Arr.sum()`
Возвращает сумму списка. Передайте `by` для извлечения числа из каждого элемента:
``` dart
Arr.sum([1, 2, 3]); // 6
Arr.sum(orders, by: (o) => o.total); // сумма итогов
```
#### `Arr.swap()`
Возвращает новый список с переставленными элементами на позициях `i` и `j`:
``` dart
Arr.swap(['a', 'b', 'c'], 0, 2); // ['c', 'b', 'a']
```
#### `Arr.take()`
Возвращает первые `count` элементов или последние `count`, если `count` отрицательный:
``` dart
Arr.take([1, 2, 3, 4, 5], 2); // [1, 2]
Arr.take([1, 2, 3, 4, 5], -2); // [4, 5]
```
#### `Arr.unique()`
Возвращает уникальные значения списка:
``` dart
Arr.unique([1, 2, 2, 3, 1]); // [1, 2, 3]
```
#### `Arr.where()`
Фильтрует список до элементов, удовлетворяющих предикату:
``` dart
Arr.where([1, 2, 3, 4], (n) => n.isEven); // [2, 4]
```
#### `Arr.whereNotNull()`
Возвращает список с удалёнными значениями `null`:
``` dart
Arr.whereNotNull([1, null, 2, null, 3]); // [1, 2, 3]
```
#### `Arr.wrap()`
Оборачивает значение в `List`, если оно им не является. Возвращает пустой список, если значение `null`:
``` dart
Arr.wrap('foo'); // ['foo']
Arr.wrap([1, 2]); // [1, 2]
Arr.wrap(null); // []
```
## Строки
#### `Str.after()`
Возвращает часть `subject` после первого вхождения `search`:
``` dart
Str.after('hello world hello', 'hello'); // ' world hello'
```
#### `Str.afterLast()`
Возвращает часть `subject` после последнего вхождения `search`:
``` dart
Str.afterLast('app/Http/Controllers', '/'); // 'Controllers'
```
#### `Str.before()`
Возвращает часть `subject` до первого вхождения `search`:
``` dart
Str.before('hello world', ' '); // 'hello'
```
#### `Str.beforeLast()`
Возвращает часть `subject` до последнего вхождения `search`:
``` dart
Str.beforeLast('app/Http/Controllers', '/'); // 'app/Http'
```
#### `Str.between()`
Возвращает часть `subject` между `from` и `to` (жадный режим):
``` dart
Str.between('[a] foo [b]', '[', ']'); // 'a] foo [b'
```
#### `Str.betweenFirst()`
Возвращает наименьшую часть `subject` между `from` и `to`:
``` dart
Str.betweenFirst('[a] foo [b]', '[', ']'); // 'a'
```
#### `Str.camel()`
Преобразует значение в `camelCase`:
``` dart
Str.camel('foo_bar'); // 'fooBar'
Str.camel('Hello world'); // 'helloWorld'
```
#### `Str.charAt()`
Возвращает символ по заданному индексу. Отрицательные индексы считаются с конца. Возвращает `null` при выходе за пределы:
``` dart
Str.charAt('hello', 1); // 'e'
Str.charAt('hello', -1); // 'o'
Str.charAt('hello', 99); // null
```
#### `Str.contains()`
Определяет, содержит ли `haystack` хотя бы одно из `needles`:
``` dart
Str.contains('hello world', 'world'); // true
Str.contains('hello world', ['cat', 'world']); // true
Str.contains('Hello', 'hello', ignoreCase: true); // true
```
#### `Str.containsAll()`
Определяет, содержит ли `haystack` все `needles`:
``` dart
Str.containsAll('hello world', ['hello', 'world']); // true
Str.containsAll('hello world', ['hello', 'cat']); // false
```
#### `Str.deduplicate()`
Заменяет последовательные вхождения `character` одиночным экземпляром:
``` dart
Str.deduplicate('hello world'); // 'hello world'
Str.deduplicate('//path//to//', '/'); // '/path/to/'
```
#### `Str.endsWith()`
Определяет, заканчивается ли `haystack` одним из `needles`:
``` dart
Str.endsWith('app.dart', '.dart'); // true
Str.endsWith('app.dart', ['.dart', '.ts']); // true
```
#### `Str.excerpt()`
Извлекает фрагмент текста вокруг первого вхождения `phrase`. Возвращает `null`, если фраза не найдена:
``` dart
Str.excerpt(
'This is my favorite quote of all time.',
'favorite',
radius: 5,
);
// '...is my favorite quote ...'
```
#### `Str.finish()`
Завершает значение одним экземпляром `cap`:
``` dart
Str.finish('hello', '!'); // 'hello!'
Str.finish('hello!!!', '!'); // 'hello!'
```
#### `Str.headline()`
Разбивает строку на слова по границам заглавных букв, подчёркиваниям, дефисам и пробелам, затем конвертирует в заголовочный регистр:
``` dart
Str.headline('steve_jobs'); // 'Steve Jobs'
Str.headline('EmailNotificationSent'); // 'Email Notification Sent'
```
#### `Str.is_()`
Определяет, соответствует ли значение заданному шаблону. Звёздочки работают как подстановочные знаки:
``` dart
Str.is_('foo.*', 'foo.bar'); // true
Str.is_(['admin/*', 'user/*'], 'admin/profile'); // true
Str.is_('foo', 'bar'); // false
```
> **Примечание:** Завершающее подчёркивание используется во избежание конфликта с зарезервированным ключевым словом Dart `is`.
#### `Str.isAscii()`
Возвращает `true`, если значение содержит только 7-битные ASCII-символы:
``` dart
Str.isAscii('hello'); // true
Str.isAscii('héllo'); // false
```
#### `Str.isJson()`
Возвращает `true`, если значение является корректным JSON:
``` dart
Str.isJson('{"a": 1}'); // true
Str.isJson('not json'); // false
```
#### `Str.isUlid()`
Возвращает `true`, если значение является ULID (26 символов, Crockford base32):
``` dart
Str.isUlid('01ARZ3NDEKTSV4RRFFQ69G5FAV'); // true
Str.isUlid('not a ulid'); // false
```
#### `Str.isUrl()`
Возвращает `true`, если значение является корректным URL:
``` dart
Str.isUrl('https://nylo.dev'); // true
Str.isUrl('not a url'); // false
```
#### `Str.isUuid()`
Возвращает `true`, если значение является корректным UUID (любой версии):
``` dart
Str.isUuid('a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11'); // true
Str.isUuid('hello'); // false
```
#### `Str.kebab()`
Преобразует значение в `kebab-case`:
``` dart
Str.kebab('fooBar'); // 'foo-bar'
Str.kebab('Hello World'); // 'hello-world'
```
#### `Str.lcfirst()`
Переводит первый символ значения в нижний регистр:
``` dart
Str.lcfirst('Hello world'); // 'hello world'
```
#### `Str.length()`
Возвращает длину значения:
``` dart
Str.length('hello'); // 5
```
#### `Str.limit()`
Усекает значение до заданного количества символов и добавляет суффикс:
``` dart
Str.limit('A long sentence', 6); // 'A long...'
Str.limit('A long sentence', 6, '... read'); // 'A long... read'
```
#### `Str.lower()`
Переводит значение в нижний регистр:
``` dart
Str.lower('HELLO'); // 'hello'
```
#### `Str.mask()`
Маскирует часть строки символом, начиная с `index` для `length` символов (или до конца, если `length` не указан):
``` dart
Str.mask('user@example.com', '*', 3); // 'use*************'
Str.mask('user@example.com', '*', 3, 5); // 'use*****mple.com'
```
#### `Str.match()`
Возвращает первое совпадение регулярного выражения `pattern` в `subject` или `null`, если совпадений нет:
``` dart
Str.match(RegExp(r'\d+'), 'item 42 in 99 stock'); // '42'
```
> **Примечание:** Это сопоставитель регулярных выражений — в отличие от глобального вспомогательного [`match`](#method-match), используемого для поиска значений в `Map`.
#### `Str.matchAll()`
Возвращает все совпадения регулярного выражения `pattern` в `subject`:
``` dart
Str.matchAll(RegExp(r'\d+'), 'item 42 in 99 stock'); // ['42', '99']
```
#### `Str.padBoth()`
Дополняет обе стороны значения символом `pad` до достижения длины `length`:
``` dart
Str.padBoth('5', 5, '0'); // '00500'
```
#### `Str.padLeft()`
Дополняет левую сторону значения:
``` dart
Str.padLeft('5', 3, '0'); // '005'
```
#### `Str.padNumber()`
Дополняет числовую строку ведущими нулями:
``` dart
Str.padNumber('5', 3); // '005'
```
#### `Str.padRight()`
Дополняет правую сторону значения:
``` dart
Str.padRight('5', 3, '0'); // '500'
```
#### `Str.password()`
Генерирует криптографически случайный пароль. Классы символов переключаются именованными аргументами:
``` dart
Str.password(12); // буквы + цифры + символы
Str.password(12, symbols: false); // только буквы + цифры
Str.password(8, letters: false, symbols: false); // только цифры
```
#### `Str.position()`
Возвращает индекс первого вхождения `needle` в `haystack` или `null`, если не найдено:
``` dart
Str.position('hello world', 'world'); // 6
Str.position('hello world hello', 'hello', offset: 1); // 12
Str.position('hello', 'cat'); // null
```
#### `Str.random()`
Генерирует криптографически случайную буквенно-цифровую строку заданной длины:
``` dart
Str.random(); // 16 символов, например 'aB3k9XzMq7VnPsRt'
Str.random(8); // 8 символов
```
#### `Str.remove()`
Удаляет любое из `search` из `subject`:
``` dart
Str.remove('o', 'hello world'); // 'hell wrld'
Str.remove(['e', 'l'], 'hello world'); // 'ho word'
Str.remove('Hello', 'hello world', caseSensitive: false); // ' world'
```
#### `Str.repeat()`
Повторяет значение заданное количество раз:
``` dart
Str.repeat('ab', 3); // 'ababab'
```
#### `Str.replace()`
Заменяет каждое вхождение `search` на `replace` в `subject`:
``` dart
Str.replace('o', '0', 'hello world'); // 'hell0 w0rld'
Str.replace(['o', 'l'], '*', 'hello world'); // 'he*** w*r*d'
```
#### `Str.replaceFirst()`
Заменяет первое вхождение `search` на `replace`:
``` dart
Str.replaceFirst('hello', 'hi', 'hello hello'); // 'hi hello'
```
#### `Str.replaceLast()`
Заменяет последнее вхождение `search` на `replace`:
``` dart
Str.replaceLast('hello', 'hi', 'hello hello'); // 'hello hi'
```
#### `Str.reverse()`
Обращает значение:
``` dart
Str.reverse('hello'); // 'olleh'
```
#### `Str.slug()`
Генерирует URL-дружественный слаг из заголовка:
``` dart
Str.slug('Hello World'); // 'hello-world'
Str.slug('Tech & Code', dictionary: {'&': 'and'}); // 'tech-and-code'
Str.slug('Hello World', separator: '_'); // 'hello_world'
```
#### `Str.snake()`
Преобразует значение в `snake_case`. Передайте пользовательский разделитель для использования вместо `_`:
``` dart
Str.snake('helloWorld'); // 'hello_world'
Str.snake('helloWorld', '-'); // 'hello-world'
```
#### `Str.squish()`
Удаляет ведущие/завершающие пробелы и сворачивает внутренние пробелы в одиночные:
``` dart
Str.squish(' hello world '); // 'hello world'
```
#### `Str.start()`
Начинает значение с одного экземпляра `prefix`:
``` dart
Str.start('this/string', '/'); // '/this/string'
Str.start('//this/string', '/'); // '/this/string'
```
#### `Str.startsWith()`
Определяет, начинается ли `haystack` с одного из `needles`:
``` dart
Str.startsWith('hello world', 'hello'); // true
Str.startsWith('hello world', ['cat', 'hello']); // true
```
#### `Str.studly()`
Преобразует значение в `StudlyCase` / `PascalCase`:
``` dart
Str.studly('foo_bar'); // 'FooBar'
Str.studly('hello world'); // 'HelloWorld'
```
#### `Str.substr()`
Возвращает подстроку, начинающуюся с `start` длиной `length` символов. Отрицательный `start` считается с конца:
``` dart
Str.substr('profile', 4); // 'ile'
Str.substr('profile', 4, 2); // 'il'
Str.substr('profile', -3); // 'ile'
```
#### `Str.substrCount()`
Подсчитывает непересекающиеся вхождения `needle` в `haystack`:
``` dart
Str.substrCount('hello hello hello', 'hello'); // 3
```
#### `Str.swap()`
Заменяет несколько подстрок с использованием `Map` пар поиск → замена:
``` dart
Str.swap({'foo': 'bar', 'hello': 'hi'}, 'hello foo'); // 'hi bar'
```
#### `Str.take()`
Возвращает первые `limit` символов значения. Отрицательный лимит возвращает с конца:
``` dart
Str.take('Build something amazing!', 5); // 'Build'
Str.take('Build something amazing!', -9); // ' amazing!'
```
#### `Str.title()`
Преобразует значение в `Title Case`:
``` dart
Str.title('a nice title'); // 'A Nice Title'
```
#### `Str.ucfirst()`
Переводит первый символ значения в верхний регистр:
``` dart
Str.ucfirst('hello world'); // 'Hello world'
```
#### `Str.ucsplit()`
Разбивает значение на слова по границам заглавных букв:
``` dart
Str.ucsplit('fooBarBaz'); // ['foo', 'Bar', 'Baz']
```
#### `Str.ulid()`
Генерирует ULID (Universally Unique Lexicographically Sortable Identifier):
``` dart
Str.ulid(); // например '01ARZ3NDEKTSV4RRFFQ69G5FAV'
```
#### `Str.unwrap()`
Удаляет один экземпляр `before` с начала и `after` (или `before`, если `after` равен null) с конца:
``` dart
Str.unwrap('"value"', '"'); // 'value'
Str.unwrap('html
', '', '
'); // 'html'
```
#### `Str.upper()`
Переводит значение в верхний регистр:
``` dart
Str.upper('hello'); // 'HELLO'
```
#### `Str.uuid()`
Генерирует случайный UUID v4:
``` dart
Str.uuid(); // например 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11'
```
#### `Str.uuid7()`
Генерирует UUID v7 (упорядоченный по времени, RFC 9562). UUIDv7 можно сортировать по времени создания:
``` dart
Str.uuid7(); // например '018e0dc4-8b3f-7a2c-9d01-b1f6c87a92e3'
```
#### `Str.wordCount()`
Возвращает количество слов в значении:
``` dart
Str.wordCount('hello there friend'); // 3
```
#### `Str.words()`
Ограничивает значение заданным количеством слов:
``` dart
Str.words('Perfectly balanced, as all things should be.', 3);
// 'Perfectly balanced, as...'
```
#### `Str.wrap()`
Оборачивает значение строками `before` и `after`. Если `after` не указан, `before` используется с обеих сторон:
``` dart
Str.wrap('value', '"'); // '"value"'
Str.wrap('html', '', '
'); // 'html
'
```
## Числа
#### `Number.abbreviate()`
Возвращает сокращённую форму числа (`1K`, `1M`, `1B`):
``` dart
Number.abbreviate(1500); // '2K'
Number.abbreviate(1500, maxPrecision: 1); // '1.5K'
Number.abbreviate(2_500_000); // '3M'
```
#### `Number.average()`
Возвращает среднее арифметическое значений или `0` для пустого:
``` dart
Number.average([1, 2, 3, 4]); // 2.5
```
#### `Number.between()`
Возвращает `true`, когда значение находится между `min` и `max` (включительно):
``` dart
Number.between(5, min: 0, max: 10); // true
Number.between(15, min: 0, max: 10); // false
```
#### `Number.ceil()`
Округляет значение вверх до заданной точности:
``` dart
Number.ceil(1.2); // 2.0
Number.ceil(1.234, 2); // 1.24
```
#### `Number.clamp()`
Ограничивает значение диапазоном между `min` и `max` (включительно):
``` dart
Number.clamp(5, 0, 10); // 5
Number.clamp(15, 0, 10); // 10
Number.clamp(-1, 0, 10); // 0
```
#### `Number.currency()`
Форматирует число как денежное значение. По умолчанию использует настроенную локаль и валюту:
``` dart
Number.currency(1234.56); // '$1,234.56'
Number.currency(1234.56, currency: 'EUR'); // '€1,234.56'
Number.currency(1234.56, locale: 'de_DE', currency: 'EUR');
// '1.234,56 €'
```
#### `Number.defaultCurrency()`
Возвращает код валюты по умолчанию, используемый методами форматирования:
``` dart
Number.defaultCurrency(); // 'USD'
```
#### `Number.defaultLocale()`
Возвращает локаль по умолчанию, используемую методами форматирования:
``` dart
Number.defaultLocale(); // 'en_US'
```
#### `Number.degrees()`
Конвертирует радианы в градусы:
``` dart
Number.degrees(3.14159); // ~180.0
```
#### `Number.duration()`
Форматирует количество секунд как удобочитаемую продолжительность. Короткая форма возвращает `'1h 2m 5s'`; длинная форма возвращает `'1:02:05'`:
``` dart
Number.duration(3661); // '1h 1m 1s'
Number.duration(3661, short: false); // '1:01:01'
Number.duration(45); // '45s'
```
#### `Number.fileSize()`
Форматирует количество байт как удобочитаемый размер файла:
``` dart
Number.fileSize(1024); // '1 KB'
Number.fileSize(1500, maxPrecision: 1); // '1.5 KB'
Number.fileSize(1024 * 1024 * 1024); // '1 GB'
```
#### `Number.floor()`
Округляет значение вниз до заданной точности:
``` dart
Number.floor(1.7); // 1.0
Number.floor(1.234, 2); // 1.23
```
#### `Number.forHumans()`
Возвращает удобочитаемую форму числа (`1 thousand`, `1 million`):
``` dart
Number.forHumans(1500); // '2 thousand'
Number.forHumans(1500, maxPrecision: 1); // '1.5 thousand'
Number.forHumans(2_500_000); // '3 million'
```
#### `Number.format()`
Форматирует число с учётом локали:
``` dart
Number.format(1234567); // '1,234,567'
Number.format(1234.5, precision: 2); // '1,234.50'
Number.format(1234567, locale: 'de_DE'); // '1.234.567'
```
#### `Number.gcd()`
Наибольший общий делитель двух целых чисел:
``` dart
Number.gcd(12, 18); // 6
```
#### `Number.lcm()`
Наименьшее общее кратное двух целых чисел:
``` dart
Number.lcm(4, 6); // 12
```
#### `Number.lerp()`
Линейная интерполяция между `a` и `b` с коэффициентом `t` (`0..1`):
``` dart
Number.lerp(0, 100, 0.25); // 25.0
```
#### `Number.max()`
Возвращает наибольшее значение в итерируемом объекте:
``` dart
Number.max([3, 1, 4, 1, 5, 9, 2, 6]); // 9
```
#### `Number.median()`
Возвращает медиану значений или `0` для пустого:
``` dart
Number.median([1, 3, 5]); // 3.0
Number.median([1, 2, 3, 4]); // 2.5
```
#### `Number.min()`
Возвращает наименьшее значение в итерируемом объекте:
``` dart
Number.min([3, 1, 4, 1, 5, 9, 2, 6]); // 1
```
#### `Number.ordinal()`
Возвращает порядковую форму числа (`1st`, `2nd`, `3rd`, `4th`):
``` dart
Number.ordinal(1); // '1st'
Number.ordinal(2); // '2nd'
Number.ordinal(21); // '21st'
Number.ordinal(112); // '112th'
```
#### `Number.pairs()`
Генерирует пары (под-диапазоны) из диапазона до `to` с шагом `by`:
``` dart
Number.pairs(25, 10); // [[0, 9], [10, 19], [20, 25]]
Number.pairs(25, 10, offset: 0); // [[0, 10], [10, 20], [20, 25]]
```
#### `Number.parseFloat()`
Разбирает строку с учётом локали как `double`. Возвращает `null` при ошибке:
``` dart
Number.parseFloat('1,234.56'); // 1234.56
Number.parseFloat('1.234,56', locale: 'de_DE'); // 1234.56
Number.parseFloat('not a number'); // null
```
#### `Number.parseInt()`
Разбирает строку с учётом локали как `int`. Возвращает `null` при ошибке:
``` dart
Number.parseInt('1,234'); // 1234
Number.parseInt('1.234', locale: 'de_DE'); // 1234
```
#### `Number.percentage()`
Форматирует число как процент. Число обрабатывается как полное процентное значение:
``` dart
Number.percentage(10); // '10%'
Number.percentage(10.5, precision: 1); // '10.5%'
```
#### `Number.radians()`
Конвертирует градусы в радианы:
``` dart
Number.radians(180); // ~3.14159
```
#### `Number.random()`
Возвращает случайное целое число в `[min, max]` (включительно). Передайте `seed` для детерминированной последовательности:
``` dart
Number.random(min: 1, max: 100); // любое целое 1..100
Number.random(min: 0, max: 9, seed: 42); // детерминированный
```
#### `Number.range()`
Генерирует список целых чисел от `start` (включительно) до `end` (включительно) с шагом `step`:
``` dart
Number.range(1, 5); // [1, 2, 3, 4, 5]
Number.range(0, 10, step: 2); // [0, 2, 4, 6, 8, 10]
Number.range(5, 1, step: -1); // [5, 4, 3, 2, 1]
```
#### `Number.round()`
Округляет значение до заданной точности:
``` dart
Number.round(1.5); // 2.0
Number.round(1.234, 2); // 1.23
```
#### `Number.scale()`
Переотображает значение из одного диапазона в другой:
``` dart
Number.scale(0.5, fromMin: 0, fromMax: 1, toMin: 0, toMax: 100); // 50.0
Number.scale(75, fromMin: 0, fromMax: 100, toMin: -1, toMax: 1); // 0.5
```
#### `Number.spell()`
Произносит число прописью на английском языке:
``` dart
Number.spell(0); // 'zero'
Number.spell(123); // 'one hundred twenty-three'
Number.spell(1_234_567); // 'one million two hundred thirty-four thousand five hundred sixty-seven'
```
#### `Number.spellOrdinal()`
Произносит порядковую форму числа прописью на английском языке:
``` dart
Number.spellOrdinal(1); // 'first'
Number.spellOrdinal(2); // 'second'
Number.spellOrdinal(21); // 'twenty-first'
```
#### `Number.sum()`
Возвращает сумму значений:
``` dart
Number.sum([1, 2, 3]); // 6
```
#### `Number.toBytes()`
Конвертирует размер файла в байты. Обратная к [`fileSize`](#method-number-filesize). Передайте разбираемую строку или число с `unit`:
``` dart
Number.toBytes('1.5 KB'); // 1536
Number.toBytes(1.5, 'KB'); // 1536
Number.toBytes(1, 'GB'); // 1073741824
Number.toBytes('not bytes'); // null
```
#### `Number.trim()`
Удаляет конечные нули из десятичной части значения:
``` dart
Number.trim(12.0); // '12'
Number.trim(12.30); // '12.3'
Number.trim(12.345); // '12.345'
```
#### `Number.useCurrency()`
Устанавливает код валюты по умолчанию для методов форматирования:
``` dart
Number.useCurrency('EUR');
Number.currency(99); // '€99.00'
```
#### `Number.useLocale()`
Устанавливает локаль по умолчанию для методов форматирования:
``` dart
Number.useLocale('de_DE');
Number.format(1234567); // '1.234.567'
```
## Объекты
`Obj` предоставляет утилиты для работы с Map с использованием путей в **точечной нотации**. К элементам списков можно обращаться по целочисленному индексу (например, `'users.0.name'`).
#### `Obj.add()`
Добавляет значение по `key` только при отсутствии там текущего значения:
``` dart
final user = {'name': 'Anna'};
Obj.add(user, 'role', 'admin');
// user: {'name': 'Anna', 'role': 'admin'}
Obj.add(user, 'name', 'Brad'); // нет операции — name уже задан
```
#### `Obj.deepEquals()`
Возвращает `true`, когда два значения структурно равны (рекурсивное сравнение `Map` и `List`):
``` dart
Obj.deepEquals({'a': [1, 2]}, {'a': [1, 2]}); // true
Obj.deepEquals({'a': 1}, {'a': 2}); // false
```
#### `Obj.divide()`
Разделяет Map на пару `[keys, values]`:
``` dart
Obj.divide({'name': 'Desk', 'price': 100});
// [['name', 'price'], ['Desk', 100]]
```
#### `Obj.dot()`
Выравнивает вложенный Map в одноуровневый Map с ключами в виде точечных путей:
``` dart
Obj.dot({'a': {'b': 1, 'c': 2}});
// {'a.b': 1, 'a.c': 2}
```
#### `Obj.except()`
Возвращает новый Map, содержащий все записи, кроме записей с заданными ключами:
``` dart
Obj.except({'name': 'Anna', 'role': 'admin', 'age': 30}, ['age']);
// {'name': 'Anna', 'role': 'admin'}
```
#### `Obj.exists()`
Возвращает `true`, когда Map содержит заданный ключ на верхнем уровне (без обхода точечной нотацией):
``` dart
Obj.exists({'a.b': 1}, 'a.b'); // true
Obj.exists({'a': {'b': 1}}, 'a.b'); // false (используйте `has` для обхода)
```
#### `Obj.flip()`
Меняет ключи и значения местами. При коллизии значений побеждает последняя запись:
``` dart
Obj.flip({'one': 1, 'two': 2}); // {1: 'one', 2: 'two'}
```
#### `Obj.forget()`
Удаляет ключ (точечная нотация) из Map. Возвращает Map для цепочки вызовов:
``` dart
final user = {'profile': {'name': 'Anna', 'email': 'a@b'}};
Obj.forget(user, 'profile.email');
// user: {'profile': {'name': 'Anna'}}
```
#### `Obj.get()`
Возвращает значение по `key` с использованием точечной нотации или значение по умолчанию при отсутствии пути. Ключи верхнего уровня с буквальными точками имеют приоритет над обходом:
``` dart
final user = {'profile': {'name': 'Anna', 'age': 30}};
Obj.get(user, 'profile.name'); // 'Anna'
Obj.get(user, 'profile.email'); // null
Obj.get(user, 'profile.email', 'unknown'); // 'unknown'
// Индексы списков:
Obj.get({'users': [{'name': 'A'}]}, 'users.0.name'); // 'A'
```
#### `Obj.getBool()`
Возвращает значение по `key`, приведённое к `bool`, или значение по умолчанию. Числа истинны при ненулевом значении; строки распознают `'true'`/`'false'`/`'1'`/`'0'`/`'yes'`/`'no'`/`'on'`/`'off'` (без учёта регистра):
``` dart
Obj.getBool({'flag': 'yes'}, 'flag'); // true
Obj.getBool({'flag': 0}, 'flag'); // false
Obj.getBool({}, 'flag', false); // false
```
#### `Obj.getDouble()`
Возвращает значение по `key`, приведённое к `double`, или значение по умолчанию:
``` dart
Obj.getDouble({'price': '9.99'}, 'price'); // 9.99
Obj.getDouble({'price': 10}, 'price'); // 10.0
```
#### `Obj.getInt()`
Возвращает значение по `key`, приведённое к `int`, или значение по умолчанию:
``` dart
Obj.getInt({'count': '42'}, 'count'); // 42
Obj.getInt({'count': 3.7}, 'count'); // 3 (усечённое)
Obj.getInt({}, 'count', 0); // 0
```
#### `Obj.getList()`
Возвращает значение по `key`, если оно является `List`, иначе значение по умолчанию:
``` dart
Obj.getList({'items': [1, 2, 3]}, 'items'); // [1, 2, 3]
Obj.getList({'items': 'oops'}, 'items', []); // []
```
#### `Obj.getMap()`
Возвращает значение по `key`, если оно является `Map`, иначе значение по умолчанию:
``` dart
Obj.getMap({'meta': {'a': 1}}, 'meta'); // {'a': 1}
Obj.getMap({'meta': null}, 'meta', {}); // {}
```
#### `Obj.getString()`
Возвращает значение по `key`, приведённое к `String`, или значение по умолчанию:
``` dart
Obj.getString({'name': 'Anna'}, 'name'); // 'Anna'
Obj.getString({'count': 42}, 'count'); // '42'
Obj.getString({}, 'name', 'Guest'); // 'Guest'
```
#### `Obj.has()`
Возвращает `true`, когда Map имеет значение по `key` с использованием точечной нотации:
``` dart
final user = {'profile': {'name': 'Anna'}};
Obj.has(user, 'profile.name'); // true
Obj.has(user, 'profile.email'); // false
```
#### `Obj.hasAll()`
Возвращает `true`, когда каждый из заданных ключей разрешается в Map:
``` dart
Obj.hasAll({'a': 1, 'b': 2}, ['a', 'b']); // true
Obj.hasAll({'a': 1, 'b': 2}, ['a', 'c']); // false
```
#### `Obj.hasAny()`
Возвращает `true`, когда любой из заданных ключей разрешается в Map:
``` dart
Obj.hasAny({'a': 1}, ['a', 'b']); // true
Obj.hasAny({'a': 1}, ['x', 'y']); // false
```
#### `Obj.mapKeys()`
Возвращает новый Map с каждым ключом, преобразованным через `fn`:
``` dart
Obj.mapKeys({'firstName': 'Anna'}, (k) => k.toLowerCase());
// {'firstname': 'Anna'}
```
#### `Obj.mapValues()`
Возвращает новый Map с каждым значением, преобразованным через `fn`:
``` dart
Obj.mapValues({'a': 1, 'b': 2}, (v) => v * 10);
// {'a': 10, 'b': 20}
```
#### `Obj.merge()`
Рекурсивно объединяет `source` в `target`. При коллизии ключей побеждает `source`; вложенные Map объединяются:
``` dart
Obj.merge(
{'a': {'x': 1}, 'b': 2},
{'a': {'y': 9}, 'b': 22},
);
// {'a': {'x': 1, 'y': 9}, 'b': 22}
```
#### `Obj.only()`
Возвращает новый Map, содержащий только записи с заданными ключами:
``` dart
Obj.only({'name': 'Anna', 'role': 'admin', 'age': 30}, ['name', 'role']);
// {'name': 'Anna', 'role': 'admin'}
```
#### `Obj.prependKeysWith()`
Добавляет заданный префикс к каждому ключу верхнего уровня в Map:
``` dart
Obj.prependKeysWith({'name': 'Anna', 'age': 30}, 'user_');
// {'user_name': 'Anna', 'user_age': 30}
```
#### `Obj.pull()`
Возвращает значение по `key` и удаляет его из Map:
``` dart
final user = {'name': 'Anna', 'temp': 'token'};
final temp = Obj.pull(user, 'temp'); // 'token'
// user: {'name': 'Anna'}
```
#### `Obj.query()`
Кодирует Map как строку URL-запроса:
``` dart
Obj.query({'name': 'Anna', 'tags': ['a', 'b']});
// 'name=Anna&tags%5B0%5D=a&tags%5B1%5D=b'
Obj.query({'filter': {'role': 'admin'}});
// 'filter%5Brole%5D=admin'
```
#### `Obj.set()`
Устанавливает значение по `key`, создавая вложенные Map вдоль пути. Мутирует Map на месте и возвращает его для цепочки:
``` dart
final user = {};
Obj.set(user, 'profile.email', 'a@b');
// user: {'profile': {'email': 'a@b'}}
```
#### `Obj.undot()`
Восстанавливает Map с точечными ключами обратно во вложенную структуру (обратная к [`dot`](#method-obj-dot)):
``` dart
Obj.undot({'a.b': 1, 'a.c': 2});
// {'a': {'b': 1, 'c': 2}}
```
#### `Obj.whereNotEmpty()`
Возвращает новый Map с удалёнными записями, значения которых `null` или пусты (пустой `String`, `Iterable` или `Map`):
``` dart
Obj.whereNotEmpty({'name': 'Anna', 'tags': [], 'bio': ''});
// {'name': 'Anna'}
```
#### `Obj.whereNotNull()`
Возвращает новый Map с удалёнными записями, значения которых `null`:
``` dart
Obj.whereNotNull({'name': 'Anna', 'email': null});
// {'name': 'Anna'}
```
## Прочее
Эти глобальные функции находятся в `helper.dart` и доступны везде, где вы импортируете `nylo_framework`.
#### `api()`
Удобный вспомогательный метод для отправки API-запросов через `NyApiService`. Полные параметры смотрите на странице [Networking](/docs/7.x/networking):
``` dart
await api((request) =>
request.get('https://jsonplaceholder.typicode.com/posts'));
```
#### `dataToModel()`
Конвертирует необработанные данные (обычно JSON `Map`) в модель, зарегистрированную в `config/decoders.dart`. Параметр типа обязателен:
``` dart
final user = dataToModel(data: {'name': 'Anna', 'age': 30});
```
#### `dump()`
Выводит значение в консоль. Соблюдает флаг `APP_DEBUG` приложения, если только не задан `alwaysPrint: true`:
``` dart
dump('Hello World');
dump(user, tag: 'current user');
dump(payload, alwaysPrint: true);
```
#### `event()`
Генерирует событие заданного типа с помощью `Nylo.events()`. Полное использование смотрите в [Events](/docs/7.x/events):
``` dart
await event(data: {'user': 'Anna'});
```
#### `getAsset()`
Возвращает полный путь к ресурсу в каталоге `/assets`:
``` dart
final path = getAsset('videos/welcome.mp4');
// 'assets/videos/welcome.mp4'
```
#### `getEnv()`
Возвращает значение из сгенерированного env-файла (`env.g.dart`). Возвращает значение по умолчанию, если ключ не задан:
``` dart
final apiUrl = getEnv('API_URL');
final debug = getEnv('APP_DEBUG', defaultValue: false);
```
#### `getImageAsset()`
Возвращает полный путь к изображению в `/assets/images/`:
``` dart
Image.asset(getImageAsset('logo.png'));
```
#### `loadJson()`
Загружает JSON-файл из пакета ресурсов. Результаты кэшируются по умолчанию:
``` dart
final config = await loadJson>('config/app.json');
```
#### `match()`
Сопоставляет значение с `Map` случаев и возвращает соответствующее значение. Генерирует исключение, когда ни один случай не совпадает и `defaultValue` не указан:
``` dart
final color = match(
status,
() => {
'active': 'green',
'inactive': 'red',
'pending': 'orange',
},
defaultValue: 'grey',
);
```
> **Примечание:** Это поиск значений в `Map` — в отличие от [`Str.match`](#method-str-match), выполняющего сопоставление регулярных выражений.
#### `now()`
Возвращает текущий `DateTime`:
``` dart
final timestamp = now();
```
#### `nyHexColor()`
Конвертирует строку hex-цвета в `Color`. Принимает 6- или 8-значные значения с лидирующим `#` или без:
``` dart
final brand = nyHexColor('#FF6B35');
final translucent = nyHexColor('80FF6B35'); // 8-значный (альфа первый)
```
#### `printDebug()`, `printError()`, `printInfo()`, `printWarning()`, `printSuccess()`, `printVerbose()`, `printAlert()`, `printEmergency()`
Консольные логгеры с тегами серьёзности. Форматирование вывода и флаг `alwaysPrint` смотрите на странице [Logging](/docs/7.x/logging):
``` dart
printInfo('User signed in');
printError('Payment failed', context: {'order_id': 42});
printDebug({'state': state});
```
#### `setBadgeNumber()`, `clearBadgeNumber()`
Устанавливает или сбрасывает счётчик значка иконки приложения. Подробности настройки платформы смотрите в [Local Notifications](/docs/7.x/local-notifications):
``` dart
await setBadgeNumber(3);
await clearBadgeNumber();
```
#### `showNextLog()`
Принудительно отображает следующий лог `NyLogger` даже при `APP_DEBUG` равном `false`. Полезно для разовой диагностики в релизных сборках:
``` dart
showNextLog();
NyLogger.info('This will print regardless of APP_DEBUG');
```
#### `sleep()`
Задерживает выполнение на заданную продолжительность. Первый аргумент — секунды; необязательный второй аргумент добавляет микросекунды:
``` dart
await sleep(2); // 2 секунды
await sleep(0, 500_000); // 500 миллисекунд
```
#### `trans()`
Возвращает переведённую строку по ключу. Настройку смотрите в [Localization](/docs/7.x/localization):
``` dart
final greeting = trans('home.welcome');
final personalized = trans('home.hello', arguments: {'name': 'Anna'});
```