Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / JavaScript

WeakMap.prototype.set() : associer une valeur à une clé

La méthode `set()` ajoute une entrée à une `WeakMap` ou remplace la valeur associée à une clé existante. Elle renvoie la même instance, ce qui permet d’enchaîner les appels.

Version : ECMAScript 2024 and the current web platform; runtime support varies

Syntaxe

weakMap.set(key, value)

WeakMap.prototype.set est une méthode du prototype qui s’appelle sur une instance : weakMap.set(key, value). Elle ajoute une entrée pour une nouvelle clé ou remplace la valeur associée à la même clé. Elle renvoie la même instance, et non la valeur stockée, ce qui permet d’enchaîner avec un autre appel à .set(). Toute valeur JavaScript est acceptée, y compris undefined.

Les objets utilisés comme clés sont comparés par identité : deux objets distincts aux propriétés identiques sont deux clés différentes. ECMAScript 2024 accepte aussi les symboles non enregistrés comme Symbol("id"). Les symboles issus de Symbol.for("id") et les autres valeurs primitives, comme les chaînes, ne sont pas des clés valides. Les anciens environnements d’exécution peuvent ne pas accepter les clés de type symbole ; vérifiez votre environnement cible.

Une clé invalide déclenche une TypeError. Appeler la méthode détachée de l’instance sans la bonne valeur de this déclenche aussi une TypeError : le récepteur doit être une instance de WeakMap.

L’entrée ne maintient pas à elle seule la clé en vie. Si la clé n’est plus accessible autrement, le ramasse-miettes peut la récupérer ; ne comptez pas sur le moment où cela se produira. Les clés d’une WeakMap ne sont pas énumérables. Pour parcourir les clés ou utiliser des chaînes comme clés, utilisez plutôt une Map.

Exemples

{
  const metadata = new WeakMap();
  const item = { id: 1 };

  metadata.set(item, 10);
  console.log(metadata.get(item));

  const returned = metadata.set(item, 20);
  console.log(returned === metadata);
  console.log(metadata.get(item));
  console.log(metadata.has({ id: 1 }));

  try {
    metadata.set("id", 30);
  } catch (error) {
    console.log(error instanceof TypeError);
  }
}

Résultat

10
true
20
false
true

La première lecture renvoie `10`, puis la lecture après la mise à jour renvoie `20`. La comparaison `returned === metadata` donne `true`. Un nouvel objet avec le même `id` n’est pas la clé stockée : `has()` renvoie donc `false`. L’utilisation d’une chaîne comme clé déclenche une `TypeError`, qui est interceptée.

Leçons associées

  • JavaScript · Leçon 35 · Débutant · Version : 4
  • JavaScript · Leçon 37 · Débutant · Version : 4
  • JavaScript · Leçon 4 · Intermédiaire · Version : 3
  • JavaScript · Leçon 10 · Intermédiaire · Version : 3

Sources