_.chunk(array, [size=1])

source npm パッケージ

arrayの要素をsizeの長さのグループに分割した配列を作成します。arrayが均等に分割できない場合、最後のチャンクは残りの要素になります。

Since

3.0.0

引数

1. array(Array): 処理する配列。
2. [size=1] (number): 各チャンクの長さ

戻り値

(Array): チャンクの新しい配列を返します。

例

_.chunk(['a', 'b', 'c', 'd'], 2);
// => [['a', 'b'], ['c', 'd']]
 
_.chunk(['a', 'b', 'c', 'd'], 3);
// => [['a', 'b', 'c'], ['d']]

_.compact(array)

source npm パッケージ

偽値がすべて削除された配列を作成します。偽値は、false、null、0、""、undefined、およびNaNです。

Since

0.1.0

引数

1. array (Array): コンパクト化する配列。

戻り値

(Array): フィルタリングされた値の新しい配列を返します。

例

_.compact([0, 1, false, 2, '', 3]);
// => [1, 2, 3]

_.concat(array, [values])

source npm パッケージ

arrayに追加の配列や値を連結した新しい配列を作成します。

Since

4.0.0

引数

1. array (Array): 連結する配列。
2. [values] (...*): 連結する値。

戻り値

(Array): 連結された新しい配列を返します。

例

var array = [1];
var other = _.concat(array, 2, [3], [[4]]);
 
console.log(other);
// => [1, 2, 3, [4]]
 
console.log(array);
// => [1]

_.difference(array, [values])

source npm パッケージ

SameValueZeroを使用して等価性比較を行い、他の指定された配列に含まれていないarrayの値の配列を作成します。結果の値の順序と参照は、最初の配列によって決定されます。

注: _.pullAllとは異なり、このメソッドは新しい配列を返します。

Since

0.1.0

引数

1. array (Array): 検査する配列。
2. [values] (...Array): 除外する値。

戻り値

(Array): フィルタリングされた値の新しい配列を返します。

例

_.difference([2, 1], [2, 3]);
// => [1]

_.differenceBy(array, [values], [iteratee=_.identity])

source npm パッケージ

このメソッドは_.differenceに似ていますが、arrayとvaluesの各要素に対して呼び出されるiterateeを受け入れ、比較の基準を生成する点が異なります。結果の値の順序と参照は、最初の配列によって決定されます。iterateeは1つの引数で呼び出されます。
(value).

注: _.pullAllByとは異なり、このメソッドは新しい配列を返します。

Since

4.0.0

引数

1. array (Array): 検査する配列。
2. [values] (...Array): 除外する値。
3. [iteratee=_.identity] (Function): 要素ごとに呼び出されるiteratee。

戻り値

(Array): フィルタリングされた値の新しい配列を返します。

例

_.differenceBy([2.1, 1.2], [2.3, 3.4], Math.floor);
// => [1.2]
 
// The `_.property` iteratee shorthand.
_.differenceBy([{ 'x': 2 }, { 'x': 1 }], [{ 'x': 1 }], 'x');
// => [{ 'x': 2 }]

_.differenceWith(array, [values], [comparator])

source npm パッケージ

このメソッドは_.differenceに似ていますが、arrayの要素とvaluesを比較するために呼び出されるcomparatorを受け入れる点が異なります。結果の値の順序と参照は、最初の配列によって決定されます。コンパレータは2つの引数で呼び出されます: (arrVal, othVal)。

注: _.pullAllWithとは異なり、このメソッドは新しい配列を返します。

Since

4.0.0

引数

1. array (Array): 検査する配列。
2. [values] (...Array): 除外する値。
3. [comparator] (Function): 要素ごとに呼び出されるコンパレータ。

戻り値

(Array): フィルタリングされた値の新しい配列を返します。

例

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
 
_.differenceWith(objects, [{ 'x': 1, 'y': 2 }], _.isEqual);
// => [{ 'x': 2, 'y': 1 }]

_.drop(array, [n=1])

source npm パッケージ

先頭からn個の要素をドロップしたarrayのスライスを作成します。

Since

0.5.0

引数

1. array (Array): クエリする配列。
2. [n=1] (number): ドロップする要素の数。

戻り値

(Array): arrayのスライスを返します。

例

_.drop([1, 2, 3]);
// => [2, 3]
 
_.drop([1, 2, 3], 2);
// => [3]
 
_.drop([1, 2, 3], 5);
// => []
 
_.drop([1, 2, 3], 0);
// => [1, 2, 3]

_.dropRight(array, [n=1])

source npm パッケージ

末尾からn個の要素をドロップしたarrayのスライスを作成します。

Since

3.0.0

引数

1. array (Array): クエリする配列。
2. [n=1] (number): ドロップする要素の数。

戻り値

(Array): arrayのスライスを返します。

例

_.dropRight([1, 2, 3]);
// => [1, 2]
 
_.dropRight([1, 2, 3], 2);
// => [1]
 
_.dropRight([1, 2, 3], 5);
// => []
 
_.dropRight([1, 2, 3], 0);
// => [1, 2, 3]

_.dropRightWhile(array, [predicate=_.identity])

source npm パッケージ

末尾からドロップされた要素を除外したarrayのスライスを作成します。predicateが偽値を返すまで要素がドロップされます。述語は3つの引数で呼び出されます: (value, index, array)。

Since

3.0.0

引数

1. array (Array): クエリする配列。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。

戻り値

(Array): arrayのスライスを返します。

例

var users = [
  { 'user': 'barney',  'active': true },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': false }
];
 
_.dropRightWhile(users, function(o) { return !o.active; });
// => objects for ['barney']
 
// The `_.matches` iteratee shorthand.
_.dropRightWhile(users, { 'user': 'pebbles', 'active': false });
// => objects for ['barney', 'fred']
 
// The `_.matchesProperty` iteratee shorthand.
_.dropRightWhile(users, ['active', false]);
// => objects for ['barney']
 
// The `_.property` iteratee shorthand.
_.dropRightWhile(users, 'active');
// => objects for ['barney', 'fred', 'pebbles']

_.dropWhile(array, [predicate=_.identity])

ソース npm パッケージ

array の先頭から、要素が削除されていくスライスを作成します。predicate が falsy を返すまで要素が削除されます。predicate は 3 つの引数 (value, index, array) で呼び出されます。

Since

3.0.0

引数

1. array (Array): クエリする配列。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。

戻り値

(Array): arrayのスライスを返します。

例

var users = [
  { 'user': 'barney',  'active': false },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': true }
];
 
_.dropWhile(users, function(o) { return !o.active; });
// => objects for ['pebbles']
 
// The `_.matches` iteratee shorthand.
_.dropWhile(users, { 'user': 'barney', 'active': false });
// => objects for ['fred', 'pebbles']
 
// The `_.matchesProperty` iteratee shorthand.
_.dropWhile(users, ['active', false]);
// => objects for ['pebbles']
 
// The `_.property` iteratee shorthand.
_.dropWhile(users, 'active');
// => objects for ['barney', 'fred', 'pebbles']

_.fill(array, value, [start=0], [end=array.length])

ソース npm パッケージ

array の要素を、start から end（ただし end は含まない）まで value で埋めます。

注意: このメソッドは array を変更します。

Since

3.2.0

引数

1. array (Array): 埋める配列。
2. value (*): array を埋める値。
3. [start=0] (number): 開始位置。
4. [end=array.length] (number): 終了位置。

戻り値

(Array): array を返します。

例

var array = [1, 2, 3];
 
_.fill(array, 'a');
console.log(array);
// => ['a', 'a', 'a']
 
_.fill(Array(3), 2);
// => [2, 2, 2]
 
_.fill([4, 6, 8, 10], '*', 1, 3);
// => [4, '*', '*', 10]

_.findIndex(array, [predicate=_.identity], [fromIndex=0])

ソース npm パッケージ

このメソッドは _.find と似ていますが、最初に見つかった要素自体ではなく、predicate が truthy を返した最初の要素のインデックスを返します。

Since

1.1.0

引数

1. array (Array): 検査する配列。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。
3. [fromIndex=0] (number): 検索を開始するインデックス。

戻り値

(number): 見つかった要素のインデックスを返します。見つからなかった場合は -1 を返します。

例

var users = [
  { 'user': 'barney',  'active': false },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': true }
];
 
_.findIndex(users, function(o) { return o.user == 'barney'; });
// => 0
 
// The `_.matches` iteratee shorthand.
_.findIndex(users, { 'user': 'fred', 'active': false });
// => 1
 
// The `_.matchesProperty` iteratee shorthand.
_.findIndex(users, ['active', false]);
// => 0
 
// The `_.property` iteratee shorthand.
_.findIndex(users, 'active');
// => 2

_.findLastIndex(array, [predicate=_.identity], [fromIndex=array.length-1])

ソース npm パッケージ

このメソッドは _.findIndex と似ていますが、collection の要素を右から左に反復処理します。

Since

2.0.0

引数

1. array (Array): 検査する配列。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。
3. [fromIndex=array.length-1] (number): 検索を開始するインデックス。

戻り値

(number): 見つかった要素のインデックスを返します。見つからなかった場合は -1 を返します。

例

var users = [
  { 'user': 'barney',  'active': true },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': false }
];
 
_.findLastIndex(users, function(o) { return o.user == 'pebbles'; });
// => 2
 
// The `_.matches` iteratee shorthand.
_.findLastIndex(users, { 'user': 'barney', 'active': true });
// => 0
 
// The `_.matchesProperty` iteratee shorthand.
_.findLastIndex(users, ['active', false]);
// => 2
 
// The `_.property` iteratee shorthand.
_.findLastIndex(users, 'active');
// => 0

_.flatten(array)

ソース npm パッケージ

array を一段階深くフラット化します。

Since

0.1.0

引数

1. array (Array): フラット化する配列。

戻り値

(Array): 新しいフラット化された配列を返します。

例

_.flatten([1, [2, [3, [4]], 5]]);
// => [1, 2, [3, [4]], 5]

_.flattenDeep(array)

ソース npm パッケージ

array を再帰的にフラット化します。

Since

3.0.0

引数

1. array (Array): フラット化する配列。

戻り値

(Array): 新しいフラット化された配列を返します。

例

_.flattenDeep([1, [2, [3, [4]], 5]]);
// => [1, 2, 3, 4, 5]

_.flattenDepth(array, [depth=1])

ソース npm パッケージ

array を depth 回まで再帰的にフラット化します。

Since

4.4.0

引数

1. array (Array): フラット化する配列。
2. [depth=1] (number): 最大再帰深度。

戻り値

(Array): 新しいフラット化された配列を返します。

例

var array = [1, [2, [3, [4]], 5]];
 
_.flattenDepth(array, 1);
// => [1, 2, [3, [4]], 5]
 
_.flattenDepth(array, 2);
// => [1, 2, 3, [4], 5]

_.fromPairs(pairs)

ソース npm パッケージ

_.toPairs の逆です。このメソッドは、キーと値の pairs から構成されたオブジェクトを返します。

Since

4.0.0

引数

1. pairs (Array): キーと値のペア。

戻り値

(Object): 新しいオブジェクトを返します。

例

_.fromPairs([['a', 1], ['b', 2]]);
// => { 'a': 1, 'b': 2 }

_.head(array)

ソース npm パッケージ

array の最初の要素を取得します。

Since

0.1.0

エイリアス

_.first

引数

1. array (Array): クエリする配列。

戻り値

(*): array の最初の要素を返します。

例

_.head([1, 2, 3]);
// => 1
 
_.head([]);
// => undefined

_.indexOf(array, value, [fromIndex=0])

ソース npm パッケージ

array 内で最初に見つかった value のインデックスを、SameValueZero を用いた等価性比較によって取得します。fromIndex が負数の場合は、array の末尾からのオフセットとして使用されます。

Since

0.1.0

引数

1. array (Array): 検査する配列。
2. value (*): 検索する値。
3. [fromIndex=0] (number): 検索を開始するインデックス。

戻り値

(number): 一致する値のインデックスを返します。一致するものがない場合は -1 を返します。

例

_.indexOf([1, 2, 1, 2], 2);
// => 1
 
// Search from the `fromIndex`.
_.indexOf([1, 2, 1, 2], 2, 2);
// => 3

_.initial(array)

ソース npm パッケージ

array の最後の要素以外のすべてを取得します。

Since

0.1.0

引数

1. array (Array): クエリする配列。

戻り値

(Array): arrayのスライスを返します。

例

_.initial([1, 2, 3]);
// => [1, 2]

_.intersection([arrays])

ソース npm パッケージ

SameValueZero を用いた等価性比較によって、与えられたすべての配列に含まれるユニークな値の配列を作成します。結果の値の順序と参照は、最初の配列によって決定されます。

Since

0.1.0

引数

1. [arrays] (...Array): 検査する配列。

戻り値

(Array): 交差する値の新しい配列を返します。

例

_.intersection([2, 1], [2, 3]);
// => [2]

_.intersectionBy([arrays], [iteratee=_.identity])

ソース npm パッケージ

このメソッドは _.intersection と似ていますが、各 arrays の各要素に対して呼び出され、比較基準を生成する iteratee を受け入れます。結果の値の順序と参照は、最初の配列によって決定されます。iteratee は 1 つの引数で呼び出されます。
(value).

Since

4.0.0

引数

1. [arrays] (...Array): 検査する配列。
2. [iteratee=_.identity] (Function): 要素ごとに呼び出されるiteratee。

戻り値

(Array): 交差する値の新しい配列を返します。

例

_.intersectionBy([2.1, 1.2], [2.3, 3.4], Math.floor);
// => [2.1]
 
// The `_.property` iteratee shorthand.
_.intersectionBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x');
// => [{ 'x': 1 }]

_.intersectionWith([arrays], [comparator])

ソース npm パッケージ

このメソッドは _.intersection と似ていますが、arrays の要素を比較するために呼び出される comparator を受け入れます。結果の値の順序と参照は、最初の配列によって決定されます。コンパレータは 2 つの引数 (arrVal, othVal) で呼び出されます。

Since

4.0.0

引数

1. [arrays] (...Array): 検査する配列。
2. [comparator] (Function): 要素ごとに呼び出されるコンパレータ。

戻り値

(Array): 交差する値の新しい配列を返します。

例

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];
 
_.intersectionWith(objects, others, _.isEqual);
// => [{ 'x': 1, 'y': 2 }]

_.join(array, [separator=','])

ソース npm パッケージ

array のすべての要素を、separator で区切られた文字列に変換します。

Since

4.0.0

引数

1. array (Array): 変換する配列。
2. [separator=','] (string): 要素の区切り文字。

戻り値

(string): 結合された文字列を返します。

例

_.join(['a', 'b', 'c'], '~');
// => 'a~b~c'

_.last(array)

ソース npm パッケージ

array の最後の要素を取得します。

Since

0.1.0

引数

1. array (Array): クエリする配列。

戻り値

(*): array の最後の要素を返します。

例

_.last([1, 2, 3]);
// => 3

_.lastIndexOf(array, value, [fromIndex=array.length-1])

ソース npm パッケージ

このメソッドは _.indexOf と似ていますが、array の要素を右から左に反復処理します。

Since

0.1.0

引数

1. array (Array): 検査する配列。
2. value (*): 検索する値。
3. [fromIndex=array.length-1] (number): 検索を開始するインデックス。

戻り値

(number): 一致する値のインデックスを返します。一致するものがない場合は -1 を返します。

例

_.lastIndexOf([1, 2, 1, 2], 2);
// => 3
 
// Search from the `fromIndex`.
_.lastIndexOf([1, 2, 1, 2], 2, 2);
// => 1

_.nth(array, [n=0])

ソース npm パッケージ

array のインデックス n の要素を取得します。n が負数の場合、末尾から数えて n 番目の要素が返されます。

Since

4.11.0

引数

1. array (Array): クエリする配列。
2. [n=0] (number): 返す要素のインデックス。

戻り値

(*): array の n 番目の要素を返します。

例

var array = ['a', 'b', 'c', 'd'];
 
_.nth(array, 1);
// => 'b'
 
_.nth(array, -2);
// => 'c';

_.pull(array, [values])

ソース npm パッケージ

SameValueZero を用いた等価性比較によって、指定されたすべての値を array から削除します。

注意: _.without とは異なり、このメソッドは array を変更します。述語によって配列から要素を削除するには、_.remove を使用します。

Since

2.0.0

引数

1. array (Array): 変更する配列。
2. [values] (...*): 削除する値。

戻り値

(Array): array を返します。

例

var array = ['a', 'b', 'c', 'a', 'b', 'c'];
 
_.pull(array, 'a', 'c');
console.log(array);
// => ['b', 'b']

_.pullAll(array, values)

ソース npm パッケージ

このメソッドは _.pull と似ていますが、削除する値の配列を受け入れます。

注意: _.difference とは異なり、このメソッドは array を変更します。

Since

4.0.0

引数

1. array (Array): 変更する配列。
2. values (Array): 削除する値。

戻り値

(Array): array を返します。

例

var array = ['a', 'b', 'c', 'a', 'b', 'c'];
 
_.pullAll(array, ['a', 'c']);
console.log(array);
// => ['b', 'b']

_.pullAllBy(array, values, [iteratee=_.identity])

ソース npm パッケージ

このメソッドは _.pullAll と似ていますが、array と values の各要素に対して呼び出され、比較基準を生成する iteratee を受け入れます。iteratee は 1 つの引数 (value) で呼び出されます。

注意: _.differenceBy とは異なり、このメソッドは array を変更します。

Since

4.0.0

引数

1. array (Array): 変更する配列。
2. values (Array): 削除する値。
3. [iteratee=_.identity] (Function): 要素ごとに呼び出されるiteratee。

戻り値

(Array): array を返します。

例

var array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }];
 
_.pullAllBy(array, [{ 'x': 1 }, { 'x': 3 }], 'x');
console.log(array);
// => [{ 'x': 2 }]

_.pullAllWith(array, values, [comparator])

ソース npm パッケージ

このメソッドは _.pullAll と似ていますが、array の要素と values を比較するために呼び出される comparator を受け入れます。コンパレータは 2 つの引数 (arrVal, othVal) で呼び出されます。

注意: _.differenceWith とは異なり、このメソッドは array を変更します。

Since

4.6.0

引数

1. array (Array): 変更する配列。
2. values (Array): 削除する値。
3. [comparator] (Function): 要素ごとに呼び出されるコンパレータ。

戻り値

(Array): array を返します。

例

var array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }];
 
_.pullAllWith(array, [{ 'x': 3, 'y': 4 }], _.isEqual);
console.log(array);
// => [{ 'x': 1, 'y': 2 }, { 'x': 5, 'y': 6 }]

_.pullAt(array, [indexes])

ソース npm パッケージ

indexes に対応する array から要素を削除し、削除された要素の配列を返します。

注意: _.at とは異なり、このメソッドは array を変更します。

Since

3.0.0

引数

1. array (Array): 変更する配列。
2. [indexes] (...(number|number[])): 削除する要素のインデックス。

戻り値

(Array): 削除された要素の新しい配列を返します。

例

var array = ['a', 'b', 'c', 'd'];
var pulled = _.pullAt(array, [1, 3]);
 
console.log(array);
// => ['a', 'c']
 
console.log(pulled);
// => ['b', 'd']

_.remove(array, [predicate=_.identity])

ソース npm パッケージ

predicate が truthy を返す array からすべての要素を削除し、削除された要素の配列を返します。predicate は 3 つの引数 (value, index, array) で呼び出されます。

注意: _.filter とは異なり、このメソッドは array を変更します。値によって配列から要素を削除するには、_.pull を使用します。

Since

2.0.0

引数

1. array (Array): 変更する配列。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。

戻り値

(Array): 削除された要素の新しい配列を返します。

例

var array = [1, 2, 3, 4];
var evens = _.remove(array, function(n) {
  return n % 2 == 0;
});
 
console.log(array);
// => [1, 3]
 
console.log(evens);
// => [2, 4]

_.reverse(array)

ソース npm パッケージ

array の要素の順番を反転させます。最初の要素が最後になり、2番目の要素が最後から2番目になる、といった具合です。

注意: このメソッドは array を変更し、Array#reverse に基づいています。

Since

4.0.0

引数

1. array (Array): 変更する配列。

戻り値

(Array): array を返します。

例

var array = [1, 2, 3];
 
_.reverse(array);
// => [3, 2, 1]
 
console.log(array);
// => [3, 2, 1]

_.slice(array, [start=0], [end=array.length])

ソース npm パッケージ

array の start から end (end は含まない)までのスライスを作成します。

注意: このメソッドは、密な配列が返されることを保証するために、Array#slice の代わりに使用されます。

Since

3.0.0

引数

1. array (Array): スライスする配列。
2. [start=0] (number): 開始位置。
3. [end=array.length] (number): 終了位置。

戻り値

(Array): arrayのスライスを返します。

_.sortedIndex(array, value)

ソース npm パッケージ

ソートされた array 内で、ソート順を維持するために value を挿入すべき最も低いインデックスを、二分探索を使用して決定します。

Since

0.1.0

引数

1. array (Array): 検査するソート済みの配列。
2. value (*): 評価する値。

戻り値

(number): value を array に挿入すべきインデックスを返します。

例

_.sortedIndex([30, 50], 40);
// => 1

_.sortedIndexBy(array, value, [iteratee=_.identity])

ソース npm パッケージ

このメソッドは _.sortedIndex に似ていますが、iteratee を受け入れる点が異なります。iteratee は、ソートランキングを計算するために、value および array の各要素に対して呼び出されます。イテレーターは1つの引数 (value) で呼び出されます。

Since

4.0.0

引数

1. array (Array): 検査するソート済みの配列。
2. value (*): 評価する値。
3. [iteratee=_.identity] (Function): 要素ごとに呼び出されるiteratee。

戻り値

(number): value を array に挿入すべきインデックスを返します。

例

var objects = [{ 'x': 4 }, { 'x': 5 }];
 
_.sortedIndexBy(objects, { 'x': 4 }, function(o) { return o.x; });
// => 0
 
// The `_.property` iteratee shorthand.
_.sortedIndexBy(objects, { 'x': 4 }, 'x');
// => 0

_.sortedIndexOf(array, value)

ソース npm パッケージ

このメソッドは _.indexOf に似ていますが、ソートされた array に対して二分探索を実行する点が異なります。

Since

4.0.0

引数

1. array (Array): 検査する配列。
2. value (*): 検索する値。

戻り値

(number): 一致する値のインデックスを返します。一致するものがない場合は -1 を返します。

例

_.sortedIndexOf([4, 5, 5, 5, 6], 5);
// => 1

_.sortedLastIndex(array, value)

ソース npm パッケージ

このメソッドは _.sortedIndex に似ていますが、ソート順を維持するために value を array に挿入すべき最も高いインデックスを返す点が異なります。

Since

3.0.0

引数

1. array (Array): 検査するソート済みの配列。
2. value (*): 評価する値。

戻り値

(number): value を array に挿入すべきインデックスを返します。

例

_.sortedLastIndex([4, 5, 5, 5, 6], 5);
// => 4

_.sortedLastIndexBy(array, value, [iteratee=_.identity])

ソース npm パッケージ

このメソッドは _.sortedLastIndex に似ていますが、iteratee を受け入れる点が異なります。iteratee は、ソートランキングを計算するために、value および array の各要素に対して呼び出されます。イテレーターは1つの引数 (value) で呼び出されます。

Since

4.0.0

引数

1. array (Array): 検査するソート済みの配列。
2. value (*): 評価する値。
3. [iteratee=_.identity] (Function): 要素ごとに呼び出されるiteratee。

戻り値

(number): value を array に挿入すべきインデックスを返します。

例

var objects = [{ 'x': 4 }, { 'x': 5 }];
 
_.sortedLastIndexBy(objects, { 'x': 4 }, function(o) { return o.x; });
// => 1
 
// The `_.property` iteratee shorthand.
_.sortedLastIndexBy(objects, { 'x': 4 }, 'x');
// => 1

_.sortedLastIndexOf(array, value)

ソース npm パッケージ

このメソッドは _.lastIndexOf に似ていますが、ソートされた array に対して二分探索を実行する点が異なります。

Since

4.0.0

引数

1. array (Array): 検査する配列。
2. value (*): 検索する値。

戻り値

(number): 一致する値のインデックスを返します。一致するものがない場合は -1 を返します。

例

_.sortedLastIndexOf([4, 5, 5, 5, 6], 5);
// => 3

_.sortedUniq(array)

ソース npm パッケージ

このメソッドは _.uniq に似ていますが、ソートされた配列向けに設計および最適化されている点が異なります。

Since

4.0.0

引数

1. array (Array): 検査する配列。

戻り値

(Array): 重複のない新しい配列を返します。

例

_.sortedUniq([1, 1, 2]);
// => [1, 2]

_.sortedUniqBy(array, [iteratee])

ソース npm パッケージ

このメソッドは _.uniqBy に似ていますが、ソートされた配列向けに設計および最適化されている点が異なります。

Since

4.0.0

引数

1. array (Array): 検査する配列。
2. [iteratee] (Function): 要素ごとに呼び出されるイテレーター。

戻り値

(Array): 重複のない新しい配列を返します。

例

_.sortedUniqBy([1.1, 1.2, 2.3, 2.4], Math.floor);
// => [1.1, 2.3]

_.tail(array)

ソース npm パッケージ

array の最初の要素を除くすべての要素を取得します。

Since

4.0.0

引数

1. array (Array): クエリする配列。

戻り値

(Array): arrayのスライスを返します。

例

_.tail([1, 2, 3]);
// => [2, 3]

_.take(array, [n=1])

ソース npm パッケージ

array の先頭から n 個の要素を取得したスライスを作成します。

Since

0.1.0

引数

1. array (Array): クエリする配列。
2. [n=1] (number): 取得する要素の数。

戻り値

(Array): arrayのスライスを返します。

例

_.take([1, 2, 3]);
// => [1]
 
_.take([1, 2, 3], 2);
// => [1, 2]
 
_.take([1, 2, 3], 5);
// => [1, 2, 3]
 
_.take([1, 2, 3], 0);
// => []

_.takeRight(array, [n=1])

ソース npm パッケージ

array の末尾から n 個の要素を取得したスライスを作成します。

Since

3.0.0

引数

1. array (Array): クエリする配列。
2. [n=1] (number): 取得する要素の数。

戻り値

(Array): arrayのスライスを返します。

例

_.takeRight([1, 2, 3]);
// => [3]
 
_.takeRight([1, 2, 3], 2);
// => [2, 3]
 
_.takeRight([1, 2, 3], 5);
// => [1, 2, 3]
 
_.takeRight([1, 2, 3], 0);
// => []

_.takeRightWhile(array, [predicate=_.identity])

ソース npm パッケージ

array の末尾から要素を取得したスライスを作成します。predicate が偽を返すまで要素を取得します。述語は3つの引数 (value, index, array) で呼び出されます。

Since

3.0.0

引数

1. array (Array): クエリする配列。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。

戻り値

(Array): arrayのスライスを返します。

例

var users = [
  { 'user': 'barney',  'active': true },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': false }
];
 
_.takeRightWhile(users, function(o) { return !o.active; });
// => objects for ['fred', 'pebbles']
 
// The `_.matches` iteratee shorthand.
_.takeRightWhile(users, { 'user': 'pebbles', 'active': false });
// => objects for ['pebbles']
 
// The `_.matchesProperty` iteratee shorthand.
_.takeRightWhile(users, ['active', false]);
// => objects for ['fred', 'pebbles']
 
// The `_.property` iteratee shorthand.
_.takeRightWhile(users, 'active');
// => []

_.takeWhile(array, [predicate=_.identity])

ソース npm パッケージ

array の先頭から要素を取得したスライスを作成します。predicate が偽を返すまで要素を取得します。述語は3つの引数 (value, index, array) で呼び出されます。

Since

3.0.0

引数

1. array (Array): クエリする配列。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。

戻り値

(Array): arrayのスライスを返します。

例

var users = [
  { 'user': 'barney',  'active': false },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': true }
];
 
_.takeWhile(users, function(o) { return !o.active; });
// => objects for ['barney', 'fred']
 
// The `_.matches` iteratee shorthand.
_.takeWhile(users, { 'user': 'barney', 'active': false });
// => objects for ['barney']
 
// The `_.matchesProperty` iteratee shorthand.
_.takeWhile(users, ['active', false]);
// => objects for ['barney', 'fred']
 
// The `_.property` iteratee shorthand.
_.takeWhile(users, 'active');
// => []

_.union([arrays])

ソース npm パッケージ

与えられたすべての配列から、SameValueZero を使用して等価性を比較し、順序通りに重複のない値の配列を作成します。

Since

0.1.0

引数

1. [arrays] (...Array): 検査する配列。

戻り値

(Array): 結合された値の新しい配列を返します。

例

_.union([2], [1, 2]);
// => [2, 1]

_.unionBy([arrays], [iteratee=_.identity])

ソース npm パッケージ

このメソッドは _.union に似ていますが、iteratee を受け入れる点が異なります。iteratee は、一意性を計算するための基準を生成するために、各 arrays の各要素に対して呼び出されます。結果の値は、値が発生する最初の配列から選択されます。イテレーターは1つの引数で呼び出されます。
(value).

Since

4.0.0

引数

1. [arrays] (...Array): 検査する配列。
2. [iteratee=_.identity] (Function): 要素ごとに呼び出されるiteratee。

戻り値

(Array): 結合された値の新しい配列を返します。

例

_.unionBy([2.1], [1.2, 2.3], Math.floor);
// => [2.1, 1.2]
 
// The `_.property` iteratee shorthand.
_.unionBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x');
// => [{ 'x': 1 }, { 'x': 2 }]

_.unionWith([arrays], [comparator])

ソース npm パッケージ

このメソッドは _.union に似ていますが、arrays の要素を比較するために呼び出される comparator を受け入れる点が異なります。結果の値は、値が発生する最初の配列から選択されます。コンパレーターは、2つの引数 (arrVal, othVal) で呼び出されます。

Since

4.0.0

引数

1. [arrays] (...Array): 検査する配列。
2. [comparator] (Function): 要素ごとに呼び出されるコンパレータ。

戻り値

(Array): 結合された値の新しい配列を返します。

例

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];
 
_.unionWith(objects, others, _.isEqual);
// => [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }]

_.uniq(array)

ソース npm パッケージ

配列の重複のないバージョンを作成します。SameValueZero を使用して等価性を比較し、各要素の最初の出現のみが保持されます。結果の値の順序は、配列内での出現順序によって決定されます。

Since

0.1.0

引数

1. array (Array): 検査する配列。

戻り値

(Array): 重複のない新しい配列を返します。

例

_.uniq([2, 1, 2]);
// => [2, 1]

_.uniqBy(array, [iteratee=_.identity])

ソース npm パッケージ

このメソッドは _.uniq に似ていますが、一意性を計算する基準を生成するために array 内の各要素に対して呼び出される iteratee を受け入れる点が異なります。結果の値の順序は、配列内での出現順序によって決定されます。イテレーターは1つの引数で呼び出されます。
(value).

Since

4.0.0

引数

1. array (Array): 検査する配列。
2. [iteratee=_.identity] (Function): 要素ごとに呼び出されるiteratee。

戻り値

(Array): 重複のない新しい配列を返します。

例

_.uniqBy([2.1, 1.2, 2.3], Math.floor);
// => [2.1, 1.2]
 
// The `_.property` iteratee shorthand.
_.uniqBy([{ 'x': 1 }, { 'x': 2 }, { 'x': 1 }], 'x');
// => [{ 'x': 1 }, { 'x': 2 }]

_.uniqWith(array, [comparator])

ソース npm パッケージ

このメソッドは _.uniq に似ていますが、array の要素を比較するために呼び出される comparator を受け入れる点が異なります。結果の値の順序は、配列内での出現順序によって決定されます。コンパレーターは、2つの引数 (arrVal, othVal) で呼び出されます。

Since

4.0.0

引数

1. array (Array): 検査する配列。
2. [comparator] (Function): 要素ごとに呼び出されるコンパレータ。

戻り値

(Array): 重複のない新しい配列を返します。

例

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 2 }];
 
_.uniqWith(objects, _.isEqual);
// => [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]

_.unzip(array)

ソース npm パッケージ

このメソッドは _.zip に似ていますが、グループ化された要素の配列を受け取り、要素を元の zip 前の構成に再グループ化する配列を作成する点が異なります。

Since

1.2.0

引数

1. array (Array): 処理するグループ化された要素の配列。

戻り値

(Array): 再グループ化された要素の新しい配列を返します。

例

var zipped = _.zip(['a', 'b'], [1, 2], [true, false]);
// => [['a', 1, true], ['b', 2, false]]
 
_.unzip(zipped);
// => [['a', 'b'], [1, 2], [true, false]]

_.unzipWith(array, [iteratee=_.identity])

ソース npm パッケージ

このメソッドは _.unzip に似ていますが、再グループ化された値をどのように結合するかを指定する iteratee を受け入れる点が異なります。イテレーターは、各グループの要素 (...group) で呼び出されます。

Since

3.8.0

引数

1. array (Array): 処理するグループ化された要素の配列。
2. [iteratee=_.identity] (Function): 再グループ化された値を結合する関数。

戻り値

(Array): 再グループ化された要素の新しい配列を返します。

例

var zipped = _.zip([1, 2], [10, 20], [100, 200]);
// => [[1, 10, 100], [2, 20, 200]]
 
_.unzipWith(zipped, _.add);
// => [3, 30, 300]

_.without(array, [values])

ソース npm パッケージ

SameValueZero を使用して等価性を比較し、指定されたすべての値を除外する配列を作成します。

注意: _.pull とは異なり、このメソッドは新しい配列を返します。

Since

0.1.0

引数

1. array (Array): 検査する配列。
2. [values] (...*): 除外する値。

戻り値

(Array): フィルタリングされた値の新しい配列を返します。

例

_.without([2, 1, 2, 3], 1, 2);
// => [3]

_.xor([arrays])

ソース npm パッケージ

指定された配列の対称差である一意の値の配列を作成します。結果の値の順序は、配列内での出現順序によって決定されます。

Since

2.4.0

引数

1. [arrays] (...Array): 検査する配列。

戻り値

(Array): フィルタリングされた値の新しい配列を返します。

例

_.xor([2, 1], [2, 3]);
// => [1, 3]

_.xorBy([arrays], [iteratee=_.identity])

ソース npm パッケージ

このメソッドは _.xor に似ていますが、比較される基準を生成するために、各 arrays の各要素に対して呼び出される iteratee を受け入れる点が異なります。結果の値の順序は、配列内での出現順序によって決定されます。イテレーターは1つの引数 (value) で呼び出されます。

Since

4.0.0

引数

1. [arrays] (...Array): 検査する配列。
2. [iteratee=_.identity] (Function): 要素ごとに呼び出されるiteratee。

戻り値

(Array): フィルタリングされた値の新しい配列を返します。

例

_.xorBy([2.1, 1.2], [2.3, 3.4], Math.floor);
// => [1.2, 3.4]
 
// The `_.property` iteratee shorthand.
_.xorBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x');
// => [{ 'x': 2 }]

_.xorWith([arrays], [comparator])

ソース npm パッケージ

このメソッドは、_.xor に似ていますが、comparator を受け取り、arrays の要素を比較するために呼び出されます。結果の値の順序は、配列内での出現順によって決定されます。コンパレータは、2つの引数 (arrVal, othVal) で呼び出されます。

Since

4.0.0

引数

1. [arrays] (...Array): 検査する配列。
2. [comparator] (Function): 要素ごとに呼び出されるコンパレータ。

戻り値

(Array): フィルタリングされた値の新しい配列を返します。

例

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];
 
_.xorWith(objects, others, _.isEqual);
// => [{ 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }]

_.zip([arrays])

ソース npm パッケージ

グループ化された要素の配列を作成します。最初の要素は、指定された配列の最初の要素を含み、2番目の要素は、指定された配列の2番目の要素を含み、以降同様です。

Since

0.1.0

引数

1. [arrays] (...Array): 処理する配列。

戻り値

(Array): グループ化された要素の新しい配列を返します。

例

_.zip(['a', 'b'], [1, 2], [true, false]);
// => [['a', 1, true], ['b', 2, false]]

_.zipObject([props=[]], [values=[]])

ソース npm パッケージ

このメソッドは、_.fromPairs に似ていますが、プロパティ識別子の配列と、対応する値の配列の2つを受け取ります。

Since

0.4.0

引数

1. [props=[]] (Array): プロパティ識別子。
2. [values=[]] (Array): プロパティ値。

戻り値

(Object): 新しいオブジェクトを返します。

例

_.zipObject(['a', 'b'], [1, 2]);
// => { 'a': 1, 'b': 2 }

_.zipObjectDeep([props=[]], [values=[]])

ソース npm パッケージ

このメソッドは、_.zipObject に似ていますが、プロパティパスをサポートしています。

Since

4.1.0

引数

1. [props=[]] (Array): プロパティ識別子。
2. [values=[]] (Array): プロパティ値。

戻り値

(Object): 新しいオブジェクトを返します。

例

_.zipObjectDeep(['a.b[0].c', 'a.b[1].d'], [1, 2]);
// => { 'a': { 'b': [{ 'c': 1 }, { 'd': 2 }] } }

_.zipWith([arrays], [iteratee=_.identity])

ソース npm パッケージ

このメソッドは、_.zip に似ていますが、グループ化された値をどのように結合するかを指定するための iteratee を受け取ります。イテレータは、各グループの要素 (...group) で呼び出されます。

Since

3.8.0

引数

1. [arrays] (...Array): 処理する配列。
2. [iteratee=_.identity] (Function): グループ化された値を結合する関数。

戻り値

(Array): グループ化された要素の新しい配列を返します。

例

_.zipWith([1, 2], [10, 20], [100, 200], function(a, b, c) {
  return a + b + c;
});
// => [111, 222]

_.countBy(collection, [iteratee=_.identity])

ソース npm パッケージ

collection の各要素を iteratee を介して実行した結果から生成されたキーで構成されるオブジェクトを作成します。各キーの対応する値は、キーが iteratee によって返された回数です。イテレータは、1つの引数 (value) で呼び出されます。

Since

0.5.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [iteratee=_.identity] (Function): キーを変換するイテレータ。

戻り値

(Object): 構成された集計オブジェクトを返します。

例

_.countBy([6.1, 4.2, 6.3], Math.floor);
// => { '4': 1, '6': 2 }
 
// The `_.property` iteratee shorthand.
_.countBy(['one', 'two', 'three'], 'length');
// => { '3': 2, '5': 1 }

_.every(collection, [predicate=_.identity])

ソース npm パッケージ

predicate が collection の **すべての** 要素に対して truthy を返すかどうかを確認します。predicate が falsey を返すと、反復処理は停止します。述語は、3つの引数 (value, index|key, collection) で呼び出されます。

注: このメソッドは、空のコレクションに対して true を返します。これは、空のコレクションの要素については すべてが真 であるためです。

Since

0.1.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。

戻り値

(boolean): すべての要素が述語チェックに合格した場合は true を返し、それ以外の場合は false を返します。

例

_.every([true, 1, null, 'yes'], Boolean);
// => false
 
var users = [
  { 'user': 'barney', 'age': 36, 'active': false },
  { 'user': 'fred',   'age': 40, 'active': false }
];
 
// The `_.matches` iteratee shorthand.
_.every(users, { 'user': 'barney', 'active': false });
// => false
 
// The `_.matchesProperty` iteratee shorthand.
_.every(users, ['active', false]);
// => true
 
// The `_.property` iteratee shorthand.
_.every(users, 'active');
// => false

_.filter(collection, [predicate=_.identity])

ソース npm パッケージ

collection の要素を反復処理し、predicate が truthy を返すすべての要素の配列を返します。述語は、3つの引数 (value, index|key, collection) で呼び出されます。

注: _.remove とは異なり、このメソッドは新しい配列を返します。

Since

0.1.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。

戻り値

(Array): 新しいフィルタリングされた配列を返します。

例

var users = [
  { 'user': 'barney', 'age': 36, 'active': true },
  { 'user': 'fred',   'age': 40, 'active': false }
];
 
_.filter(users, function(o) { return !o.active; });
// => objects for ['fred']
 
// The `_.matches` iteratee shorthand.
_.filter(users, { 'age': 36, 'active': true });
// => objects for ['barney']
 
// The `_.matchesProperty` iteratee shorthand.
_.filter(users, ['active', false]);
// => objects for ['fred']
 
// The `_.property` iteratee shorthand.
_.filter(users, 'active');
// => objects for ['barney']

_.find(collection, [predicate=_.identity], [fromIndex=0])

ソース npm パッケージ

collection の要素を反復処理し、predicate が truthy を返す最初の要素を返します。述語は、3つの引数 (value, index|key, collection) で呼び出されます。

Since

0.1.0

引数

1. collection (Array|Object): 検査するコレクション。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。
3. [fromIndex=0] (number): 検索を開始するインデックス。

戻り値

(*): 一致する要素を返します。それ以外の場合は undefined を返します。

例

var users = [
  { 'user': 'barney',  'age': 36, 'active': true },
  { 'user': 'fred',    'age': 40, 'active': false },
  { 'user': 'pebbles', 'age': 1,  'active': true }
];
 
_.find(users, function(o) { return o.age < 40; });
// => object for 'barney'
 
// The `_.matches` iteratee shorthand.
_.find(users, { 'age': 1, 'active': true });
// => object for 'pebbles'
 
// The `_.matchesProperty` iteratee shorthand.
_.find(users, ['active', false]);
// => object for 'fred'
 
// The `_.property` iteratee shorthand.
_.find(users, 'active');
// => object for 'barney'

_.findLast(collection, [predicate=_.identity], [fromIndex=collection.length-1])

ソース npm パッケージ

このメソッドは、_.find に似ていますが、collection の要素を右から左に反復処理します。

Since

2.0.0

引数

1. collection (Array|Object): 検査するコレクション。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。
3. [fromIndex=collection.length-1] (number): 検索を開始するインデックス。

戻り値

(*): 一致する要素を返します。それ以外の場合は undefined を返します。

例

_.findLast([1, 2, 3, 4], function(n) {
  return n % 2 == 1;
});
// => 3

_.flatMap(collection, [iteratee=_.identity])

ソース npm パッケージ

collection の各要素を iteratee を介して実行し、マップされた結果をフラット化することにより、値のフラット化された配列を作成します。イテレータは、3つの引数 (value, index|key, collection) で呼び出されます。

Since

4.0.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [iteratee=_.identity] (Function): 反復処理ごとに呼び出される関数。

戻り値

(Array): 新しいフラット化された配列を返します。

例

function duplicate(n) {
  return [n, n];
}
 
_.flatMap([1, 2], duplicate);
// => [1, 1, 2, 2]

_.flatMapDeep(collection, [iteratee=_.identity])

ソース npm パッケージ

このメソッドは、_.flatMap に似ていますが、マップされた結果を再帰的にフラット化します。

Since

4.7.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [iteratee=_.identity] (Function): 反復処理ごとに呼び出される関数。

戻り値

(Array): 新しいフラット化された配列を返します。

例

function duplicate(n) {
  return [[[n, n]]];
}
 
_.flatMapDeep([1, 2], duplicate);
// => [1, 1, 2, 2]

_.flatMapDepth(collection, [iteratee=_.identity], [depth=1])

ソース npm パッケージ

このメソッドは、_.flatMap に似ていますが、マップされた結果を最大 depth 回再帰的にフラット化します。

Since

4.7.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [iteratee=_.identity] (Function): 反復処理ごとに呼び出される関数。
3. [depth=1] (number): 最大再帰深度。

戻り値

(Array): 新しいフラット化された配列を返します。

例

function duplicate(n) {
  return [[[n, n]]];
}
 
_.flatMapDepth([1, 2], duplicate, 2);
// => [[1, 1], [2, 2]]

_.forEach(collection, [iteratee=_.identity])

ソース npm パッケージ

collection の要素を反復処理し、各要素に対して iteratee を呼び出します。イテレータは、3つの引数 (value, index|key, collection) で呼び出されます。イテレータ関数は、明示的に false を返すことで、反復処理を早期に終了できます。

注: 他の「コレクション」メソッドと同様に、「length」プロパティを持つオブジェクトは配列のように反復処理されます。この動作を回避するには、オブジェクトの反復処理に _.forIn または _.forOwn を使用します。

Since

0.1.0

エイリアス

_.each

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [iteratee=_.identity] (Function): 反復処理ごとに呼び出される関数。

戻り値

(*): collection を返します。

例

_.forEach([1, 2], function(value) {
  console.log(value);
});
// => Logs `1` then `2`.
 
_.forEach({ 'a': 1, 'b': 2 }, function(value, key) {
  console.log(key);
});
// => Logs 'a' then 'b' (iteration order is not guaranteed).

_.forEachRight(collection, [iteratee=_.identity])

ソース npm パッケージ

このメソッドは、_.forEach に似ていますが、collection の要素を右から左に反復処理します。

Since

2.0.0

エイリアス

_.eachRight

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [iteratee=_.identity] (Function): 反復処理ごとに呼び出される関数。

戻り値

(*): collection を返します。

例

_.forEachRight([1, 2], function(value) {
  console.log(value);
});
// => Logs `2` then `1`.

_.groupBy(collection, [iteratee=_.identity])

ソース npm パッケージ

collection の各要素を iteratee を介して実行した結果から生成されたキーで構成されるオブジェクトを作成します。グループ化された値の順序は、collection 内での出現順序によって決定されます。各キーの対応する値は、キーを生成した要素の配列です。イテレータは、1つの引数 (value) で呼び出されます。

Since

0.1.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [iteratee=_.identity] (Function): キーを変換するイテレータ。

戻り値

(Object): 構成された集計オブジェクトを返します。

例

_.groupBy([6.1, 4.2, 6.3], Math.floor);
// => { '4': [4.2], '6': [6.1, 6.3] }
 
// The `_.property` iteratee shorthand.
_.groupBy(['one', 'two', 'three'], 'length');
// => { '3': ['one', 'two'], '5': ['three'] }

_.includes(collection, value, [fromIndex=0])

ソース npm パッケージ

value が collection 内にあるかどうかを確認します。collection が文字列の場合、value の部分文字列であるかどうかがチェックされます。それ以外の場合は、SameValueZero が等価性比較に使用されます。fromIndex が負の場合、collection の末尾からのオフセットとして使用されます。

Since

0.1.0

引数

1. collection (Array|Object|string): 検査するコレクション。
2. value (*): 検索する値。
3. [fromIndex=0] (number): 検索を開始するインデックス。

戻り値

(boolean): value が見つかった場合は true を返し、それ以外の場合は false を返します。

例

_.includes([1, 2, 3], 1);
// => true
 
_.includes([1, 2, 3], 1, 2);
// => false
 
_.includes({ 'a': 1, 'b': 2 }, 1);
// => true
 
_.includes('abcd', 'bc');
// => true

_.invokeMap(collection, path, [args])

ソース npm パッケージ

collection 内の各要素の path にあるメソッドを呼び出し、呼び出された各メソッドの結果の配列を返します。追加の引数は、呼び出された各メソッドに提供されます。path が関数の場合、collection 内の各要素に対して、this がバインドされた状態で呼び出されます。

Since

4.0.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. path (Array|Function|string): 呼び出すメソッドのパス、または反復処理ごとに呼び出される関数。
3. [args] (...*): 各メソッドを呼び出すための引数。

戻り値

(Array): 結果の配列を返します。

例

_.invokeMap([[5, 1, 7], [3, 2, 1]], 'sort');
// => [[1, 5, 7], [1, 2, 3]]
 
_.invokeMap([123, 456], String.prototype.split, '');
// => [['1', '2', '3'], ['4', '5', '6']]

_.keyBy(collection, [iteratee=_.identity])

ソース npm パッケージ

collection の各要素を iteratee を介して実行した結果から生成されたキーで構成されるオブジェクトを作成します。各キーの対応する値は、キーを生成した最後の要素です。イテレータは、1つの引数 (value) で呼び出されます。

Since

4.0.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [iteratee=_.identity] (Function): キーを変換するイテレータ。

戻り値

(Object): 構成された集計オブジェクトを返します。

例

var array = [
  { 'dir': 'left', 'code': 97 },
  { 'dir': 'right', 'code': 100 }
];
 
_.keyBy(array, function(o) {
  return String.fromCharCode(o.code);
});
// => { 'a': { 'dir': 'left', 'code': 97 }, 'd': { 'dir': 'right', 'code': 100 } }
 
_.keyBy(array, 'dir');
// => { 'left': { 'dir': 'left', 'code': 97 }, 'right': { 'dir': 'right', 'code': 100 } }

_.map(collection, [iteratee=_.identity])

ソース npm パッケージ

collection 内の各要素を iteratee を介して実行して、値の配列を作成します。イテレータは3つの引数で呼び出されます。
(value, index|key, collection).

多くの lodash メソッドは、_.every、_.filter、_.map、_.mapValues、_.reject、_.some のようなメソッドのイテレータとして機能するように保護されています。

保護されたメソッドは
ary, chunk, curry, curryRight, drop, dropRight, every, fill, invert, parseInt, random, range, rangeRight, repeat, sampleSize, slice, some, sortBy, split, take, takeRight, template, trim, trimEnd, trimStart, および words

Since

0.1.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [iteratee=_.identity] (Function): 反復処理ごとに呼び出される関数。

戻り値

(Array): 新しいマップされた配列を返します。

例

function square(n) {
  return n * n;
}
 
_.map([4, 8], square);
// => [16, 64]
 
_.map({ 'a': 4, 'b': 8 }, square);
// => [16, 64] (iteration order is not guaranteed)
 
var users = [
  { 'user': 'barney' },
  { 'user': 'fred' }
];
 
// The `_.property` iteratee shorthand.
_.map(users, 'user');
// => ['barney', 'fred']

_.orderBy(collection, [iteratees=[_.identity]], [orders])

ソース npm パッケージ

このメソッドは_.sortByと似ていますが、ソートの基準となるイテレーターのソート順を指定できる点が異なります。orders が指定されていない場合、すべての値は昇順にソートされます。それ以外の場合は、対応する値の降順ソートには "desc"、昇順ソートには "asc" の順序を指定します。

Since

4.0.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [iteratees=[_.identity]] (Array[]|Function[]|Object[]|string[]): ソートの基準となるイテレーター。
3. [orders] (string[]): iteratees のソート順。

戻り値

(Array): ソートされた新しい配列を返します。

例

var users = [
  { 'user': 'fred',   'age': 48 },
  { 'user': 'barney', 'age': 34 },
  { 'user': 'fred',   'age': 40 },
  { 'user': 'barney', 'age': 36 }
];
 
// Sort by `user` in ascending order and by `age` in descending order.
_.orderBy(users, ['user', 'age'], ['asc', 'desc']);
// => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 40]]

_.partition(collection, [predicate=_.identity])

source npm package

要素を2つのグループに分割した配列を作成します。最初のグループには、predicate が truthy を返す要素が含まれ、2番目のグループには、predicate が falsey を返す要素が含まれます。predicate は1つの引数（(value)）で呼び出されます。

Since

3.0.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。

戻り値

(Array): グループ化された要素の配列を返します。

例

var users = [
  { 'user': 'barney',  'age': 36, 'active': false },
  { 'user': 'fred',    'age': 40, 'active': true },
  { 'user': 'pebbles', 'age': 1,  'active': false }
];
 
_.partition(users, function(o) { return o.active; });
// => objects for [['fred'], ['barney', 'pebbles']]
 
// The `_.matches` iteratee shorthand.
_.partition(users, { 'age': 1, 'active': false });
// => objects for [['pebbles'], ['barney', 'fred']]
 
// The `_.matchesProperty` iteratee shorthand.
_.partition(users, ['active', false]);
// => objects for [['barney', 'pebbles'], ['fred']]
 
// The `_.property` iteratee shorthand.
_.partition(users, 'active');
// => objects for [['fred'], ['barney', 'pebbles']]

_.reduce(collection, [iteratee=_.identity], [accumulator])

source npm package

collection の各要素を iteratee で実行し、その結果を累積した値を返します。各呼び出しは、前の呼び出しの戻り値を渡されます。accumulator が指定されていない場合は、collection の最初の要素が初期値として使用されます。イテレーターは4つの引数で呼び出されます。
(accumulator, value, index|key, collection).

lodashの多くのメソッドは、_.reduce、_.reduceRight、および_.transformのようなメソッドのイテレーターとして機能するようにガードされています。

保護されたメソッドは
assign, defaults, defaultsDeep, includes, merge, orderBy, および sortBy

Since

0.1.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [iteratee=_.identity] (Function): 反復処理ごとに呼び出される関数。
3. [accumulator] (*): 初期値。

戻り値

(*): 累積された値を返します。

例

_.reduce([1, 2], function(sum, n) {
  return sum + n;
}, 0);
// => 3
 
_.reduce({ 'a': 1, 'b': 2, 'c': 1 }, function(result, value, key) {
  (result[value] || (result[value] = [])).push(key);
  return result;
}, {});
// => { '1': ['a', 'c'], '2': ['b'] } (iteration order is not guaranteed)

_.reduceRight(collection, [iteratee=_.identity], [accumulator])

source npm package

このメソッドは_.reduceと似ていますが、collectionの要素を右から左に反復処理する点が異なります。

Since

0.1.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [iteratee=_.identity] (Function): 反復処理ごとに呼び出される関数。
3. [accumulator] (*): 初期値。

戻り値

(*): 累積された値を返します。

例

var array = [[0, 1], [2, 3], [4, 5]];
 
_.reduceRight(array, function(flattened, other) {
  return flattened.concat(other);
}, []);
// => [4, 5, 2, 3, 0, 1]

_.reject(collection, [predicate=_.identity])

source npm package

_.filterの逆です。このメソッドは、predicateがtruthyを返さないcollectionの要素を返します。

Since

0.1.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。

戻り値

(Array): 新しいフィルタリングされた配列を返します。

例

var users = [
  { 'user': 'barney', 'age': 36, 'active': false },
  { 'user': 'fred',   'age': 40, 'active': true }
];
 
_.reject(users, function(o) { return !o.active; });
// => objects for ['fred']
 
// The `_.matches` iteratee shorthand.
_.reject(users, { 'age': 40, 'active': true });
// => objects for ['barney']
 
// The `_.matchesProperty` iteratee shorthand.
_.reject(users, ['active', false]);
// => objects for ['fred']
 
// The `_.property` iteratee shorthand.
_.reject(users, 'active');
// => objects for ['barney']

_.sample(collection)

source npm package

collectionからランダムな要素を取得します。

Since

2.0.0

引数

1. collection (Array|Object): サンプリングするコレクション。

戻り値

(*): ランダムな要素を返します。

例

_.sample([1, 2, 3, 4]);
// => 2

_.sampleSize(collection, [n=1])

source npm package

collectionから、collectionのサイズまでの範囲で、一意のキーを持つn個のランダムな要素を取得します。

Since

4.0.0

引数

1. collection (Array|Object): サンプリングするコレクション。
2. [n=1] (number): サンプリングする要素の数。

戻り値

(Array): ランダムな要素を返します。

例

_.sampleSize([1, 2, 3], 2);
// => [3, 1]
 
_.sampleSize([1, 2, 3], 4);
// => [2, 3, 1]

_.shuffle(collection)

source npm package

Fisher-Yatesシャッフルのバージョンを使用して、シャッフルされた値の配列を作成します。

Since

0.1.0

引数

1. collection (Array|Object): シャッフルするコレクション。

戻り値

(Array): 新しいシャッフルされた配列を返します。

例

_.shuffle([1, 2, 3, 4]);
// => [4, 1, 3, 2]

_.size(collection)

source npm package

配列のような値の場合はその長さを返し、オブジェクトの場合は独自の列挙可能な文字列キー付きプロパティの数を返すことで、collectionのサイズを取得します。

Since

0.1.0

引数

1. collection (Array|Object|string): 検査するコレクション。

戻り値

(number): コレクションのサイズを返します。

例

_.size([1, 2, 3]);
// => 3
 
_.size({ 'a': 1, 'b': 2 });
// => 2
 
_.size('pebbles');
// => 7

_.some(collection, [predicate=_.identity])

source npm package

predicateがcollectionのいずれかの要素に対してtruthyを返すかどうかを確認します。predicateがtruthyを返すと、反復処理が停止します。predicateは3つの引数（(value, index|key, collection)）で呼び出されます。

Since

0.1.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [predicate=_.identity] (Function): イテレーションごとに呼び出される関数。

戻り値

(boolean): いずれかの要素がpredicateのチェックに合格した場合はtrueを、それ以外の場合はfalseを返します。

例

_.some([null, 0, 'yes', false], Boolean);
// => true
 
var users = [
  { 'user': 'barney', 'active': true },
  { 'user': 'fred',   'active': false }
];
 
// The `_.matches` iteratee shorthand.
_.some(users, { 'user': 'barney', 'active': false });
// => false
 
// The `_.matchesProperty` iteratee shorthand.
_.some(users, ['active', false]);
// => true
 
// The `_.property` iteratee shorthand.
_.some(users, 'active');
// => true

_.sortBy(collection, [iteratees=[_.identity]])

source npm package

コレクションの各要素を各イテレーターで実行した結果によって昇順にソートされた要素の配列を作成します。このメソッドは安定ソートを実行します。つまり、等しい要素の元のソート順序を保持します。イテレーターは1つの引数（(value)）で呼び出されます。

Since

0.1.0

引数

1. collection (Array|Object): 反復処理するコレクション。
2. [iteratees=[_.identity]] (...(Function|Function[])): ソートの基準となるイテレーター。

戻り値

(Array): ソートされた新しい配列を返します。

例

var users = [
  { 'user': 'fred',   'age': 48 },
  { 'user': 'barney', 'age': 36 },
  { 'user': 'fred',   'age': 40 },
  { 'user': 'barney', 'age': 34 }
];
 
_.sortBy(users, [function(o) { return o.user; }]);
// => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 40]]
 
_.sortBy(users, ['user', 'age']);
// => objects for [['barney', 34], ['barney', 36], ['fred', 40], ['fred', 48]]

_.now()

source npm package

Unixエポック（1970年1月1日00:00:00 UTC）から経過したミリ秒数のタイムスタンプを取得します。

Since

2.4.0

戻り値

(number): タイムスタンプを返します。

例

_.defer(function(stamp) {
  console.log(_.now() - stamp);
}, _.now());
// => Logs the number of milliseconds it took for the deferred invocation.

_.after(n, func)

source npm package

_.beforeの反対です。このメソッドは、funcがn回以上呼び出されたときに一度呼び出す関数を作成します。

Since

0.1.0

引数

1. n (number): funcが呼び出される前の呼び出し回数。
2. func (Function): 制約する関数。

戻り値

(Function): 新しい制約された関数を返します。

例

var saves = ['profile', 'settings'];
 
var done = _.after(saves.length, function() {
  console.log('done saving!');
});
 
_.forEach(saves, function(type) {
  asyncSave({ 'type': type, 'complete': done });
});
// => Logs 'done saving!' after the two async saves have completed.

_.ary(func, [n=func.length])

source npm package

funcを最大n個の引数で呼び出し、それ以降の引数を無視する関数を作成します。

Since

3.0.0

引数

1. func (Function): 引数を制限する関数。
2. [n=func.length] (number): アリティの上限。

戻り値

(Function): 新しい上限付き関数を返します。

例

_.map(['6', '8', '10'], _.ary(parseInt, 1));
// => [6, 8, 10]

_.before(n, func)

source npm package

作成された関数のthisバインディングと引数を使用して、funcをn回未満呼び出す関数を作成します。作成された関数への後続の呼び出しは、最後のfunc呼び出しの結果を返します。

Since

3.0.0

引数

1. n (number): funcが呼び出されなくなる呼び出し回数。
2. func (Function): 制約する関数。

戻り値

(Function): 新しい制約された関数を返します。

例

jQuery(element).on('click', _.before(5, addContactToList));
// => Allows adding up to 4 contacts to the list.

_.bind(func, thisArg, [partials])

source npm package

funcをthisArgのthisバインディングと、受け取る引数の先頭に付加されたpartialsで呼び出す関数を作成します。

_.bind.placeholder値（モノリシックビルドではデフォルトで_）は、部分的に適用される引数のプレースホルダーとして使用できます。

注意: ネイティブのFunction#bindとは異なり、このメソッドはバインドされた関数の "length" プロパティを設定しません。

Since

0.1.0

引数

1. func (Function): バインドする関数。
2. thisArg (*): funcのthisバインディング。
3. [partials] (...*): 部分的に適用する引数。

戻り値

(Function): 新しいバインドされた関数を返します。

例

function greet(greeting, punctuation) {
  return greeting + ' ' + this.user + punctuation;
}
 
var object = { 'user': 'fred' };
 
var bound = _.bind(greet, object, 'hi');
bound('!');
// => 'hi fred!'
 
// Bound with placeholders.
var bound = _.bind(greet, object, _, '!');
bound('hi');
// => 'hi fred!'

_.bindKey(object, key, [partials])

source npm package

object[key]のメソッドを、受け取る引数の先頭に付加されたpartialsで呼び出す関数を作成します。

このメソッドは、バインドされた関数が再定義されたり、まだ存在しない可能性のあるメソッドを参照できるようにすることで、_.bindと異なります。詳細については、Peter Michauxの記事を参照してください。

_.bindKey.placeholder値（モノリシックビルドではデフォルトで_）は、部分的に適用される引数のプレースホルダーとして使用できます。

Since

0.10.0

引数

1. object (Object): メソッドを呼び出すオブジェクト。
2. key (string): メソッドのキー。
3. [partials] (...*): 部分的に適用する引数。

戻り値

(Function): 新しいバインドされた関数を返します。

例

var object = {
  'user': 'fred',
  'greet': function(greeting, punctuation) {
    return greeting + ' ' + this.user + punctuation;
  }
};
 
var bound = _.bindKey(object, 'greet', 'hi');
bound('!');
// => 'hi fred!'
 
object.greet = function(greeting, punctuation) {
  return greeting + 'ya ' + this.user + punctuation;
};
 
bound('!');
// => 'hiya fred!'
 
// Bound with placeholders.
var bound = _.bindKey(object, 'greet', _, '!');
bound('hi');
// => 'hiya fred!'

_.curry(func, [arity=func.length])

source npm package

funcの引数を受け入れ、少なくともarity個の引数が提供された場合はfuncを呼び出してその結果を返すか、残りのfuncの引数を受け入れる関数を返す関数を作成します。func.lengthが十分でない場合は、funcのアリティを指定できます。

_.curry.placeholder値（モノリシックビルドではデフォルトで_）は、提供された引数のプレースホルダーとして使用できます。

注意: このメソッドは、カリー化された関数の "length" プロパティを設定しません。

Since

2.0.0

引数

1. func (Function): カリー化する関数。
2. [arity=func.length] (number): funcのアリティ。

戻り値

(Function): 新しいカリー化された関数を返します。

例

var abc = function(a, b, c) {
  return [a, b, c];
};
 
var curried = _.curry(abc);
 
curried(1)(2)(3);
// => [1, 2, 3]
 
curried(1, 2)(3);
// => [1, 2, 3]
 
curried(1, 2, 3);
// => [1, 2, 3]
 
// Curried with placeholders.
curried(1)(_, 3)(2);
// => [1, 3, 2]

_.curryRight(func, [arity=func.length])

source npm package

このメソッドは_.curryと似ていますが、引数が_.partialの代わりに_.partialRightのようにfuncに適用される点が異なります。

_.curryRight.placeholder値（モノリシックビルドではデフォルトで_）は、提供された引数のプレースホルダーとして使用できます。

注意: このメソッドは、カリー化された関数の "length" プロパティを設定しません。

Since

3.0.0

引数

1. func (Function): カリー化する関数。
2. [arity=func.length] (number): funcのアリティ。

戻り値

(Function): 新しいカリー化された関数を返します。

例

var abc = function(a, b, c) {
  return [a, b, c];
};
 
var curried = _.curryRight(abc);
 
curried(3)(2)(1);
// => [1, 2, 3]
 
curried(2, 3)(1);
// => [1, 2, 3]
 
curried(1, 2, 3);
// => [1, 2, 3]
 
// Curried with placeholders.
curried(3)(1, _)(2);
// => [1, 2, 3]

_.debounce(func, [wait=0], [options={}])

source npm package

デバウンスされた関数を作成します。この関数は、デバウンスされた関数が最後に呼び出されてからwaitミリ秒が経過するまで、funcの呼び出しを遅延させます。デバウンスされた関数には、遅延されたfuncの呼び出しをキャンセルするcancelメソッドと、それらをすぐに呼び出すflushメソッドが付属しています。optionsを提供して、funcをwaitタイムアウトの先頭および/または末尾で呼び出す必要があるかどうかを示します。funcは、デバウンスされた関数に提供された最後の引数で呼び出されます。デバウンスされた関数への後続の呼び出しは、最後のfunc呼び出しの結果を返します。

注意: leadingおよびtrailingオプションがtrueの場合、funcは、デバウンスされた関数がwaitタイムアウト中に複数回呼び出された場合にのみ、タイムアウトの末尾で呼び出されます。

waitが0で、leadingがfalseの場合、funcの呼び出しは、タイムアウトが0のsetTimeoutと同様に、次のティックまで延期されます。

_.debounceと_.throttleの違いの詳細については、David Corbachoの記事を参照してください。

Since

0.1.0

引数

1. func (Function): デバウンスする関数。
2. [wait=0] (number): 遅延するミリ秒数。
3. [options={}] (Object): オプションオブジェクト。
4. [options.leading=false] (boolean): タイムアウトの先頭で呼び出すことを指定します。
5. [options.maxWait] (number): funcが呼び出されるまでに遅延できる最大時間。
6. [options.trailing=true] (boolean): タイムアウトの末尾エッジで呼び出すかどうかを指定します。

戻り値

(Function): 新しいデバウンスされた関数を返します。

例

// Avoid costly calculations while the window size is in flux.
jQuery(window).on('resize', _.debounce(calculateLayout, 150));
 
// Invoke `sendMail` when clicked, debouncing subsequent calls.
jQuery(element).on('click', _.debounce(sendMail, 300, {
  'leading': true,
  'trailing': false
}));
 
// Ensure `batchLog` is invoked once after 1 second of debounced calls.
var debounced = _.debounce(batchLog, 250, { 'maxWait': 1000 });
var source = new EventSource('/stream');
jQuery(source).on('message', debounced);
 
// Cancel the trailing debounced invocation.
jQuery(window).on('popstate', debounced.cancel);

_.defer(func, [args])

ソース npm パッケージ

現在のコールスタックがクリアされるまで、func の呼び出しを遅延させます。追加の引数は、func が呼び出されるときに提供されます。

Since

0.1.0

引数

1. func (Function): 遅延させる関数。
2. [args] (...*): func を呼び出す際の引数。

戻り値

(number): タイマー ID を返します。

例

_.defer(function(text) {
  console.log(text);
}, 'deferred');
// => Logs 'deferred' after one millisecond.

_.delay(func, wait, [args])

ソース npm パッケージ

wait ミリ秒後に func を呼び出します。追加の引数は、func が呼び出されるときに提供されます。

Since

0.1.0

引数

1. func (Function): 遅延させる関数。
2. wait (number): 呼び出しを遅延させるミリ秒数。
3. [args] (...*): func を呼び出す際の引数。

戻り値

(number): タイマー ID を返します。

例

_.delay(function(text) {
  console.log(text);
}, 1000, 'later');
// => Logs 'later' after one second.

_.flip(func)

ソース npm パッケージ

引数が反転された状態で func を呼び出す関数を作成します。

Since

4.0.0

引数

1. func (Function): 引数を反転する関数。

戻り値

(Function): 新しい反転された関数を返します。

例

var flipped = _.flip(function() {
  return _.toArray(arguments);
});
 
flipped('a', 'b', 'c', 'd');
// => ['d', 'c', 'b', 'a']

_.memoize(func, [resolver])

ソース npm パッケージ

func の結果をメモ化する関数を作成します。resolver が指定されている場合、メモ化された関数に提供される引数に基づいて結果を格納するためのキャッシュキーを決定します。デフォルトでは、メモ化された関数に提供される最初の引数がマップキャッシュキーとして使用されます。func は、メモ化された関数の this バインディングで呼び出されます。

注: キャッシュは、メモ化された関数の cache プロパティとして公開されます。その作成は、_.memoize.Cache コンストラクタを、clear、delete、get、has、および set の Map メソッドインターフェースを実装するインスタンスを持つコンストラクタで置き換えることでカスタマイズできます。

Since

0.1.0

引数

1. func (Function): 出力をメモ化する関数。
2. [resolver] (Function): キャッシュキーを解決する関数。

戻り値

(Function): 新しいメモ化された関数を返します。

例

var object = { 'a': 1, 'b': 2 };
var other = { 'c': 3, 'd': 4 };
 
var values = _.memoize(_.values);
values(object);
// => [1, 2]
 
values(other);
// => [3, 4]
 
object.a = 2;
values(object);
// => [1, 2]
 
// Modify the result cache.
values.cache.set(object, ['a', 'b']);
values(object);
// => ['a', 'b']
 
// Replace `_.memoize.Cache`.
_.memoize.Cache = WeakMap;

_.negate(predicate)

ソース npm パッケージ

述語 func の結果を否定する関数を作成します。func 述語は、作成された関数の this バインディングと引数で呼び出されます。

Since

3.0.0

引数

1. predicate (Function): 否定する述語。

戻り値

(Function): 新しい否定された関数を返します。

例

function isEven(n) {
  return n % 2 == 0;
}
 
_.filter([1, 2, 3, 4, 5, 6], _.negate(isEven));
// => [1, 3, 5]

_.once(func)

ソース npm パッケージ

func を一度だけ呼び出すように制限された関数を作成します。関数への繰り返し呼び出しは、最初の呼び出しの値を返します。func は、作成された関数の this バインディングと引数で呼び出されます。

Since

0.1.0

引数

1. func (Function): 制約する関数。

戻り値

(Function): 新しい制約された関数を返します。

例

var initialize = _.once(createApplication);
initialize();
initialize();
// => `createApplication` is invoked once

_.overArgs(func, [transforms=[_.identity]])

ソース npm パッケージ

引数が変換された状態で func を呼び出す関数を作成します。

Since

4.0.0

引数

1. func (Function): ラップする関数。
2. [transforms=[_.identity]] (...(Function|Function[])): 引数の変換。

戻り値

(Function): 新しい関数を返します。

例

function doubled(n) {
  return n * 2;
}
 
function square(n) {
  return n * n;
}
 
var func = _.overArgs(function(x, y) {
  return [x, y];
}, [square, doubled]);
 
func(9, 3);
// => [81, 6]
 
func(10, 5);
// => [100, 10]

_.partial(func, [partials])

ソース npm パッケージ

受け取る引数の前に partials が付加された状態で func を呼び出す関数を作成します。このメソッドは、this バインディングを変更しないという点を除いて、_.bind に似ています。

モノリシックビルドではデフォルトで _ である _.partial.placeholder 値は、部分的に適用された引数のプレースホルダーとして使用できます。

注: このメソッドは、部分的に適用された関数の「length」プロパティを設定しません。

Since

0.2.0

引数

1. func (Function): 部分的に引数を適用する関数。
2. [partials] (...*): 部分的に適用する引数。

戻り値

(Function): 新しい部分的に適用された関数を返します。

例

function greet(greeting, name) {
  return greeting + ' ' + name;
}
 
var sayHelloTo = _.partial(greet, 'hello');
sayHelloTo('fred');
// => 'hello fred'
 
// Partially applied with placeholders.
var greetFred = _.partial(greet, _, 'fred');
greetFred('hi');
// => 'hi fred'

_.partialRight(func, [partials])

ソース npm パッケージ

このメソッドは、部分的に適用された引数が受け取る引数に追加されるという点を除いて、_.partial に似ています。

モノリシックビルドではデフォルトで _ である _.partialRight.placeholder 値は、部分的に適用された引数のプレースホルダーとして使用できます。

注: このメソッドは、部分的に適用された関数の「length」プロパティを設定しません。

Since

1.0.0

引数

1. func (Function): 部分的に引数を適用する関数。
2. [partials] (...*): 部分的に適用する引数。

戻り値

(Function): 新しい部分的に適用された関数を返します。

例

function greet(greeting, name) {
  return greeting + ' ' + name;
}
 
var greetFred = _.partialRight(greet, 'fred');
greetFred('hi');
// => 'hi fred'
 
// Partially applied with placeholders.
var sayHelloTo = _.partialRight(greet, 'hello', _);
sayHelloTo('fred');
// => 'hello fred'

_.rearg(func, indexes)

ソース npm パッケージ

指定された indexes に従って引数を配置した状態で func を呼び出す関数を作成します。最初のインデックスの値が最初の引数として提供され、2 番目のインデックスの値が 2 番目の引数として提供されるというようになります。

Since

3.0.0

引数

1. func (Function): 引数を再配置する関数。
2. indexes (...(number|number[])): 配置された引数インデックス。

戻り値

(Function): 新しい関数を返します。

例

var rearged = _.rearg(function(a, b, c) {
  return [a, b, c];
}, [2, 0, 1]);
 
rearged('b', 'c', 'a')
// => ['a', 'b', 'c']

_.rest(func, [start=func.length-1])

ソース npm パッケージ

作成された関数の this バインディングと、start 以降の引数を配列として提供した状態で func を呼び出す関数を作成します。

注: このメソッドは、残余引数に基づいています。

Since

4.0.0

引数

1. func (Function): 残余引数を適用する関数。
2. [start=func.length-1] (number): 残余引数の開始位置。

戻り値

(Function): 新しい関数を返します。

例

var say = _.rest(function(what, names) {
  return what + ' ' + _.initial(names).join(', ') +
    (_.size(names) > 1 ? ', & ' : '') + _.last(names);
});
 
say('hello', 'fred', 'barney', 'pebbles');
// => 'hello fred, barney, & pebbles'

_.spread(func, [start=0])

ソース npm パッケージ

作成された関数の this バインディングと、Function#apply と同様に引数の配列を渡した状態で func を呼び出す関数を作成します。

注: このメソッドは、スプレッド演算子に基づいています。

Since

3.2.0

引数

1. func (Function): 引数を展開する関数。
2. [start=0] (number): スプレッドの開始位置。

戻り値

(Function): 新しい関数を返します。

例

var say = _.spread(function(who, what) {
  return who + ' says ' + what;
});
 
say(['fred', 'hello']);
// => 'fred says hello'
 
var numbers = Promise.all([
  Promise.resolve(40),
  Promise.resolve(36)
]);
 
numbers.then(_.spread(function(x, y) {
  return x + y;
}));
// => a Promise of 76

_.throttle(func, [wait=0], [options={}])

ソース npm パッケージ

func を最大で wait ミリ秒ごとに一度だけ呼び出すスロットルされた関数を作成します。スロットルされた関数には、遅延した func の呼び出しをキャンセルする cancel メソッドと、それらをすぐに呼び出す flush メソッドが付属しています。wait タイムアウトの先頭エッジと末尾エッジのどちらで func を呼び出すべきかを示すには、options を指定します。func は、スロットルされた関数に提供された最後の引数で呼び出されます。スロットルされた関数への後続の呼び出しは、最後の func の呼び出しの結果を返します。

注: leading オプションと trailing オプションが true の場合、func は、スロットルされた関数が wait タイムアウト中に複数回呼び出された場合にのみ、タイムアウトの末尾エッジで呼び出されます。

waitが0で、leadingがfalseの場合、funcの呼び出しは、タイムアウトが0のsetTimeoutと同様に、次のティックまで延期されます。

David Corbacho の記事で、_.throttle と _.debounce の違いの詳細を参照してください。

Since

0.1.0

引数

1. func (Function): スロットルする関数。
2. [wait=0] (number): 呼び出しをスロットルするミリ秒数。
3. [options={}] (Object): オプションオブジェクト。
4. [options.leading=true] (boolean): タイムアウトの先頭エッジで呼び出すかどうかを指定します。
5. [options.trailing=true] (boolean): タイムアウトの末尾エッジで呼び出すかどうかを指定します。

戻り値

(Function): 新しいスロットルされた関数を返します。

例

// Avoid excessively updating the position while scrolling.
jQuery(window).on('scroll', _.throttle(updatePosition, 100));
 
// Invoke `renewToken` when the click event is fired, but not more than once every 5 minutes.
var throttled = _.throttle(renewToken, 300000, { 'trailing': false });
jQuery(element).on('click', throttled);
 
// Cancel the trailing throttled invocation.
jQuery(window).on('popstate', throttled.cancel);