Iterator.prototype.drop()

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Die drop()-Methode von Iterator-Instanzen gibt ein neues Iterator-Helferobjekt zurück, das die angegebene Anzahl von Elementen am Anfang dieses Iterators überspringt.

Syntax

js
drop(limit)

Parameter

limit

Die Anzahl von Elementen, die am Anfang der Iteration übersprungen werden sollen.

Rückgabewert

Ein neues Iterator-Helferobjekt. Wenn die next()-Methode des zurückgegebenen Iterator-Helfers zum ersten Mal aufgerufen wird, wird der aktuelle Iterator sofort um limit Elemente weitergeführt und dann das nächste Element (das limit+1-te Element) erzeugt. Der Iterator-Helfer gibt dann die verbleibenden Elemente einzeln aus. Wenn der aktuelle Iterator weniger als limit Elemente hat, wird der neue Iterator-Helfer sofort abgeschlossen, wenn next() zum ersten Mal aufgerufen wird.

Ausnahmen

RangeError

Wird ausgelöst, wenn limit zu NaN wird oder negativ ist, wenn in eine ganze Zahl umgewandelt.

Beispiele

Verwendung von drop()

Das folgende Beispiel erstellt einen Iterator, der Begriffe in der Fibonacci-Sequenz ausgibt, beginnend mit dem 3. Begriff, indem die ersten zwei Begriffe übersprungen werden:

js
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

Dies entspricht:

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

Verwendung von drop() in einer for...of-Schleife

drop() ist am praktischsten, wenn Sie den Iterator nicht manuell erstellen. Da Iteratoren auch iterierbar sind, können Sie den zurückgegebenen Helfer mit einer for...of-Schleife durchlaufen:

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

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

Kombination von drop() mit take()

Sie können drop() mit Iterator.prototype.take() kombinieren, um einen Ausschnitt eines Iterators zu erhalten:

js
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

Untere und obere Grenzen des Drop-Zählers

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

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

Wenn der limit größer ist als die Gesamtanzahl der Elemente, die der Iterator erzeugen kann (wie Infinity), wird der zurückgegebene Iterator-Helfer sofort alle Elemente überspringen und dann abgeschlossen, wenn next() zum ersten Mal aufgerufen wird. Wenn der aktuelle Iterator unendlich ist, wird der zurückgegebene Iterator-Helfer niemals abgeschlossen.

js
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 }

Spezifikationen

Specification
Iterator Helpers
# sec-iteratorprototype.drop

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch