# ヘルパー
## はじめに
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()`
`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()`
値が `Map`（連想配列）の場合に `true` を返します:
``` dart
Arr.isAssoc({'a': 1}); // true
Arr.isAssoc([1, 2, 3]); // false
```
#### `Arr.isList()`
値が `List` の場合に `true` を返します:
``` 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()`
インデックスも受け取るコールバックで各要素をマップします:
``` dart
Arr.map(['a', 'b'], (v, i) => '$i:$v'); // ['0:a', '1:b']
```
#### `Arr.mapWithKeys()`
各要素を `MapEntry` にマップし、結果のマップを返します:
``` 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()`
述語に基づいてリストを `[一致, 不一致]` のペアに分割します:
``` dart
final [evens, odds] = Arr.partition([1, 2, 3, 4], (n) => n.isEven);
// evens: [2, 4], odds: [1, 3]
```
#### `Arr.pluck()`
リスト内の各マップからキーの値を抽出します:
``` 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']); // 3つのうちの1つ
```
#### `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` で置き換えた新しいリストを返します。`index` が範囲外の場合は `RangeError` をスローします:
``` dart
Arr.replaceAt(['a', 'b', 'c'], 1, 'B'); // ['a', 'B', 'c']
```
#### `Arr.select()`
リスト内の各マップを指定したキーのみに絞り込んで返します:
``` 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()`
少なくとも1つの要素が述語を満たす場合に `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` でない場合に `List` でラップします。値が `null` の場合は空のリストを返します:
``` dart
Arr.wrap('foo'); // ['foo']
Arr.wrap([1, 2]); // [1, 2]
Arr.wrap(null); // []
```
## 文字列
#### `Str.after()`
`search` が最初に現れた後の `subject` の部分を返します:
``` dart
Str.after('hello world hello', 'hello'); // ' world hello'
```
#### `Str.afterLast()`
`search` が最後に現れた後の `subject` の部分を返します:
``` dart
Str.afterLast('app/Http/Controllers', '/'); // 'Controllers'
```
#### `Str.before()`
`search` が最初に現れる前の `subject` の部分を返します:
``` dart
Str.before('hello world', ' '); // 'hello'
```
#### `Str.beforeLast()`
`search` が最後に現れる前の `subject` の部分を返します:
``` dart
Str.beforeLast('app/Http/Controllers', '/'); // 'app/Http'
```
#### `Str.between()`
`from` と `to` の間の `subject` の部分を返します（最長一致）:
``` dart
Str.between('[a] foo [b]', '[', ']'); // 'a] foo [b'
```
#### `Str.betweenFirst()`
`from` と `to` の間の `subject` の最短部分を返します:
``` 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()`
値が 7 ビット ASCII 文字のみを含む場合に `true` を返します:
``` dart
Str.isAscii('hello'); // true
Str.isAscii('héllo'); // false
```
#### `Str.isJson()`
値が有効な JSON の場合に `true` を返します:
``` dart
Str.isJson('{"a": 1}'); // true
Str.isJson('not json'); // false
```
#### `Str.isUlid()`
値が ULID（26文字、Crockford base32）の場合に `true` を返します:
``` dart
Str.isUlid('01ARZ3NDEKTSV4RRFFQ69G5FAV'); // true
Str.isUlid('not a ulid'); // false
```
#### `Str.isUrl()`
値が有効な URL の場合に `true` を返します:
``` dart
Str.isUrl('https://nylo.dev'); // true
Str.isUrl('not a url'); // false
```
#### `Str.isUuid()`
値が有効な UUID（任意のバージョン）の場合に `true` を返します:
``` 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()`
`subject` 内で `pattern` の最初の正規表現マッチを返します。マッチがない場合は `null` を返します:
``` dart
Str.match(RegExp(r'\d+'), 'item 42 in 99 stock'); // '42'
```
> **注意:** これは正規表現マッチャーであり、`Map` ベースの値ルックアップに使用するグローバル [`match`](#method-match) ヘルパーとは別のものです。
#### `Str.matchAll()`
`subject` 内で `pattern` のすべての正規表現マッチを返します:
``` dart
Str.matchAll(RegExp(r'\d+'), 'item 42 in 99 stock'); // ['42', '99']
```
#### `Str.padBoth()`
`length` に達するまで両側を `pad` でパディングします:
``` 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()`
`haystack` 内の `needle` の最初の出現インデックスを返します。見つからない場合は `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()`
`subject` から `search` のいずれかを除去します:
``` 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()`
`subject` 内の `search` のすべての出現を `replace` で置き換えます:
``` 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()`
`haystack` 内の `needle` の重複しない出現回数を数えます:
``` 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`（`after` が null の場合は `before`）の単一インスタンスを取り除きます:
``` 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()`
値が `min` と `max` の間（両端含む）にある場合に `true` を返します:
``` 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()`
2つの整数の最大公約数:
``` dart
Number.gcd(12, 18); // 6
```
#### `Number.lcm()`
2つの整数の最小公倍数:
``` dart
Number.lcm(4, 6); // 12
```
#### `Number.lerp()`
`t`（`0..1`）で `a` と `b` の間を線形補間します:
``` 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` は**ドット記法**パスを使用してマップを操作するユーティリティを提供します。リスト要素は整数インデックスでアドレス指定できます（例: `'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()`
2つの値が構造的に等しい場合（`Map` と `List` の再帰的比較）に `true` を返します:
``` dart
Obj.deepEquals({'a': [1, 2]}, {'a': [1, 2]}); // true
Obj.deepEquals({'a': 1}, {'a': 2}); // false
```
#### `Obj.divide()`
マップを `[keys, values]` のペアに分割します:
``` dart
Obj.divide({'name': 'Desk', 'price': 100});
// [['name', 'price'], ['Desk', 100]]
```
#### `Obj.dot()`
ネストしたマップをドットパスをキーとする単一レベルのマップに平坦化します:
``` dart
Obj.dot({'a': {'b': 1, 'c': 2}});
// {'a.b': 1, 'a.c': 2}
```
#### `Obj.except()`
指定したキー以外のすべてのエントリを含む新しいマップを返します:
``` dart
Obj.except({'name': 'Anna', 'role': 'admin', 'age': 30}, ['age']);
// {'name': 'Anna', 'role': 'admin'}
```
#### `Obj.exists()`
マップがトップレベルで指定したキーを持つ場合に `true` を返します（ドット記法のトラバーサルはしません）:
``` 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()`
マップからキー（ドット記法）を削除します。チェーン用にマップを返します:
``` 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()`
ドット記法を使用して `key` に値がある場合に `true` を返します:
``` dart
final user = {'profile': {'name': 'Anna'}};
Obj.has(user, 'profile.name'); // true
Obj.has(user, 'profile.email'); // false
```
#### `Obj.hasAll()`
指定したすべてのキーがマップ内で解決される場合に `true` を返します:
``` dart
Obj.hasAll({'a': 1, 'b': 2}, ['a', 'b']); // true
Obj.hasAll({'a': 1, 'b': 2}, ['a', 'c']); // false
```
#### `Obj.hasAny()`
指定したキーのいずれかがマップ内で解決される場合に `true` を返します:
``` dart
Obj.hasAny({'a': 1}, ['a', 'b']); // true
Obj.hasAny({'a': 1}, ['x', 'y']); // false
```
#### `Obj.mapKeys()`
各キーを `fn` で変換した新しいマップを返します:
``` dart
Obj.mapKeys({'firstName': 'Anna'}, (k) => k.toLowerCase());
// {'firstname': 'Anna'}
```
#### `Obj.mapValues()`
各値を `fn` で変換した新しいマップを返します:
``` dart
Obj.mapValues({'a': 1, 'b': 2}, (v) => v * 10);
// {'a': 10, 'b': 20}
```
#### `Obj.merge()`
`source` を `target` に再帰的にマージします。キーが衝突した場合は `source` が勝ちます。ネストしたマップはマージされます:
``` dart
Obj.merge(
{'a': {'x': 1}, 'b': 2},
{'a': {'y': 9}, 'b': 22},
);
// {'a': {'x': 1, 'y': 9}, 'b': 22}
```
#### `Obj.only()`
指定したキーのエントリのみを含む新しいマップを返します:
``` dart
Obj.only({'name': 'Anna', 'role': 'admin', 'age': 30}, ['name', 'role']);
// {'name': 'Anna', 'role': 'admin'}
```
#### `Obj.prependKeysWith()`
マップのすべてのトップレベルキーに指定したプレフィックスを付けます:
``` dart
Obj.prependKeysWith({'name': 'Anna', 'age': 30}, 'user_');
// {'user_name': 'Anna', 'user_age': 30}
```
#### `Obj.pull()`
`key` の値を返し、マップから削除します:
``` dart
final user = {'name': 'Anna', 'temp': 'token'};
final temp = Obj.pull(user, 'temp'); // 'token'
// user: {'name': 'Anna'}
```
#### `Obj.query()`
マップを 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` に値を設定し、パスに沿ってネストしたマップを作成します。マップをその場で変換し、チェーン用に返します:
``` dart
final user = {};
Obj.set(user, 'profile.email', 'a@b');
// user: {'profile': {'email': 'a@b'}}
```
#### `Obj.undot()`
ドットキーのマップをネストした構造に展開します（[`dot`](#method-obj-dot) の逆）:
``` dart
Obj.undot({'a.b': 1, 'a.c': 2});
// {'a': {'b': 1, 'c': 2}}
```
#### `Obj.whereNotEmpty()`
値が `null` または空（空の `String`、`Iterable`、`Map`）のエントリを除いた新しいマップを返します:
``` dart
Obj.whereNotEmpty({'name': 'Anna', 'tags': [], 'bio': ''});
// {'name': 'Anna'}
```
#### `Obj.whereNotNull()`
値が `null` のエントリを除いた新しいマップを返します:
``` dart
Obj.whereNotNull({'name': 'Anna', 'email': null});
// {'name': 'Anna'}
```
## その他
これらのグローバル関数は `helper.dart` に存在し、`nylo_framework` をインポートすればどこでも利用できます。
#### `api()`
`NyApiService` を通じて API リクエストを送信するための便利なヘルパーです。完全なオプションは [Networking](/docs/7.x/networking) ページを参照してください:
``` dart
await api((request) =>
request.get('https://jsonplaceholder.typicode.com/posts'));
```
#### `dataToModel()`
`config/decoders.dart` に登録されたモデルに生データ（通常は JSON の `Map`）を変換します。型パラメータが必要です:
``` dart
final user = dataToModel(data: {'name': 'Anna', 'age': 30});
```
#### `dump()`
値をコンソールにダンプします。`alwaysPrint: true` でない限り、アプリの `APP_DEBUG` フラグに従います:
``` 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()`
16進数カラー文字列を `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()`
`APP_DEBUG` が `false` の場合でも次の `NyLogger` ログを強制表示します。リリースビルドでのワンオフ診断に便利です:
``` dart
showNextLog();
NyLogger.info('This will print regardless of APP_DEBUG');
```
#### `sleep()`
指定した期間、実行を遅延します。最初の引数は秒数で、オプションの第2引数はマイクロ秒を追加します:
``` 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'});
```