Array : mthode with()

Syntaxe

arrayInstance.with(index, value)

Paramtres

index

Indice ( partir de zro) modifier dans le tableau, converti en entier.

• Un indice ngatif compte rebours depuis la fin du tableau si -array.length <= index < 0, index + array.length est utilis.
• Si l'indice aprs normalisation est hors limites, une exception RangeError est leve.

value

Toute valeur affecter l'indice donn.

Valeur de retour

Un nouveau tableau dans lequel l'lment index est remplac par value.

Exceptions

RangeError

Leve si index >= array.length ou index < -array.length.

Description

La mthode with() modifie la valeur un indice donn dans le tableau, en retournant un nouveau tableau dans lequel l'lment cet indice est remplac par la valeur fournie. Le tableau d'origine n'est pas modifi. Cela permet d'enchaner les mthodes de tableau lors des manipulations.

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

La mthode with() ne produit jamais de tableau creux. Si le tableau source est creux, les cases vides seront remplaces par undefined dans le nouveau tableau.

La mthode with() est gnrique. Elle attend seulement que la valeur de this possde une proprit length et des proprits indices entiers.

Exemples

Crer un nouveau tableau avec un seul lment modifi

const arr = [1, 2, 3, 4, 5];
console.log(arr.with(2, 6)); // [1, 2, 6, 4, 5]
console.log(arr); // [1, 2, 3, 4, 5]

Mthodes de tableau chanes

Avec la mthode with(), vous pouvez mettre jour un lment d'un tableau puis appliquer d'autres mthodes de tableau.

const arr = [1, 2, 3, 4, 5];
console.log(arr.with(2, 6).map((x) => x ** 2)); // [1, 4, 36, 16, 25]

Utilisation de with() sur des tableaux creux

La mthode with() cre toujours un tableau dense.

const arr = [1, , 3, 4, , 6];
console.log(arr.with(0, 2)); // [2, undefined, 3, 4, undefined, 6]

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

La mthode with() cre et retourne un nouveau tableau. Elle lit la proprit length de this puis accde chaque proprit dont la cl est un entier non ngatif infrieur length. chaque accs, l'lment du tableau l'indice correspondant est dfini la valeur de la proprit. Enfin, la valeur index est dfinie value.

const objetSimilaireTableau = {
  length: 3,
  unrelated: "foo",
  0: 5,
  2: 4,
  3: 3, // ignor par with() car length vaut 3
};
console.log(Array.prototype.with.call(objetSimilaireTableau, 0, 1));
// [ 1, undefined, 4 ]

Spcifications

Compatibilit des navigateurs

Voir aussi

• Guide des collections indexes
• La mthode Array.prototype.toReversed()
• La mthode Array.prototype.toSorted()
• La mthode Array.prototype.toSpliced()
• La mthode Array.prototype.at()
• La mthode TypedArray.prototype.with()
• Prothse d'mulation de Array.prototype.with dans core-js (angl.)
• Prothse d'mulation es-shims de Array.prototype.with (angl.)