Iterator.prototype.drop()

Метод drop() экземпляров Iterator возвращает новый объект-помощник итератора, который пропускает заданное количество элементов в начале данного итератора.

Синтаксис

drop(limit)

Параметры

limit

Количество элементов, которые нужно отбросить в начале итерации.

Возвращаемое значение

Новый объект-помощник итератора. При первом вызове метода next() возвращенного помощника итератора текущий итератор немедленно продвигается на limit элементов, а затем выдается следующий элемент (limit+1-й элемент). Затем помощник итератора выдает оставшиеся элементы один за другим. Если текущий итератор имеет меньше, чем limit элементов, новый помощник итератора будет немедленно завершен при первом вызове next().

Исключения

RangeError

Генерируется, если limit становится NaN или отрицательным при преобразовании в целое число.

Примеры

Использование drop()

Следующий пример создает итератор, который выдает члены последовательности Фибоначчи, начиная с 3-го члена, отбрасывая первые два члена:

function* fibonacci() {
  let current = 1;
  let next = 1;
  while (true) {
    yield current;
    [current, next] = [next, current + next];
  }
}

const seq = fibonacci().drop(2);
console.log(seq.next().value); // 2
console.log(seq.next().value); // 3

Это эквивалентно:

const seq = fibonacci();
seq.next();
seq.next();

Использование drop() с циклом for...of

drop() наиболее удобен, когда вы не создаете итератор вручную. Поскольку итераторы также являются итерируемыми объектами, вы можете перебирать возвращенного помощника с помощью цикла for...of:

for (const n of fibonacci().drop(2)) {
  console.log(n);
  if (n > 30) {
    break;
  }
}

// Logs:
// 2
// 3
// 5
// 8
// 13
// 21
// 34

Комбинирование drop() и take()

Вы можете скомбинировать drop() с Iterator.prototype.take(), чтобы получить срез итератора:

for (const n of fibonacci().drop(2).take(5)) {
  // Drops the first two elements, then takes the next five
  console.log(n);
}
// Logs:
// 2
// 3
// 5
// 8
// 13

for (const n of fibonacci().take(5).drop(2)) {
  // Takes the first five elements, then drops the first two
  console.log(n);
}
// Logs:
// 2
// 3
// 5

Нижняя и верхняя границы счетчика отбрасываемых элементов

Когда limit отрицательно или NaN, генерируется RangeError:

fibonacci().drop(-1); // RangeError: -1 must be positive
fibonacci().drop(undefined); // RangeError: undefined must be positive

Когда limit больше, чем общее количество элементов, которое может произвести итератор (например, Infinity), возвращенный помощник итератора немедленно отбросит все элементы, а затем будет завершен при первом вызове next(). Если текущий итератор бесконечен, возвращенный помощник итератора никогда не завершится.

fibonacci().drop(Infinity).next(); // Never ends
new Set([1, 2, 3]).values().drop(Infinity).next(); // { value: undefined, done: true }
new Set([1, 2, 3]).values().drop(4).next(); // { value: undefined, done: true }

Спецификации

Совместимость с браузерами

См. также

• Полифил Iterator.prototype.drop в core-js
• Полифил es-shims для Iterator.prototype.drop
• Iterator
• Iterator.prototype.take()