Collection.md
July 25, 2013 · View on GitHub
コレクション関数(配列またはオブジェクト) 原文
each _.each(list, iterator, [context]) Alias: forEach 原文
list の要素を繰り返して、それぞれの番で iterator 関数を動作させます。 iterator は 引数に渡されていれば context オブジェクトから派生します。それぞれの iterator の呼び出しは3つの引数から呼ばれます。： (element, index, list)です。 list がJavaScriptオブジェクトの場合、 iterator の引数は(value, key, list)となります。ネイティブの forEach 関数が存在した場合には委譲します。
_.each([1, 2, 3], alert);
=> alerts each number in turn...
_.each({one : 1, two : 2, three : 3}, alert);
=> alerts each number value in turn...
map _.map(list, iterator, [context]) Alias: collect 原文
変換関数( iterator )を通して、 list 中のそれぞれの値をマッピングした値を持つ新しい配列を生成します。ネイティブの map メソッドが存在する場合は、そちらを代わりに使用します。 list がJavaScriptオブジェクトの場合は、 iterator の引数は(value, key, list)になります。
_.map([1, 2, 3], function(num){ return num * 3; });
=> [3, 6, 9]
_.map({one : 1, two : 2, three : 3}, function(num, key){ return num * 3; });
=> [3, 6, 9]
reduce _.reduce(list, iterator, memo, [context]) Alias: inject, foldl 原文
inject や foldl として知られてもいますが、 reduce は list の値を単一の値に要約します。 Memo は減算の最初の状態で、 iterator のそれぞれ成功した段階でこれを返します。イテレータは4つの引数を取ります：memo、valueと繰り返しのindex(またはキー)、そして最後にlist全ての参照です。
var sum = _.reduce([1, 2, 3], function(memo, num){ return memo + num; }, 0);
=> 6
reduceRight _.reduceRight(list, iterator, memo, [context]) Alias: foldr 原文
右から結合するバージョンの reduce です。存在する場合は、JavaScript 1.8バージョンの reduceRight に委譲します。 Foldr は遅延評価がある言語ほどにはJavaScriptでは有用ではありません。
var list = [[0, 1], [2, 3], [4, 5]];
var flat = _.reduceRight(list, function(a, b) { return a.concat(b); }, []);
=> [4, 5, 2, 3, 0, 1]
find _.find(list, iterator, [context]) Alias: detect 原文
list 内のそれぞれの値を調べていき、テストをtrueで通った最初のもの( iterator )を返します。この関数は適合した要素を見つけ次第返し、全てのリストを探索はしません。
var even = _.find([1, 2, 3, 4, 5, 6], function(num){ return num % 2 == 0; });
=> 2
filter _.filter(list, iterator, [context]) Alias: select 原文
list 内のそれぞれの値を調べていき、テストをtrueで通った全ての値( iterator )を返します。ネイティブの filter メソッドがある場合には委譲します。
var evens = _.filter([1, 2, 3, 4, 5, 6], function(num){ return num % 2 == 0; });
=> [2, 4, 6]
where _.where(list, properties) 原文
list 内のそれぞれの値を調べていき、 properties で列挙された中で全てのkey-valueペアを含んだ全ての値を配列として返します。
_.where(listOfPlays, {author: "Shakespeare", year: 1611});
=> [{title: "Cymbeline", author: "Shakespeare", year: 1611},
{title: "The Tempest", author: "Shakespeare", year: 1611}]
reject _.reject(list, iterator, [context]) 原文
テストをtrueで通った要素( iterator )を除いた list 内の値を返します。 filter の反対です。
var odds = _.reject([1, 2, 3, 4, 5, 6], function(num){ return num % 2 == 0; });
=> [1, 3, 5]
every _.every(list, iterator, [context]) Alias: all 原文
list 内の値が全て iterator のテストをtrueで通った場合に、 true を返します。存在する場合はネイティブメソッドの every に委譲します。
_.every([true, 1, null, 'yes'], _.identity);
=> false
some _.some(list, [iterator], [context]) Alias: any 原文
list 内の値が1つでも iterator のテストをtrueで通った場合に、 true を返します。trueを返す要素が見つかった場合は、探索を中断して、リストを遡るのを止めます。
_.some([null, 0, 'yes', false]);
=> true
contains _.contains(list, value) Alias: include 原文
value が list 内に存在する場合には true を返します。 list が配列の際には、内部的に indexOf が使用されます。
_.contains([1, 2, 3], 3);
=> true
invoke _.invoke(list, methodName, [*arguments]) 原文
list 内のそれぞれの値に対して methodName で指定されたメソッドを呼び出します。 invoke に渡されたどんな追加引数もこのメソッド呼び出しに送られます。
_.invoke([[5, 1, 7], [3, 2, 1]], 'sort');
=> [[1, 5, 7], [1, 2, 3]]
pluck _.pluck(list, propertyName) 原文
たぶん map のもっとも一般的なユースケース：プロパティの値のリストを抽出するための便利なバージョンです。
var stooges = [{name : 'moe', age : 40}, {name : 'larry', age : 50}, {name : 'curly', age : 60}];
_.pluck(stooges, 'name');
=> ["moe", "larry", "curly"]
max _.max(list, [iterator], [context]) 原文
list 内の最大値を返します。 iterator が渡された場合、それぞれの値に対し、ランク付けするための基準を生成するために使用されます。
var stooges = [{name : 'moe', age : 40}, {name : 'larry', age : 50}, {name : 'curly', age : 60}];
_.max(stooges, function(stooge){ return stooge.age; });
=> {name : 'curly', age : 60};
min _.min(list, [iterator], [context]) 原文
list 内の最小値を返します。 iterator が渡された場合、それぞれの値に対し、ランク付けするための基準を生成するために使用されます。
var numbers = [10, 5, 100, 2, 1000];
_.min(numbers);
=> 2
sortBy _.sortBy(list, iterator, [context]) 原文
iterator を通して実行したそれぞれの値の結果を昇順でランク付けした list のソート済みのコピーを返します。イテレータには並べ替えに使うプロパティ名(例：length)を文字列で指定することもできます。
_.sortBy([1, 2, 3, 4, 5, 6], function(num){ return Math.sin(num); });
=> [5, 4, 6, 3, 1, 2]
groupBy _.groupBy(list, iterator) 原文
iterator を通して実行したそれぞれの値の結果を使いグループ分けされたセットにコレクションを分割します。 iterator が関数の代わりに文字列の場合、それぞれの値に対して iterator で命名されたプロパティを使ってグループ分けします。
_.groupBy([1.3, 2.1, 2.4], function(num){ return Math.floor(num); });
=> {1: [1.3], 2: [2.1, 2.4]}
_.groupBy(['one', 'two', 'three'], 'length');
=> {3: ["one", "two"], 5: ["three"]}
countBy _.countBy(list, iterator) 原文
グループ内のリストをソートして、各グループのオブジェクトの数を数えて返します。groupByに似ていますが、リストの値を返す代わりにグループ内の数を数えた値を返します。
_.countBy([1, 2, 3, 4, 5], function(num) {
return num % 2 == 0 ? 'even' : 'odd';
});
=> {odd: 3, even: 2}
shuffle _.shuffle(list) 原文
Fisher-Yates shuffleを使いシャッフルされた list のコピーを返します。
_.shuffle([1, 2, 3, 4, 5, 6]);
=> [4, 1, 6, 3, 5, 2]
toArray _.toArray(list) 原文
list (イテレートできるものなら何でも)を本当の配列に変換します。 arguments オブジェクトを変換するのに役立ちます。
(function(){ return _.toArray(arguments).slice(1); })(1, 2, 3, 4);
=> [2, 3, 4]
size _.size(list) 原文
list 内の値の数を返します。
_.size({one : 1, two : 2, three : 3});
=> 3