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

CKTIS / JavaScript

WeakMap : lire, écrire et supprimer des entrées

Découvrez les valeurs renvoyées par `get`, `set` et `delete`, les clés acceptées et la façon de distinguer une entrée absente d’une valeur `undefined` enregistrée.

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

Syntaxe

const wm = new WeakMap();
wm.get(key);
wm.set(key, value);
wm.delete(key);

get, set et delete sont trois méthodes de WeakMap.prototype. Appelez-les sur une instance de WeakMap, par exemple wm.get(key), et non comme des méthodes statiques du constructeur. Un appel sans instance appropriée ou avec une valeur de this incompatible déclenche une TypeError.

wm.get(key) renvoie la valeur enregistrée, ou undefined si la clé est absente ou non valide. Utilisez wm.has(key) pour distinguer une entrée absente d’une valeur undefined enregistrée. wm.set(key, value) ajoute une entrée ou remplace sa valeur. La méthode accepte toute valeur et renvoie la même instance, ce qui permet d’enchaîner les appels. wm.delete(key) renvoie true si une entrée a été supprimée et false si la clé est absente ou non valide. La méthode supprime une entrée, pas une propriété d’objet comme le fait l’opérateur delete.

ECMAScript 2024 autorise comme clés les objets, y compris les fonctions, ainsi que les symboles non enregistrés, par exemple ceux créés par Symbol(). Les symboles enregistrés via Symbol.for() et les autres valeurs primitives sont des clés non valides ; set déclenche alors une TypeError. Les clés sont comparées par identité : deux objets distincts ayant les mêmes propriétés sont deux clés différentes. Vérifiez la prise en charge des clés de type symbole dans votre environnement cible.

Une WeakMap permet d’associer des métadonnées à un objet sans le maintenir en vie du seul fait qu’il sert de clé. Elle ne conserve pas de références fortes à ses clés. Le moment auquel la mémoire sera récupérée n’est pas garanti, et les clés ne peuvent pas être énumérées. Utilisez une Map si vous devez parcourir les clés.

Exemples

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

  console.log(metadata.set(item, 1) === metadata);
  metadata.set(item, 2);
  console.log(metadata.get(item));
  console.log(metadata.get({ id: 1 }));

  metadata.set(item, undefined);
  console.log(metadata.get(item) === undefined && metadata.has(item));
  console.log(metadata.delete(item));
  console.log(metadata.delete(item));
  console.log(metadata.get(item));
}

Résultat

true
2
undefined
true
true
false
undefined

`set` renvoie la même collection et remplace `1` par `2`. Le nouvel objet `{ id: 1 }` est une autre clé. `has` confirme la présence de l’entrée qui contient `undefined` ; seul le premier appel à `delete` la supprime.

Leçons associées

  • JavaScript · Leçon 3 · Avancé · Version : 4
  • JavaScript · Leçon 7 · Avancé · Version : 4
  • JavaScript · Leçon 41 · Intermédiaire · Version : 3

Sources