Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

WeakMap — metadane ze słabo utrzymywanymi kluczami

WeakMap wiąże wartości z kluczami bez utrzymywania samych kluczy przy życiu. Poznaj set, get, has i delete, porównywanie kluczy przez tożsamość oraz ograniczenia dotyczące iteracji i odśmiecania pamięci.

Wersja: ECMAScript 2015 (ES2015) introduced WeakMap. ECMAScript 2023 (ES2023) added support for non-registered symbols as keys.

Składnia

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

WeakMap przechowuje powiązania klucz–wartość. Kluczami mogą być obiekty oraz symbole spoza globalnego rejestru symboli, np. Symbol(), ale nie Symbol.for(). Obsługa takich symboli jest częścią ECMAScript 2023; starsze silniki mogą przyjmować wyłącznie obiekty. Wartością może być dowolna wartość JavaScript. Obiekty są porównywane przez tożsamość: dwa osobne {} to różne klucze.

WeakMap.set oznacza tutaj metodę instancji WeakMap.prototype.set, a nie metodę statyczną. wm.set(key, value) dodaje lub zastępuje wartość i zwraca wm. Analogicznie WeakMap.get to WeakMap.prototype.get: wm.get(key) zwraca wartość albo undefined. WeakMap.prototype.has, wywoływane jako wm.has(key), odróżnia brak wpisu od wpisu z wartością undefined.

WeakMap.delete oznacza WeakMap.prototype.delete: wm.delete(key) usuwa wpis i zwraca true, jeśli istniał, albo false, jeśli go nie było. Niedozwolony typ klucza powoduje TypeError w set; get zwraca wtedy undefined, a has i delete zwracają false.

Słabe powiązanie nie zapobiega odśmieceniu klucza, który poza nim nie jest już osiągalny. Termin odśmiecania nie jest gwarantowany; nie opieraj na nim poprawności programu. WeakMap nie udostępnia iteracji po wpisach ani size. Nadaje się do metadanych związanych z obiektami; jeśli potrzebujesz wyliczania wpisów, wybierz Map.

Przykłady

const metadata = new WeakMap();
const key = {};
const other = {};

console.log(metadata.set(key, 7) === metadata);
console.log(metadata.get(key));
console.log(metadata.has(other));
metadata.set(key, undefined);
console.log(metadata.has(key));
console.log(metadata.get(key) === undefined);
console.log(metadata.delete(key));
console.log(metadata.delete(key));

Wynik

true
7
false
true
true
true
false

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła