Array : mthode at()

Exemple interactif

const array = [5, 12, 8, 130, 44];

let index = 2;

console.log(`Un indice de ${index} retourne ${array.at(index)}`);
// Rsultat attendu : "Un indice de 2 retourne 8"

index = -2;

console.log(`Un indice de ${index} retourne ${array.at(index)}`);
// Rsultat attendu : "Un indice de -2 retourne 130"

Syntaxe

at(index)

Paramtres

index

Indice (commenant zro) de l'lment du tableau retourner, converti en entier. Un indice ngatif compte rebours depuis la fin du tableau si index < 0, c'est index + array.length qui est utilis.

Valeur de retour

L'lment du tableau correspondant l'indice donn. Retourne toujours undefined si index < -array.length ou index >= array.length, sans tenter d'accder la proprit correspondante.

Description

La mthode at() est quivalente la notation avec crochets lorsque index est un entier positif ou nul. Par exemple, array[0] et array.at(0) retournent tous deux le premier lment. Cependant, pour compter partir de la fin du tableau, on ne peut pas utiliser array[-1] comme en Python ou R, car toutes les valeurs entre crochets sont traites littralement comme des proprits de chane de caractres, on lit donc array["-1"], qui est simplement une proprit de chane de caractres ordinaire et non un indice de tableau.

La pratique courante consiste accder length et calculer l'indice partir de l par exemple, array[array.length - 1]. La mthode at() permet un indexage relatif, ce qui permet de simplifier en crivant array.at(-1).

En combinant at() avec with(), on peut lire et crire (respectivement) dans un tableau en utilisant des indices ngatifs.

La mthode at() est gnrique. Elle attend seulement que la valeur de this possde une proprit length et des proprits cl entire.

Exemples

Retourner la dernire valeur d'un tableau

L'exemple qui suit fournit une fonction qui retourne le dernier lment trouv dans un tableau.

// Le tableau avec des lments
const panier = ["pomme", "banane", "poire"];

// Une fonction qui retourne le dernier
// lment d'un tableau
function dernierElem(arr) {
  return arr.at(-1);
}

// On rcupre le dernier lment du
// tableau 'panier'
const item1 = dernierElem(panier);
console.log(item1);
// Affiche 'poire' dans la console

// On ajoute un lment au tableau
// 'panier'
panier.push("orange");
const item2 = dernierElem(panier);
console.log(item2);
// Affiche 'orange' dans la console

Comparaison de mthodes

On compare ici diffrentes faons d'accder l'avant-dernier lment d'un tableau (Array). Bien que toutes les mthodes prsentes ici soient valides et quivalentes, on pourra noter la concision et la lisibilit de la mthode at().

// Un tableau de valeurs
const couleurs = ["rouge", "vert", "bleu"];

// En utilisant la proprit length
const avecLength = couleurs[couleurs.length - 2];
console.log(avecLength);
// Affiche 'vert' dans la console

// En utilisant la mthode slice()
// qui renvoie un tableau
const avecSlice = couleurs.slice(-2, -1);
console.log(avecSlice[0]);
// Affiche 'vert' dans la console

// En utilisant la mthode at()
const avecAt = couleurs.at(-2);
console.log(avecAt);
// Affiche 'vert' dans la console

Utiliser at() sur des objets ressemblant des tableaux

La mthode at() lit la proprit length de this et calcule l'indice accder.

const objetSimilaireTableau = {
  length: 2,
  0: "a",
  1: "b",
  2: "c", // ignor par at() car length vaut 2
};
console.log(Array.prototype.at.call(objetSimilaireTableau, 0)); // "a"
console.log(Array.prototype.at.call(objetSimilaireTableau, 2)); // undefined

Spcifications

Compatibilit des navigateurs

Voir aussi

• Guide des collections indexes
• L'objet global Array
• La mthode Array.prototype.findIndex()
• La mthode Array.prototype.indexOf()
• La mthode Array.prototype.with()
• La mthode TypedArray.prototype.at()
• La mthode String.prototype.at()
• Prothse d'mulation pour Array.prototype.at dans core-js (angl.)
• Prothse d'mulation es-shims pour Array.prototype.at (angl.)