The getOrInsert() method of WeakMap instances returns the value corresponding to the specified key in this WeakMap. If the key is not present, it inserts a new entry with the key and a given default value, and returns the inserted value.
If the computation of the default value is expensive, consider using WeakMap.prototype.getOrInsertComputed() instead, which takes a callback to compute the default value only if it's actually needed.
JavaScript Demo: WeakMap.prototype.getOrInsert()
const map = new WeakMap([[window, "foo"]]);
console.log(map.getOrInsert(window, "default"));
// Expected output: "foo"
console.log(map.getOrInsert({}, "default"));
// Expected output: "default"
Syntax
getOrInsert(key, defaultValue)
Parameters
key- : The key of the value to return from the
WeakMapobject. Must be either an object or a non-registered symbol. Object keys are compared by reference, not by value.
- : The key of the value to return from the
defaultValue- : The value to insert and return if the key is not already present in the
WeakMapobject.
- : The value to insert and return if the key is not already present in the
Return value
The value associated with the specified key in the WeakMap object. If the key can't be found, defaultValue is inserted and returned.
Exceptions
- TypeError
- : Thrown if
keyis not an object or a non-registered symbol.
- : Thrown if
Examples
Using getOrInsert()
const wm = new WeakMap();
const obj = {};
console.log(wm.get(obj)); // undefined
console.log(wm.getOrInsert(obj, "default")); // "default"
console.log(wm.get(obj)); // "default"
console.log(wm.getOrInsert(obj, "another default")); // "default"
Specifications
Browser compatibility
See also
- Polyfill of
WeakMap.prototype.getOrInsertincore-js - es-shims polyfill of
WeakMap.prototype.getOrInsert - WeakMap
- WeakMap.prototype.get()
- WeakMap.prototype.set()
- WeakMap.prototype.has()
- WeakMap.prototype.getOrInsertComputed()
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
