mild-map 1.1.1 → 1.2.0

package/dist/index.d.ts

@@ -6,5 +6,10 @@ declare class MildMap<K, V> {
     get(key: K): V | undefined;
     has(key: K): boolean;
     set(key: K, value: V): this;
+    [Symbol.iterator](): IterableIterator<[K, V]>;
+    keys(): IterableIterator<K>;
+    values(): IterableIterator<V>;
+    entries(): IterableIterator<[K, V]>;
+    forEach(callback: (value: V, key: K, map: MildMap<K, V>) => void, thisArg?: any): undefined;
 }
 export default MildMap;

package/dist/index.js

@@ -1,25 +1,20 @@
 /* IMPORT */
-import { isWeakReferable } from 'is';
-/* HELPERS */
-const isWeakabe = (value) => {
-    return isWeakReferable(value);
-};
+import { isWeakReferable } from './utils.js';
 /* MAIN */
 class MildMap {
     /* VARIABLES */
-    #strong;
-    #weak;
-    #size;
-    #finalizationRegistry;
-    #finalizationTokens;
+    #strong = new Map();
+    #weak = new WeakMap();
+    #weakRefs = new Set();
+    #weakRefsMap = new WeakMap();
+    #size = 0;
+    #finalizationTokens = new WeakMap();
+    #finalizationRegistry = new FinalizationRegistry(weakRef => {
+        this.#size -= 1;
+        this.#weakRefs.delete(weakRef);
+    });
     /* CONSTRUCTOR */
     constructor(entries) {
-        /* VARIABLES */
-        this.#strong = new Map();
-        this.#weak = new WeakMap();
-        this.#size = 0;
-        this.#finalizationRegistry = new FinalizationRegistry(() => this.#size -= 1);
-        this.#finalizationTokens = new WeakMap();
         if (entries) {
             for (const [key, value] of entries) {
                 this.set(key, value);
@@ -36,11 +31,16 @@ class MildMap {
         if (!hasKey)
             return false;
         this.#size -= 1;
-        if (isWeakabe(key)) {
+        if (isWeakReferable(key)) {
             const token = this.#finalizationTokens.get(key);
             if (token) {
                 this.#finalizationRegistry.unregister(token);
                 this.#finalizationTokens.delete(key);
+                const weakRef = this.#weakRefsMap.get(key);
+                if (weakRef) {
+                    this.#weakRefs.delete(weakRef);
+                    this.#weakRefsMap.delete(key);
+                }
             }
             return this.#weak.delete(key);
         }
@@ -49,7 +49,7 @@ class MildMap {
         }
     }
     get(key) {
-        if (isWeakabe(key)) {
+        if (isWeakReferable(key)) {
             return this.#weak.get(key);
         }
         else {
@@ -57,7 +57,7 @@ class MildMap {
         }
     }
     has(key) {
-        if (isWeakabe(key)) {
+        if (isWeakReferable(key)) {
             return this.#weak.has(key);
         }
         else {
@@ -69,11 +69,14 @@ class MildMap {
         if (!hasKey) {
             this.#size += 1;
         }
-        if (isWeakabe(key)) {
+        if (isWeakReferable(key)) {
             this.#weak.set(key, value);
             if (!hasKey) {
+                const weakRef = new WeakRef(key);
                 const token = {};
-                this.#finalizationRegistry.register(key, token, token);
+                this.#weakRefs.add(weakRef);
+                this.#weakRefsMap.set(key, weakRef);
+                this.#finalizationRegistry.register(key, weakRef, token);
                 this.#finalizationTokens.set(key, token);
             }
         }
@@ -82,6 +85,44 @@ class MildMap {
         }
         return this;
     }
+    /* ITERATION API */
+    [Symbol.iterator]() {
+        return this.entries();
+    }
+    *keys() {
+        yield* this.#strong.keys();
+        for (const weakRef of this.#weakRefs) {
+            const key = weakRef.deref();
+            if (key === undefined)
+                continue;
+            yield key;
+        }
+    }
+    *values() {
+        yield* this.#strong.values();
+        for (const weakRef of this.#weakRefs) {
+            const key = weakRef.deref();
+            if (key === undefined || !this.#weak.has(key))
+                continue;
+            const value = this.#weak.get(key);
+            yield value;
+        }
+    }
+    *entries() {
+        yield* this.#strong.entries();
+        for (const weakRef of this.#weakRefs) {
+            const key = weakRef.deref();
+            if (key === undefined || !this.#weak.has(key))
+                continue;
+            const value = this.#weak.get(key);
+            yield [key, value];
+        }
+    }
+    forEach(callback, thisArg) {
+        for (const [key, value] of this.entries()) {
+            callback.call(thisArg, value, key, this);
+        }
+    }
 }
 /* EXPORT */
 export default MildMap;

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+declare const isWeakReferable: (value: unknown) => value is WeakKey;
+export { isWeakReferable };

package/dist/utils.js

@@ -0,0 +1,19 @@
+/* MAIN */
+const isWeakReferable = (() => {
+    const SYMBOLS_ARE_WEAK_REFERABLE = (() => {
+        try {
+            new WeakSet().add(Symbol());
+            return true;
+        }
+        catch {
+            return false;
+        }
+    })();
+    return (value) => {
+        if (value === null)
+            return false;
+        return typeof value === 'object' || typeof value === 'function' || (SYMBOLS_ARE_WEAK_REFERABLE && typeof value === 'symbol' && !Symbol.keyFor(value));
+    };
+})();
+/* EXPORT */
+export { isWeakReferable };

package/package.json

@@ -2,7 +2,8 @@
   "name": "mild-map",
   "repository": "github:fabiospampinato/mild-map",
   "description": "A WeakMap that supports any value, it holds strong references to primitives, and weak references to objects.",
-  "version": "1.1.1",
+  "license": "MIT",
+  "version": "1.2.0",
   "type": "module",
   "main": "dist/index.js",
   "exports": "./dist/index.js",
@@ -19,12 +20,9 @@
     "strong",
     "map"
   ],
-  "dependencies": {
-    "is": "npm:@fabiospampinato/is@^2.5.0"
-  },
   "devDependencies": {
-    "fava": "^0.2.0",
-    "tsex": "^2.2.0",
-    "typescript": "^4.9.5"
+    "fava": "^0.3.4",
+    "tsex": "^4.0.2",
+    "typescript": "^5.7.3"
   }
 }

package/readme.md

@@ -5,7 +5,7 @@ A WeakMap that supports any value, it holds strong references to primitives, and
 ## Install
 
 ```sh
-npm install --save mild-map
+npm install mild-map
 ```
 
 ## Usage
@@ -14,6 +14,8 @@ It has the same API of a WeakMap, except that it just works with primitives too.
 
 It also implements the `size` property, like a Map.
 
+It also implements all the iteration methods, like a Map.
+
 ## License
 
 MIT © Fabio Spampinato

package/.editorconfig

@@ -1,10 +0,0 @@
-
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 2
-indent_style = space
-insert_final_newline = true
-trim_trailing_whitespace = true

package/src/index.ts

@@ -1,145 +0,0 @@
-
-/* IMPORT */
-
-import {isWeakReferable} from 'is';
-
-/* HELPERS */
-
-const isWeakabe = ( value: unknown ): value is object => { //FIXME: Overridden type guard for convenience, delete this once TS updates its types
-  return isWeakReferable ( value );
-};
-
-/* MAIN */
-
-class MildMap<K, V> {
-
-  /* VARIABLES */
-
-  #strong = new Map<K, V> ();
-  #weak = new WeakMap<any, V> ();
-  #size = 0;
-
-  #finalizationRegistry = new FinalizationRegistry ( () => this.#size -= 1 );
-  #finalizationTokens = new WeakMap<object, object> ();
-
-  /* CONSTRUCTOR */
-
-  constructor ( entries?: readonly (readonly [K, V])[] | null ) {
-
-    if ( entries ) {
-
-      for ( const [key, value] of entries ) {
-
-        this.set ( key, value );
-
-      }
-
-    }
-
-  }
-
-  /* GETTER API */
-
-  get size () {
-
-    return this.#size;
-
-  }
-
-  /* API */
-
-  delete ( key: K ): boolean {
-
-    const hasKey = this.has ( key );
-
-    if ( !hasKey ) return false;
-
-    this.#size -= 1;
-
-    if ( isWeakabe ( key ) ) {
-
-      const token = this.#finalizationTokens.get ( key );
-
-      if ( token ) {
-
-        this.#finalizationRegistry.unregister ( token );
-        this.#finalizationTokens.delete ( key );
-
-      }
-
-      return this.#weak.delete ( key );
-
-    } else {
-
-      return this.#strong.delete ( key );
-
-    }
-
-  }
-
-  get ( key: K ): V | undefined {
-
-    if ( isWeakabe ( key ) ) {
-
-      return this.#weak.get ( key );
-
-    } else {
-
-      return this.#strong.get ( key );
-
-    }
-
-  }
-
-  has ( key: K ): boolean {
-
-    if ( isWeakabe ( key ) ) {
-
-      return this.#weak.has ( key );
-
-    } else {
-
-      return this.#strong.has ( key );
-
-    }
-
-  }
-
-  set ( key: K, value: V ): this {
-
-    const hasKey = this.has ( key );
-
-    if ( !hasKey ) {
-
-      this.#size += 1;
-
-    }
-
-    if ( isWeakabe ( key ) ) {
-
-      this.#weak.set ( key, value );
-
-      if ( !hasKey ) {
-
-        const token = {};
-
-        this.#finalizationRegistry.register ( key, token, token );
-        this.#finalizationTokens.set ( key, token );
-
-      }
-
-    } else {
-
-      this.#strong.set ( key, value );
-
-    }
-
-    return this;
-
-  }
-
-}
-
-/* EXPORT */
-
-export default MildMap;

package/test/index.js

@@ -1,70 +0,0 @@
-
-/* IMPORT */
-
-import {describe} from 'fava';
-import {setTimeout as delay} from 'node:timers/promises';
-import MildMap from '../dist/index.js';
-
-/* MAIN */
-
-describe ( 'MildMap', it => {
-
-  it ( 'works', async t => {
-
-    const map = new MildMap ();
-
-    let primitive = 0;
-    let object = {};
-
-    t.is ( map.size, 0 );
-
-    t.is ( map.get ( primitive ), undefined );
-    t.is ( map.get ( object ), undefined );
-
-    t.false ( map.has ( primitive ) );
-    t.false ( map.has ( object ) );
-
-    t.false ( map.delete ( primitive ) );
-    t.false ( map.delete ( object ) );
-
-    map.set ( primitive, 'primitive' );
-    map.set ( object, 'object' );
-
-    t.is ( map.size, 2 );
-
-    t.is ( map.get ( primitive ), 'primitive' );
-    t.is ( map.get ( object ), 'object' );
-
-    t.true ( map.has ( primitive ) );
-    t.true ( map.has ( object ) );
-
-    t.true ( map.delete ( primitive ) );
-    t.true ( map.delete ( object ) );
-
-    t.is ( map.size, 0 );
-
-    map.set ( primitive, 'primitive' );
-    map.set ( object, 'object' );
-
-    t.is ( map.size, 2 );
-
-    /* CLEANUP */
-
-    let deleted = 0;
-
-    const registry = new FinalizationRegistry ( () => deleted++ );
-
-    registry.register ( object );
-
-    object = null;
-
-    await delay ( 500 );
-    global.gc ();
-    await delay ( 500 );
-
-    t.is ( deleted, 1 );
-    t.is ( map.size, 1 );
-
-  });
-
-});

package/tsconfig.json

@@ -1,6 +0,0 @@
-{
-  "extends": "tsex/tsconfig.json",
-  "compilerOptions": {
-    "target": "es2022"
-  }
-}