Iterator.prototype.take()

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

Синтаксис

take(limit)

Параметры

limit

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

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

Новый объект-помощник итератора. Возвращенный помощник итератора выдает элементы исходного итератора по одному, а затем завершается (метод next() выдает { value: undefined, done: true }), как только будет выдано limit элементов, или когда исходный итератор исчерпается, в зависимости от того, что произойдет раньше.

Исключения

RangeError

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

Примеры

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

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

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

const seq = fibonacci().take(3);
console.log(seq.next().value); // 1
console.log(seq.next().value); // 1
console.log(seq.next().value); // 2
console.log(seq.next().value); // undefined

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

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

for (const n of fibonacci().take(5)) {
  console.log(n);
}

// Logs:
// 1
// 1
// 2
// 3
// 5

Поскольку fibonacci() является бесконечным итератором, использование цикла for для его итерации без какой-либо логики для раннего выхода (например, оператора break) приведет к бесконечному циклу.

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

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

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

Нижняя и верхняя границы счетчика take

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

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

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

for (const n of new Set([1, 2, 3]).values().take(Infinity)) {
  console.log(n);
}

// Logs:
// 1
// 2
// 3

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

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

Смотрите также

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