Iterator.prototype.take()

limit

Die Anzahl der Elemente, die vom Beginn der Iteration an genommen werden sollen.

Ein neues Iterator-Hilfsobjekt. Der zurückgegebene Iterator-Helfer liefert die Elemente im ursprünglichen Iterator nacheinander und schließt dann ab (die next()-Methode erzeugt { value: undefined, done: true }), sobald limit Elemente geliefert wurden oder wenn der ursprüngliche Iterator erschöpft ist, je nachdem, was zuerst eintritt.

RangeError

Wird ausgelöst, wenn limit zu NaN oder negativ wird, wenn es in eine Ganzzahl umgewandelt wird.

Das folgende Beispiel erzeugt einen Iterator, der Begriffe in der Fibonacci-Folge liefert, und gibt dann die ersten drei Begriffe aus:

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() ist am praktischsten, wenn Sie den Iterator nicht manuell rollen. Da Iteratoren auch iterierbar sind, können Sie den zurückgegebenen Helfer mit einer for...of-Schleife durchlaufen:

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

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

Weil fibonacci() ein unendlicher Iterator ist, würde die Verwendung einer for-Schleife zum Durchlaufen ohne jegliche Logik zum vorzeitigen Beenden (wie eine break-Anweisung) zu einer Endlosschleife führen.

Sie können take() mit Iterator.prototype.drop() kombinieren, um ein Stück eines Iterators zu erhalten:

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

Wenn der limit negativ oder NaN ist, wird ein RangeError ausgelöst:

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

Wenn der limit größer ist als die Gesamtzahl der Elemente, die der Iterator erzeugen kann (wie Infinity), hat der zurückgegebene Iterator-Helfer im Wesentlichen dasselbe Verhalten wie der ursprüngliche Iterator:

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

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

• Polyfill von Iterator.prototype.take in core-js
• es-shims Polyfill von Iterator.prototype.take
• Iterator
• Iterator.prototype.drop()