@fable-org/fable-library-ts 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 1.4.0 - 2024-03-18
+
+### Added
+
+* [JS/TS] Add `ConditionalWeakTable` (by @chkn)
+
 ## 1.3.0 - 2024-03-18
 
 * [JS/TS] `Boolean.tryParse` should not crash on `null` string (@goswinr)

package/ConditionalWeakTable.ts

@@ -0,0 +1,26 @@
+
+export class ConditionalWeakTable<TKey extends object, TValue> {
+  private weakMap: WeakMap<TKey, TValue> = new WeakMap<TKey, TValue>();
+
+  public delete(key: TKey) {
+    return this.weakMap.delete(key);
+  }
+
+  public get(key: TKey) {
+    return this.weakMap.get(key);
+  }
+
+  public has(key: TKey) {
+    return this.weakMap.has(key);
+  }
+
+  public set(key: TKey, value: TValue) {
+    return this.weakMap.set(key, value);
+  }
+
+  public clear() {
+    this.weakMap = new WeakMap<TKey, TValue>();
+  }
+}
+
+export default ConditionalWeakTable;

package/MapUtil.ts

@@ -1,4 +1,4 @@
-import { equals, IMap, ISet } from "./Util.js";
+import { equals, IMap, IMapOrWeakMap, ISet } from "./Util.js";
 import { FSharpRef, Union } from "./Types.js";
 
 const CaseRules = {
@@ -88,7 +88,7 @@ export function containsValue<K, V>(v: V, map: IMap<K, V>) {
   return false;
 }
 
-export function tryGetValue<K, V>(map: IMap<K, V>, key: K, defaultValue: FSharpRef<V>): boolean {
+export function tryGetValue<K, V>(map: IMapOrWeakMap<K, V>, key: K, defaultValue: FSharpRef<V>): boolean {
   if (map.has(key)) {
     defaultValue.contents = map.get(key) as V;
     return true;
@@ -104,7 +104,15 @@ export function addToSet<T>(v: T, set: ISet<T>) {
   return true;
 }
 
-export function addToDict<K, V>(dict: IMap<K, V>, k: K, v: V) {
+export function tryAddToDict<K, V>(dict: IMapOrWeakMap<K, V>, k: K, v: V) {
+  if (dict.has(k)) {
+    return false;
+  }
+  dict.set(k, v);
+  return true;
+}
+
+export function addToDict<K, V>(dict: IMapOrWeakMap<K, V>, k: K, v: V) {
   if (dict.has(k)) {
     throw new Error("An item with the same key has already been added. Key: " + k);
   }
@@ -118,3 +126,12 @@ export function getItemFromDict<K, V>(map: IMap<K, V>, key: K) {
     throw new Error(`The given key '${key}' was not present in the dictionary.`);
   }
 }
+
+export function getItemFromDictOrCreate<K, V>(map: IMapOrWeakMap<K, V>, key: K, createValue: (key: K) => V) {
+  if (map.has(key)) {
+    return map.get(key) as V;
+  }
+  const value = createValue(key);
+  map.set(key, value);
+  return value;
+}

package/Util.ts

@@ -183,13 +183,18 @@ export interface ISet<T> {
   values(): Iterable<T>;
 }
 
-export interface IMap<K, V> {
-  clear(): void;
+export interface IMapOrWeakMap<K, V> {
   delete(key: K): boolean;
-  forEach(callbackfn: (value: V, key: K, map: IMap<K, V>) => void, thisArg?: any): void;
   get(key: K): V | undefined;
   has(key: K): boolean;
+  set(key: K, value: V): IMapOrWeakMap<K, V>;
+}
+
+export interface IMap<K, V> extends IMapOrWeakMap<K, V> {
+  clear(): void;
   set(key: K, value: V): IMap<K, V>;
+
+  forEach(callbackfn: (value: V, key: K, map: IMap<K, V>) => void, thisArg?: any): void;
   readonly size: number;
 
   [Symbol.iterator](): Iterator<[K, V]>;

package/package.json

@@ -3,7 +3,7 @@
   "private": false,
   "type": "module",
   "name": "@fable-org/fable-library-ts",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Core library used by F# projects compiled with fable.io",
   "author": "Fable Contributors",
   "license": "MIT",