Array : méthode keys()

Baseline Large disponibilité

Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis juillet 2015.

La méthode keys() des instances de Array retourne un nouvel objet itérateur de tableau qui contient les clés pour chaque indice du tableau.

Dans cet article

Exemple interactif

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

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

// Résultat attendu : 0
// Résultat attendu : 1
// Résultat attendu : 2

Syntaxe

keys()

Paramètres

Aucun.

Valeur de retour

Un nouvel objet itérateur itérable.

Description

Lorsqu'elle est utilisée sur un tableau creux, la méthode keys() itère sur les emplacements vides comme s'ils avaient la valeur undefined.

La méthode keys() est générique. Elle attend uniquement que la valeur de this possède une propriété length et des propriétés à clés entières.

Exemples

Utiliser keys() sur un tableau creux

Contrairement à Object.keys(), qui n'inclut que les clés effectivement présentes dans le tableau, l'itérateur keys() ne saute pas les trous représentant des propriétés manquantes.

js
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 méthode keys() lit la propriété length de this puis génère tous les indices entiers de 0 à length - 1. Aucun accès aux indices n'est réellement effectué.

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