@rhombus-toolkit/collections 3.0.0 → 3.1.0

package/dist/bundle/index.d.ts

@@ -103,4 +103,30 @@ declare class MultiKeyWeakMap<in out Keys extends readonly unknown[] = unknown[]
     getOrInsertComputed(keys: Keys, compute: Func<[Keys], Value>): Value;
 }
 
-export { AutoStack, ImmutableLinkedList, KindaWeakMap, MultiKeyWeakMap };
+/**
+ * A `Map` whose values are held weakly, so an entry is removed once nothing else holds its value.
+ *
+ * @remarks
+ * Not a `Map` by `instanceof`.
+ */
+declare class WeakValuedMap<K, V extends WeakKey> implements Map<K, V> {
+    #private;
+    constructor();
+    constructor(entries: Iterable<readonly [K, V]> | null);
+    /** Re-setting an existing key leaves its place in iteration order unchanged, as with `Map`. */
+    set(key: K, value: V): this;
+    delete(key: K): boolean;
+    get(key: K): V | undefined;
+    has(key: K): boolean;
+    clear(): void;
+    forEach(callbackfn: (value: V, key: K, map: this) => void, thisArg?: any): void;
+    /** Computed by walking every entry and counting those whose value is still alive. */
+    get size(): number;
+    entries(): MapIterator<[K, V]>;
+    keys(): MapIterator<K>;
+    values(): MapIterator<V>;
+    [Symbol.iterator](): MapIterator<[K, V]>;
+    readonly [Symbol.toStringTag]: "WeakValuedMap";
+}
+
+export { AutoStack, ImmutableLinkedList, KindaWeakMap, MultiKeyWeakMap, WeakValuedMap };

package/dist/bundle/index.js

@@ -218,9 +218,75 @@ class MultiKeyWeakMap {
     return (this.#ensureNodeAt(keys).entry ??= { value: compute(keys) }).value;
   }
 }
+// src/WeakValuedMap.ts
+class WeakValuedMap {
+  #map = new Map;
+  #registry = new FinalizationRegistry(({ key, ref }) => {
+    if (this.#map.get(key) === ref) {
+      this.#map.delete(key);
+    }
+  });
+  constructor(entries) {
+    for (const [key, value] of entries ?? []) {
+      this.set(key, value);
+    }
+  }
+  set(key, value) {
+    const held = this.#map.get(key);
+    if (held) {
+      this.#registry.unregister(held);
+    }
+    const ref = new WeakRef(value);
+    this.#registry.register(value, { key, ref }, ref);
+    this.#map.set(key, ref);
+    return this;
+  }
+  delete(key) {
+    const held = this.#map.get(key);
+    if (!held) {
+      return false;
+    }
+    this.#map.delete(key);
+    this.#registry.unregister(held);
+    return held.deref() !== undefined;
+  }
+  get(key) {
+    return this.#map.get(key)?.deref();
+  }
+  has(key) {
+    return this.get(key) !== undefined;
+  }
+  clear() {
+    this.#map.forEach((ref) => this.#registry.unregister(ref));
+    this.#map.clear();
+  }
+  forEach(callbackfn, thisArg) {
+    for (const [key, value] of this) {
+      callbackfn.call(thisArg, value, key, this);
+    }
+  }
+  get size() {
+    return this.entries().reduce((count) => count + 1, 0);
+  }
+  entries() {
+    const held = this.#map.entries().map(([key, ref]) => [key, ref.deref()]);
+    return held.filter((entry) => entry[1] !== undefined);
+  }
+  keys() {
+    return this.entries().map(([key]) => key);
+  }
+  values() {
+    return this.entries().map(([, value]) => value);
+  }
+  [Symbol.iterator]() {
+    return this.entries();
+  }
+  [Symbol.toStringTag] = "WeakValuedMap";
+}
 export {
   AutoStack,
   ImmutableLinkedList,
   KindaWeakMap,
-  MultiKeyWeakMap
+  MultiKeyWeakMap,
+  WeakValuedMap
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rhombus-toolkit/collections",
-  "version": "3.0.0",
-  "description": "Collection data structures: AutoStack (entries leave with their scope), ImmutableLinkedList (persistent, both ends known), KindaWeakMap (weak where it can, strong otherwise), MultiKeyWeakMap (a KindaWeakMap keyed by a tuple).",
+  "version": "3.1.0",
+  "description": "Collection data structures: AutoStack (entries leave with their scope), ImmutableLinkedList (persistent, both ends known), KindaWeakMap (weak where it can, strong otherwise), MultiKeyWeakMap (a KindaWeakMap keyed by a tuple), WeakValuedMap (values held weakly).",
   "repository": {
     "type": "git",
     "url": "https://github.com/rhombus-toolkit/ts.git",