Array.prototype.shift()

La méthode shift() permet de retirer le premier élément d'un tableau et de renvoyer cet élément. Cette méthode modifie la longueur du tableau.

Syntaxe

arr.shift()

Valeur de retour

L'élément retiré du tableau

Description

La méthode shift retire l'élément situé à l'index zéro et décrémente l'index des éléments suivant avant de retourner l'élément supprimé. Si la propriété length vaut 0, undefined est retourné.

Cette méthode est générique et peut être appelée ou appliquée sur des objets similaires à des tableaux. 

Cette méthode n'est pas exploitable pour les objets dont la propriété length ne reflète pas la taille du contenu, ou pour lesquels la propriété length n'est pas définie.

Exemples

Supprimer un élément d'un tableau

Le code suivant affiche le tableau mesPoissons avant et après avoir enlevé le premier élément. Il affiche aussi l'élément supprimé :

var mesPoissons = ["ange", "clown", "mandarin", "chirurgien"];

console.log("mesPoissons avant : " + mesPoissons);
// mesPoissons avant : ange,clown,mandarin,chirurgien

var premierÉlément = mesPoissons.shift();

console.log("mesPoissons après : " + mesPoissons);
// mesPoissons après : clown,mandarin,chirurgien 

console.log("Cet élément a été enlevé : " + premierÉlément);
// "Cet élément a été enlevé : ange"

Spécifications

Compatibilité des navigateurs

Voir aussi

• Array.prototype.push()
• Array.prototype.pop()
• Array.prototype.unshift()