Array : mthode keys()

Exemple interactif

const array = ["a", "b", "c"];
const iterator = array.keys();

for (const key of iterator) {
  console.log(key);
}

// Rsultat attendu : 0
// Rsultat attendu : 1
// Rsultat attendu : 2

Syntaxe

keys()

Paramtres

Aucun.

Valeur de retour

Un nouvel objet itrateur itrable.

Description

Lorsqu'elle est utilise sur un tableau creux, la mthode keys() itre sur les emplacements vides comme s'ils avaient la valeur undefined.

La mthode keys() est gnrique. Elle attend uniquement que la valeur de this possde une proprit length et des proprits cls entires.

Exemples

Utiliser keys() sur un tableau creux

Contrairement Object.keys(), qui n'inclut que les cls effectivement prsentes dans le tableau, l'itrateur keys() ne saute pas les trous reprsentant des proprits manquantes.

const arr = ["a", , "c"];
const sparseKeys = Object.keys(arr);
const denseKeys = [...arr.keys()];
console.log(sparseKeys); // ['0', '2']
console.log(denseKeys); // [0, 1, 2]

Appeler keys() sur des objets qui ne sont pas des tableaux

La mthode keys() lit la proprit length de this puis gnre tous les indices entiers de 0 length - 1. Aucun accs aux indices n'est rellement effectu.

const objetSimilaireTableau = {
  length: 3,
};
for (const entry of Array.prototype.keys.call(objetSimilaireTableau)) {
  console.log(entry);
}
// 0
// 1
// 2

Spcifications

Compatibilit des navigateurs

Voir aussi

• Guide des collections indexes
• L'objet global Array
• La mthode Array.prototype.entries()
• La mthode Array.prototype.values()
• Array.prototype[Symbol.iterator]()
• La mthode TypedArray.prototype.keys()
• Les protocoles d'itration
• Prothse d'mulation de Array.prototype.keys dans core-js (angl.)
• Prothse d'mulation es-shims de Array.prototype.keys (angl.)