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

CKTIS / JavaScript

WeakMap.set() : ajouter ou remplacer une valeur

La méthode `set()` associe une valeur à une clé dans une `WeakMap`. Si la clé existe déjà, elle remplace sa valeur. Elle renvoie la même collection, 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.set désigne la méthode d’instance WeakMap.prototype.set, et non une méthode statique du constructeur WeakMap. weakMap.set(key, value) ajoute une entrée si la clé est nouvelle ou remplace la valeur si la clé existe déjà. La méthode renvoie la même WeakMap, ce qui permet d’enchaîner avec un autre appel à .set(). Toute valeur est acceptée ; si value est omis, la méthode stocke undefined.

Pour les clés objets, c’est l’identité qui compte : deux objets {} créés séparément constituent deux clés différentes. ECMAScript 2024 accepte aussi les symboles non enregistrés tels que Symbol(). Les anciens environnements d’exécution peuvent n’accepter que des objets comme clés. Une chaîne, un nombre, null ou un symbole enregistré via Symbol.for() provoque une TypeError lorsqu’il sert de clé. Il en va de même si this n’est pas une instance de WeakMap lors de l’appel.

Une entrée ne suffit pas à maintenir sa clé en vie. Si la clé n’est plus accessible en dehors de cette association faible, le ramasse-miettes peut la récupérer, sans garantie quant au moment où cela se produira. C’est utile pour associer des données supplémentaires à un objet sans prolonger sa durée de vie. Utilisez plutôt Map si vous avez besoin de clés textuelles ou de parcourir les entrées.

Exemples

{
  const statuses = new WeakMap();
  const task = {};
  const otherTask = {};

  const result = statuses.set(task, "pending").set(otherTask, false);
  statuses.set(task, "ready");

  console.log(result === statuses);
  console.log(statuses.get(task));
  console.log(statuses.get(otherTask));
  console.log(statuses.has({}));

  try {
    statuses.set("task", "ready");
  } catch (error) {
    console.log(error instanceof TypeError);
  }
}

Résultat

true
ready
false
false
true

Le premier `true` montre que les appels enchaînés renvoient la même collection. `ready` remplace `pending`. Le premier `false` est la valeur stockée pour `otherTask` ; le second indique que le nouvel objet `{}` n’est pas une clé de la collection. Le dernier `true` confirme que la clé textuelle a provoqué une `TypeError`.

Leçons associées

  • JavaScript · Leçon 18 · Débutant · Version : 4

Sources