refactor: InvertedweakMap -> WeakValueMap

Author: wan2land

README.md

@@ -14,7 +14,7 @@
 </p>
 
 This library provides three iterable weak data structures for JavaScript,
-IterableWeakSet, IterableWeakMap, and InvertedWeakMap. These data structures are
+IterableWeakSet, IterableWeakMap, and WeakValueMap. These data structures are
 designed to work with objects as keys or values, and are useful when you need to
 store a collection of objects that may be garbage collected.
 
@@ -24,14 +24,15 @@ store a collection of objects that may be garbage collected.
 
 ```ts
 import {
-  InvertedWeakMap,
   IterableWeakMap,
   IterableWeakSet,
+  WeakValueMap,
 } from "https://deno.land/x/weakref/mod.ts";
 
 const set = new IterableWeakSet();
 const map = new IterableWeakMap();
-const invertedMap = new InvertedWeakMap();
+
+const weakValueMap = new WeakValueMap();
 ```
 
 ### with Node.js & Browser
@@ -123,17 +124,17 @@ if (global.gc) {
 console.log(map.size); // output: 0
 ```
 
-### InvertedWeakMap
+### WeakValueMap
 
-InvertedWeakMap is a class that allows you to create a map of non-object keys
-with weak references to object values. This is useful when you have a collection
-of non-object keys that you want to use to look up objects, and those objects
-may be garbage collected.
+WeakValueMap is a class that allows you to create a map of non-object keys with
+weak references to object values. This is useful when you have a collection of
+non-object keys that you want to use to look up objects, and those objects may
+be garbage collected.
 
 **Interface**
 
 ```ts
-class InvertedWeakMap<K, V extends object> implements Map<K, V> {
+class WeakValueMap<K, V extends object> implements Map<K, V> {
   constructor(entries?: readonly (readonly [K, V])[] | null);
   constructor(iterable: Iterable<readonly [K, V]>);
 }
@@ -142,7 +143,7 @@ class InvertedWeakMap<K, V extends object> implements Map<K, V> {
 **Example**
 
 ```ts
-const map = new InvertedWeakMap();
+const map = new WeakValueMap();
 
 // create an object with a weak reference
 {

mod.ts

@@ -1,4 +1,4 @@
 export { IterableWeakSet } from "./iterable_weak_set.ts";
 export { IterableWeakMap } from "./iterable_weak_map.ts";
 
-export { InvertedWeakMap } from "./inverted_weak_map.ts";
+export { WeakValueMap } from "./weak_value_map.ts";

scripts/build_npm.ts

@@ -28,7 +28,7 @@ await build({
     name: "weakref",
     version,
     description:
-      "Extend built-in collections with weak references for efficient garbage collection and optimal performance in memory-intensive applications with IterableWeakSet, IterableWeakMap, and InvertedWeakMap.",
+      "Extend built-in collections with weak references for efficient garbage collection and optimal performance in memory-intensive applications with IterableWeakSet, IterableWeakMap, and WeakValueMap.",
     keywords: [
       "weakref",
       "weakset",

inverted_weak_map.test.ts weak_value_map.test.ts

@@ -1,27 +1,27 @@
 import { assert, assertEquals, assertFalse } from "testing/asserts.ts";
-import { InvertedWeakMap } from "./inverted_weak_map.ts";
+import { WeakValueMap } from "./weak_value_map.ts";
 
 function* iterate<T>(items: T[]): IterableIterator<T> {
   for (const item of items) {
     yield item;
   }
 }
 
-Deno.test("InvertedWeakMap, constructor", () => {
-  assertEquals(new InvertedWeakMap().size, 0);
-  assertEquals(new InvertedWeakMap(undefined).size, 0);
-  assertEquals(new InvertedWeakMap(null).size, 0);
+Deno.test("WeakValueMap, constructor", () => {
+  assertEquals(new WeakValueMap().size, 0);
+  assertEquals(new WeakValueMap(undefined).size, 0);
+  assertEquals(new WeakValueMap(null).size, 0);
 
-  assertEquals(new InvertedWeakMap([]).size, 0);
-  assertEquals(new InvertedWeakMap(iterate([])).size, 0);
+  assertEquals(new WeakValueMap([]).size, 0);
+  assertEquals(new WeakValueMap(iterate([])).size, 0);
 
-  assertEquals(new InvertedWeakMap([[1, {}]]).size, 1);
-  assertEquals(new InvertedWeakMap(iterate([[1, {}] as const])).size, 1);
+  assertEquals(new WeakValueMap([[1, {}]]).size, 1);
+  assertEquals(new WeakValueMap(iterate([[1, {}] as const])).size, 1);
 });
 
-Deno.test("InvertedWeakMap, comparison Map, WeakMap", () => {
+Deno.test("WeakValueMap, comparison Map, WeakMap", () => {
   const map = new Map();
-  const iwmap = new InvertedWeakMap();
+  const iwmap = new WeakValueMap();
 
   assertEquals(map.size, 0);
   assertEquals(iwmap.size, 0);
@@ -86,10 +86,10 @@ Deno.test("InvertedWeakMap, comparison Map, WeakMap", () => {
   assertEquals(iwmap.size, 0);
 
   assertEquals(map.toString(), "[object Map]");
-  assertEquals(iwmap.toString(), "[object InvertedWeakMap]");
+  assertEquals(iwmap.toString(), "[object WeakValueMap]");
 });
 
-Deno.test("InvertedWeakMap, iterable", () => {
+Deno.test("WeakValueMap, iterable", () => {
   const tuples: [number | string | boolean, Record<string, unknown>][] = [
     [1, {}],
     ["2", {}],
@@ -101,7 +101,7 @@ Deno.test("InvertedWeakMap, iterable", () => {
 
   const maps = [
     new Map(tuples),
-    new InvertedWeakMap(tuples),
+    new WeakValueMap(tuples),
   ];
 
   for (const map of maps) {
@@ -162,14 +162,14 @@ Deno.test("InvertedWeakMap, iterable", () => {
   }
 });
 
-Deno.test("InvertedWeakMap, garbage collect", async () => {
+Deno.test("WeakValueMap, garbage collect", async () => {
   let removedCount = 0;
   let insertedCount = 0;
   const register = new FinalizationRegistry(() => {
     removedCount++;
   });
 
-  const map = new InvertedWeakMap();
+  const map = new WeakValueMap();
   for (let i = 0; removedCount < 100; i++) {
     await new Promise((resolve) => setTimeout(resolve, 16));
     const data = {};

inverted_weak_map.ts weak_value_map.ts

@@ -1,6 +1,6 @@
 // deno-lint-ignore-file ban-types
 
-export class InvertedWeakMap<K, V extends object> implements Map<K, V> {
+export class WeakValueMap<K, V extends object> implements Map<K, V> {
   #map = new Map<K, WeakRef<V>>();
   #registry = new FinalizationRegistry<K>(this.#map.delete.bind(this.#map));
 
@@ -48,7 +48,7 @@ export class InvertedWeakMap<K, V extends object> implements Map<K, V> {
   }
 
   get [Symbol.toStringTag]() {
-    return "InvertedWeakMap";
+    return "WeakValueMap";
   }
 
   forEach(