Array.prototype.shift()

Probieren Sie es aus

const array = [1, 2, 3];

const firstElement = array.shift();

console.log(array);
// Expected output: Array [2, 3]

console.log(firstElement);
// Expected output: 1

Syntax

shift()

Parameter

Keine.

Rckgabewert

Das entfernte Element aus dem Array; undefined, wenn das Array leer ist.

Beschreibung

Die shift() Methode verschiebt alle Werte um 1 nach links und verringert die Lnge um 1, was dazu fhrt, dass das erste Element entfernt wird. Wenn die length-Eigenschaft 0 ist, wird undefined zurckgegeben.

Die pop()-Methode verhlt sich hnlich wie shift(), wird jedoch auf das letzte Element in einem Array angewendet.

Die shift() Methode ist eine mutierende Methode. Sie verndert die Lnge und den Inhalt von this. Falls Sie den Wert von this gleich belassen, aber ein neues Array mit dem ersten entfernten Element zurckgeben mchten, knnen Sie stattdessen arr.slice(1) verwenden.

Die shift() Methode ist generisch. Sie erwartet nur, dass der this-Wert eine length-Eigenschaft und integer-indizierte Eigenschaften hat. Obwohl Strings ebenfalls array-hnlich sind, ist diese Methode ungeeignet fr Strings, da Strings unvernderlich sind.

Beispiele

Entfernen eines Elements aus einem Array

Der folgende Code zeigt das myFish-Array vor und nach dem Entfernen seines ersten Elements. Es zeigt auch das entfernte Element an:

const myFish = ["angel", "clown", "mandarin", "surgeon"];

console.log("myFish before:", myFish);
// myFish before: ['angel', 'clown', 'mandarin', 'surgeon']

const shifted = myFish.shift();

console.log("myFish after:", myFish);
// myFish after: ['clown', 'mandarin', 'surgeon']

console.log("Removed this element:", shifted);
// Removed this element: angel

Verwendung der shift() Methode in einer While-Schleife

Die shift() Methode wird oft in einer Bedingung innerhalb einer While-Schleife verwendet. Im folgenden Beispiel wird bei jeder Iteration das nchste Element aus einem Array entfernt, bis es leer ist:

const names = ["Andrew", "Tyrone", "Paul", "Maria", "Gayatri"];

while (typeof (i = names.shift()) !== "undefined") {
  console.log(i);
}
// Andrew, Tyrone, Paul, Maria, Gayatri

Aufruf von shift() auf Nicht-Array-Objekten

Die shift() Methode liest die length-Eigenschaft von this. Wenn die normalisierte Lnge 0 ist, wird length wieder auf 0 gesetzt (whrend es vorher negativ oder undefined sein knnte). Andernfalls wird die Eigenschaft bei 0 zurckgegeben, und die restlichen Eigenschaften werden um eins nach links verschoben. Die Eigenschaft bei length - 1 wird gelscht, und die length-Eigenschaft wird um eins verringert.

const arrayLike = {
  length: 3,
  unrelated: "foo",
  2: 4,
};
console.log(Array.prototype.shift.call(arrayLike));
// undefined, because it is an empty slot
console.log(arrayLike);
// { '1': 4, length: 2, unrelated: 'foo' }

const plainObj = {};
// There's no length property, so the length is 0
Array.prototype.shift.call(plainObj);
console.log(plainObj);
// { length: 0 }

Spezifikationen

Browser-Kompatibilitt

Siehe auch

• Indizierte Sammlungen Leitfaden
• Array
• Array.prototype.push()
• Array.prototype.pop()
• Array.prototype.unshift()
• Array.prototype.concat()
• Array.prototype.splice()