Lodash документация на русском

“Коллекции”

“Коллекции”

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

source, npm package.

Создает объект, состоящий из ключей, сгенерированных из результатов работы каждого элемента коллекции через iteratee.

Соответствующее значение каждого ключа это количество раз, когда ключ был возвращен iteratee.

iteratee вызывается с одним аргументом: (value).

Версия: 0.5.0

Аргументы

collection (Array|Object): Коллекции для перебора.

[iteratee=_.identity] (Function): iteratee для преобразования ключей

Возвращает

(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])

source, npm package.

Проверяет, возвращает ли predicate truthy для всех элементов коллекции.

Итерация останавливается, как только predicate возвращает false.

predicate вызывается с тремя аргументами: (value, index|key, collection).

Заметка: Этот метод возвращает true для empty collections потому как everything is true для элементов пустых коллекций.

Версия: 0.1.0

Аргументы

collection (Array|Object): Коллекция для перебора. [predicate=_.identity] (Function): Функция вызывается на каждой итерации.

Возвращает

(boolean): Возвращает true, если все элементы проходят проверку predicate, иначе 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])

source, npm package.

Перебирает элементы коллекции, возвращает массив всех элементов если predicate возвращает truthy.

predicate вызывается с тремя аргументами: (value, index|key, collection).

Заметка: В отличие от _.remove, этот метод возвращает новый массив.

Версия: 0.1.0

Аргументы

collection (Array|Object): Коллекция для перебора. [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])

source, npm package.

Итерации по элементам коллекции, возвращает первый элемента если predicate возвращают truthy.

predicate вызывается с тремя аргументами: (value, index|key, collection).

Версия: 0.1.0

Аргументы

collection (Array|Object): Коллекция для проверки. [predicate=_.identity] (Function): Функция вызывается на каждой итерации. [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])

source, npm package.

Этот метод подобен _.find за исключением того, что он перебирает элементы коллекции справа налево.

Версия: 2.0.0

Аргументы

collection (Array|Object): Коллекция для проверки. [predicate=_.identity] (Function): Функция вызывается на каждой итерации. [fromIndex=collection.length-1] (number): Индекс для поиска.

Возвращает

(*): Возвращает совпадающий элемент либо undefined.

Пример

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

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

source, npm package.

Создает сглаженный массив значений, запустив каждый элемент коллекции через повторение и сглаживая сопоставленные результаты.

predicate вызывается с тремя аргументами: (value, index|key, collection).

Версия: 4.0.0

Аргументы

collection (Array|Object): Коллекция для перебора. [iteratee=_.identity] (Function): Функция вызывается на каждой итерации.

Возвращает

(Array): Возвращает новый сглаженый массив.

Пример

function duplicate(n) {
  return [n, n];
}

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

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

source, npm package.

Этот метод подобен _.flatMap За исключением того, что он рекурсивно сглаживает отображенные результаты.

Версия: 4.7.0

Аргументы

collection (Array|Object): Коллекции для перебора. [iteratee=_.identity] (Function): Функция вызывается на каждой итерации.

Возвращает

(Array): Возвращает новый сглаженый массив.

Пример

function duplicate(n) {
  return [[[n, n]]];
}

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

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

source, npm package.

Этот метод подобен _.flatMap За исключением того, что он рекурсивно выравнивает отображаемые результаты до заданной глубины.

Версия: 4.7.0

Аргументы

collection (Array|Object): Коллекции для перебора. [iteratee=_.identity] (Function): Функция вызывается на каждой итерации. [depth=1] (number): Максимальная глубина рекурсии.

Возвращает

(Array): Возвращает новый сглаженый массив.

Пример

function duplicate(n) {
  return [[[n, n]]];
}

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

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

source, npm package.

Перебирает элементы коллекции и вызывает итерацию для каждого элемента.

Итерация вызывается с тремя аргументами: (value, index|key, collection).

Функции итерации могут прервать итерацию раньше, явно возвращая false.

Заметка: Как и в других методах «Collections», объекты со свойством «length» повторяются как массивы. Чтобы избежать такого поведения, используйте .forIn](https://lodash.com/docs/4.17.4#forIn) или [.forOwn для итерации объектов.

Версия: 0.1.0

Псевдонимы:

_.each

Аргументы

collection (Array|Object): Коллекции для перебора. [iteratee=_.identity] (Function): Функция вызывается на каждой итерации.

Возвращает

(*): Возвращает коллекцию.

Пример

_.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])

source, npm package.

Этот метод подобен _.forEach за исключением того, что он перебирает элементы коллекции справа налево.

Версия: 2.0.0

Псевдонимы:

_.eachRight

Аргументы

collection (Array|Object): Коллекции для перебора. [iteratee=_.identity] (Function): Функция вызывается на каждой итерации.

Возвращает

(*): Возвращает коллекцию.

Пример

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

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

source, npm package.

Создает объект, состоящий из ключей, сгенерированных из результатов запуска каждого элемента коллекции через iteratee.

Порядок сгруппированных значений определяется порядком их расположения в коллекции.

Соответствующее значение каждого ключа представляет собой массив элементов, ответственных за генерацию ключа.

iteratee вызывается с одним аргументом: (value)

Версия: 0.1.0

Аргументы

collection (Array|Object): Коллекции для перебора. [iteratee=_.identity] (Function): iteratee для преобразования ключей.

Возвращает

(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])

source, npm package.

Проверяет, находится ли значение в коллекции. Если коллекция является строкой, она проверяется на подстроку значения, в противном случае SameValueZero используется для сравнения равенств. Если fromIndex имеет отрицательное значение, оно используется как смещение от конца коллекции.

Версия: 0.1.0

Аргументы

collection (Array|Object|string): Коллекции для проверки. value (*): Значение для поиска. [fromIndex=0] (number): Индекс для поиска.

Возвращает

(boolean): Возвращает 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])

source, npm package.

Вызывает метод на пути каждого элемента в коллекции, возвращает массив результатов каждого вызываемого метода.

Любые дополнительные аргументы предоставляются каждому вызываемому методу.

Если path является функцией, он вызывается для каждого связанного с ним элемента в коллекции.

Версия: 4.0.0

Аргументы

collection (Array|Object): Коллекции для перебора. path (Array|Function|string): path метода или функции вызывается на каждой итерации. [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])

source, npm package.

Соответствующее значение каждого ключа является последним элементом, ответственным за генерацию ключа.

iteratee вызывается с одним аргументом: (value).

Версия: 4.0.0

Аргументы

collection (Array|Object): Коллекции для перебора. [iteratee=_.identity] (Function): iteratee для преобразования ключей.

Возвращает

(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])

source, npm package.

Создает массив значений, запустив каждый элемент коллекции через iteratee.

iteratee вызывается с тремя аргументами: (value, index|key, collection).

Многие методы lodash охраняются для работы в качестве итераций для таких методов, как .every](https://lodash.com/docs/4.17.4#every), [.filter, .map](https://lodash.com/docs/4.17.4#map), [.mapValues, .reject](https://lodash.com/docs/4.17.4#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, and words

Версия: 0.1.0

Аргументы

collection (Array|Object): Коллекции для перебора. [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])

source, npm package.

Этот метод подобен _.sortBy за исключением того, что он позволяет указывать порядки сортировки для итераций.

Если заказы не указаны, все значения сортируются в порядке возрастания.

В противном случае укажите порядок «desc» для нисходящего или «asc» для восходящего порядка сортировки соответствующих значений.

Версия: 4.0.0

Аргументы

collection (Array|Object): Коллекции для перебора. [iteratees=[_.identity]] (Array[]|Function[]|Object[]|string[]): iteratees для сортировки. [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.

Создает массив элементов, разбитых на две группы, первый из которых содержит элементы, для которых предикат возвращает truey, второй из которых содержит элементы, для которых предикат возвращает false.

predicate вызывается с одним аргументом: (value).

Версия: 3.0.0

Аргументы

collection (Array|Object): Коллекции для перебора. [predicate=_.identity] (Function): Функция вызывается на каждой iteration.

Возвращает

(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.

Уменьшает коллекции значению, накопленные результат выполнения каждого элемента в коллекции через iteratee, где каждый последующий вызов поступает возвращаемое значение предыдущего.

Если накопитель не задан, в качестве начального значения используется первый элемент коллекции.

iteratee вызывается с четырьмя аргументами: (accumulator, value, index|key, collection).

Многие методы lodash охраняются для работы в качестве итераций для таких методов, как .reduce](https://lodash.com/docs/4.17.4#reduce), [.reduceRight, и _.transform.

The guarded methods are: assign, defaults, defaultsDeep, includes, merge, orderBy, and sortBy

Версия: 0.1.0

Аргументы

collection (Array|Object): Коллекции для перебора. [iteratee=_.identity] (Function): Функция вызывается на каждой итерации. [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 за исключением того, что он перебирает элементы коллекции справа налево.

Версия: 0.1.0

Аргументы

Возвращает

(*): Returns the accumulated value.

Пример

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 не возвращает true.

Версия: 0.1.0

Аргументы

collection (Array|Object): Коллекции для перебора. [predicate=_.identity] (Function): Функция вызывается на каждой iteration.

Возвращает

(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.

Возвращает случайный элемент из коллекции.

Версия: 2.0.0

Аргументы

collection (Array|Object): Коллекции для образца.

Возвращает

(*): Возвращает случайный элемент.

Пример

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

.sampleSize(collection, [n=1])

source, npm package.

Получает n случайных элементов в уникальных ключах из коллекции до размера коллекции.

Версия: 4.0.0

Аргументы

collection (Array|Object): Коллекции для образца. [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 shuffle.

Версия: 0.1.0

Аргументы

collection (Array|Object): Коллекция для перетасовки.

Возвращает

(Array): Возвращает новый перемешанный массив.

Пример

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

.size(collection)

source, npm package.

Получает размер коллекции, возвращая ее длину для значений типа массива или число собственных свойств перечисляемой строки для объектов.

Версия: 0.1.0

Аргументы

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.

Проверяет, возвращает ли предикат truthy для любого элемента коллекции. Итерация останавливается, как только предикат возвращает true.

predicate вызывается с тремя аргументами: (value, index|key, collection).

Версия: 0.1.0

Аргументы

collection (Array|Object): Коллекции для перебора. [predicate=_.identity] (Function): Функция вызывается на каждой итерации.

Возвращает

(boolean): Возвращает true, если любой элемент проходит проверку predicate, иначе 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.

Создает массив элементов, отсортированный в порядке возрастания по результатам выполнения каждого элемента коллекции через каждую итерацию.

Этот метод выполняет устойчивую сортировку, то есть сохраняет исходный порядок сортировки равных элементов.

iteratees вызывается с одним аргументом: (value).

Версия: 0.1.0

Аргументы

collection (Array|Object): Коллекции для перебора. [iteratees=[_.identity]] (...(Function|Function[])): iteratees для сортировки.

Возвращает

(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]]

Lodash документация на русском (Коллекции)

“Коллекции”

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

Пример

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

Пример

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

Пример

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

Пример

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

Пример

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

Пример

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

Пример

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

Пример

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

Пример

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

Пример

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

Пример

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

Пример

.invokeMap(collection, path, [args])

Пример

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

Пример

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

Пример

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

Пример

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

Пример

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

Пример

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

Пример

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

Пример

.sample(collection)

Пример

.sampleSize(collection, [n=1])

Пример

.shuffle(collection)

Пример

.size(collection)

Пример

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

Пример

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

Пример