for...in

L'instruction for...in permet d'itérer sur les propriétés énumérables d'un objet, dans un ordre arbitraire. Pour chaque propriété obtenue, on exécute une instruction (ou plusieurs grâce à un bloc d'instructions).

Syntaxe

for (variable in objet) {...
}

variable

Un nom de propriété différente est assigné à la variable à chaque itération de la boucle.

objet

L'objet dont les propriétés énumérables sont parcourues par la boucle.

Description

Une boucle for...in ne parcourt pas les propriétés qui ne sont pas énumérables. Les objets qui ont été créés par des constructeurs intégrés comme Array et Object ont hérité de propriétés non énumérables de Object.prototype et String.prototype comme les méthodes indexOf() du type String ou toString() depuis Object. La boucle parcourera toutes les propriétés énumérables de l'objet et aussi celles dont il hérite du prototype du constructeur (les propriétés les plus proches de l'objet dans la chaîne des prototypes primeront sur les propriétés des prototypes).

Les propriétés ajoutées, modifiées ou supprimées

Une boucle for...in parcourt les propriétés d'un objet dans un ordre arbitraire (voir l'opérateur delete pour plus d'explications quant à l'impossibilité de se fier à un tel ordre, au moins dans le cas où on souhaite gérer plusieurs navigateurs). Si une propriété est modifiée dans une des itérations de la boucle et que la boucle itère ensuite sur cette propriété, sa valeur sera celle qui a été modifiée. Une propriété qui a été supprimée avant que la boucle n'itère sur celle-là ne sera pas dans la boucle. Les propriétés qui ont été ajoutées à l'objet pendant la boucle peuvent être ou ne pas être pris en compte. Une bonne pratique consiste à ne pas ajouter, modifier ou supprimer une propriété d'un objet lors d'une itération qui ne concerne pas cette propriété. Il n'y a aucune certitude concernant la prise en compte d'une propriété ajoutée lors d'une telle boucle et il en va de même pour savoir si on a visité une propriété avant ou après qu'elle ait été modifiée ou de savoir si une itération de la boucle concernera une propriété avant que celle-ci soit supprimée.

Utiliser for...in et parcourir un tableau

Les éléments des indices d'un tableau sont des propriétés énumérables dont les noms sont des entiers, excepté cela, elles sont en tout point identiques aux propriétés des objets en général. Ici aussi, il n'y a aucune certitude que for...in renvoie les indices dans un ordre particulier. Cette instruction listera également les propriétés énumérables dont les noms ne sont pas des entiers et celles qui sont héritées.

L'ordre dans lequel le parcours est effectué dépend de l'implémentation. Dans le cas d'un parcours de tableau utilisant for...in, on pourrait très bien avoir un ordre qui ne soit pas le même entre les différents environnements. Pour cette raison, il est préférable d'utiliser une boucle for utilisant un compteur numérique (ou Array.forEach() ou encore for...of) lorsqu'on souhaite parcourir des tableaux dans un ordre bien défini.

Itérer uniquement sur les propriétés non héritées

Si on souhaite ne parcourir que les propriétés propres d'un objet et pas celles rattachées à ses prototypes, on peut utiliser la méthode Object.getOwnPropertyNames() ou bien effectuer un test grâce à la méthode Object.prototype.hasOwnProperty() voire avec Object.prototype.propertyIsEnumerable()

Exemples

La fonction qui suit utilise comme argument un objet. Elle parcourt ensuite toutes les propriétés énumérables et renvoie une chaîne de caractères décrivant le nom de la propriété et sa valeur.

var obj = {a:1, b:2, c:3};
    
for (var prop in obj) {
  console.log("obj." + prop + " = " + obj[prop]);
}

// Affiche dans la console :
// "obj.a = 1"
// "obj.b = 2"
// "obj.c = 3"

La fonction qui suit utilise hasOwnProperty() pour ne pas afficher les propriétés héritées :

var triangle = {a:1, b:2, c:3};

function TriangleCouleur() {
  this.couleur = "rouge";
}

TriangleCouleur.prototype = triangle;

var obj = new TriangleCouleur();

for (var prop in obj) {
  if( obj.hasOwnProperty( prop ) ) {
    console.log("obj." + prop + " = " + obj[prop]);
  }
}

// Affichera dans la console :
// "obj.couleur = rouge"

Spécifications

Compatibilité des navigateurs

Expressions avec initialisateur

Avant SpiderMonkey 40 (Firefox 40 / Thunderbird 40 / SeaMonkey 2.37), il était possible d'utiliser un initialisateur (i=0) dans un boucle for...in :

var obj = {a:1, b:2, c:3};
for(var i=0 in obj) {
  console.log(obj[i]);
}
// 1
// 2
// 3

Ce comportement non-standard a été retiré avec la version 40. Cela provoquera désormais une exception SyntaxError ("for-in loop head declarations may not have initializers") (bug 748550).

Les autres moteurs, tels que v8 (Chrome), Chakra (IE/Edge) et JSC (WebKit/Safari) recherchent également comment retirer ce comportement non standard.

Voir aussi

• for...of : une instruction semblable qui permet d'itérer sur les valeurs des propriétés
• for
• Le rattachement et le caractère énumérable des propriétés
• Object.getOwnPropertyNames()
• Object.prototype.hasOwnProperty()
• Array.prototype.forEach()