cached-factory 0.2.0 → 0.3.0

package/README.md

@@ -20,10 +20,14 @@
 
 ## Usage
 
+### `CachedFactory`
+
 `cached-factory` exports a `CachedFactory` class that takes in "factory" function in its constructor.
 Each time a factory's `.get(key)` is called with any `key` for the first time, that factory is used to create a value under the `key`.
 
 ```ts
+import { CachedFactory } from "cached-factory";
+
 const cache = new CachedFactory((key) => `Cached: ${key}!`);
 
 // "Cached: apple!"
@@ -33,6 +37,8 @@ cache.get("apple");
 Values are cached so that subsequent `.get(key)` calls with the same `key` instantly return the same value.
 
 ```ts
+import { CachedFactory } from "cached-factory";
+
 const cache = new CachedFactory((key) => ({ key }));
 
 // { key: "banana" }
@@ -42,7 +48,25 @@ cache.get("banana");
 cache.get("banana") === cache.get("banana");
 ```
 
-### Asynchronous Factories
+### `WeakCachedFactory`
+
+The package also exports a `WeakCachedFactory` class that provides the same behavior as `CachedFactory` but uses a `WeakMap` as its underlying data structure.
+As such, only objects can be used for keys (no primitives), and there is no `entries()` function.
+
+```ts
+import { WeakCachedFactory } from "cached-factory";
+
+const cache = new WeakCachedFactory((key: Context) =>
+	createSomeResultObject(key),
+);
+
+const result = cache.get(someContext);
+
+// true
+result === cache.get(someContext);
+```
+
+## Asynchronous Factories
 
 `CachedFactory` does not itself handle `Promise` logic, but it doesn't have to!
 Provided factory functions can themselves be `async` / return `Promise` values.
@@ -71,7 +95,7 @@ cache.clear();
 
 ### TypeScript
 
-`CachedFactory` is written in TypeScript and ships with strong typing.
+`cached-factory` is written in TypeScript and ships with strong typing.
 💪
 
 > 👉 Tip: if you're working with [`noImplicitAny`](https://aka.ms/tsconfig#noImplicitAny) enabled _(which is generally a good idea)_, an inline function provided as an argument to `CachedFactory` may need an explicit type annotation for its key.

package/lib/CachedFactory.d.ts

@@ -0,0 +1,12 @@
+//#region src/CachedFactory.d.ts
+type Factory<Key, Value> = (key: Key) => Value;
+declare class CachedFactory<Key, Value> {
+  #private;
+  constructor(factory: Factory<Key, Value>);
+  clear(): void;
+  entries(): MapIterator<[Key, Value]>;
+  get(key: Key): Value;
+}
+//#endregion
+export { CachedFactory, Factory };
+//# sourceMappingURL=CachedFactory.d.ts.map

package/lib/CachedFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CachedFactory.d.ts","names":[],"sources":["../src/CachedFactory.ts"],"mappings":";KAAY,OAAA,gBAAuB,GAAA,EAAK,GAAA,KAAQ,KAAK;AAAA,cAExC,aAAA;EAAA;cAIA,OAAA,EAAS,OAAA,CAAQ,GAAA,EAAK,KAAA;EAIlC,KAAA;EAIA,OAAA,IAAO,WAAA,EAAA,GAAA,EAAA,KAAA;EAIP,GAAA,CAAI,GAAA,EAAK,GAAA,GAAG,KAAA;AAAA"}

package/lib/CachedFactory.js

@@ -0,0 +1,25 @@
+//#region src/CachedFactory.ts
+var CachedFactory = class {
+	#cache = /* @__PURE__ */ new Map();
+	#getter;
+	constructor(factory) {
+		this.#getter = factory;
+	}
+	clear() {
+		this.#cache.clear();
+	}
+	entries() {
+		return this.#cache.entries();
+	}
+	get(key) {
+		const existing = this.#cache.get(key);
+		if (existing) return existing;
+		const value = this.#getter(key);
+		this.#cache.set(key, value);
+		return value;
+	}
+};
+//#endregion
+export { CachedFactory };
+
+//# sourceMappingURL=CachedFactory.js.map

package/lib/CachedFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CachedFactory.js","names":["#getter","#cache"],"sources":["../src/CachedFactory.ts"],"sourcesContent":["export type Factory<Key, Value> = (key: Key) => Value;\n\nexport class CachedFactory<Key, Value> {\n\t#cache = new Map<Key, Value>();\n\t#getter: Factory<Key, Value>;\n\n\tconstructor(factory: Factory<Key, Value>) {\n\t\tthis.#getter = factory;\n\t}\n\n\tclear() {\n\t\tthis.#cache.clear();\n\t}\n\n\tentries() {\n\t\treturn this.#cache.entries();\n\t}\n\n\tget(key: Key) {\n\t\tconst existing = this.#cache.get(key);\n\t\tif (existing) {\n\t\t\treturn existing;\n\t\t}\n\n\t\tconst value = this.#getter(key);\n\t\tthis.#cache.set(key, value);\n\t\treturn value;\n\t}\n}\n"],"mappings":";AAEA,IAAa,gBAAb,MAAuC;CACtC,yBAAS,IAAI,IAAgB;CAC7B;CAEA,YAAY,SAA8B;EACzC,KAAKA,UAAU;CAChB;CAEA,QAAQ;EACP,KAAKC,OAAO,MAAM;CACnB;CAEA,UAAU;EACT,OAAO,KAAKA,OAAO,QAAQ;CAC5B;CAEA,IAAI,KAAU;EACb,MAAM,WAAW,KAAKA,OAAO,IAAI,GAAG;EACpC,IAAI,UACH,OAAO;EAGR,MAAM,QAAQ,KAAKD,QAAQ,GAAG;EAC9B,KAAKC,OAAO,IAAI,KAAK,KAAK;EAC1B,OAAO;CACR;AACD"}

package/lib/WeakCachedFactory.d.ts

@@ -0,0 +1,12 @@
+import { Factory } from "./CachedFactory.js";
+
+//#region src/WeakCachedFactory.d.ts
+declare class WeakCachedFactory<Key extends WeakKey, Value> {
+  #private;
+  constructor(factory: Factory<Key, Value>);
+  clear(): void;
+  get(key: Key): Value;
+}
+//#endregion
+export { WeakCachedFactory };
+//# sourceMappingURL=WeakCachedFactory.d.ts.map

package/lib/WeakCachedFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WeakCachedFactory.d.ts","names":[],"sources":["../src/WeakCachedFactory.ts"],"mappings":";;;cAEa,iBAAA,aAA8B,OAAA;EAAA;cAI9B,OAAA,EAAS,OAAA,CAAQ,GAAA,EAAK,KAAA;EAIlC,KAAA;EAIA,GAAA,CAAI,GAAA,EAAK,GAAA,GAAG,KAAA;AAAA"}

package/lib/WeakCachedFactory.js

@@ -0,0 +1,22 @@
+//#region src/WeakCachedFactory.ts
+var WeakCachedFactory = class {
+	#cache = /* @__PURE__ */ new WeakMap();
+	#getter;
+	constructor(factory) {
+		this.#getter = factory;
+	}
+	clear() {
+		this.#cache = /* @__PURE__ */ new WeakMap();
+	}
+	get(key) {
+		const existing = this.#cache.get(key);
+		if (existing) return existing;
+		const value = this.#getter(key);
+		this.#cache.set(key, value);
+		return value;
+	}
+};
+//#endregion
+export { WeakCachedFactory };
+
+//# sourceMappingURL=WeakCachedFactory.js.map

package/lib/WeakCachedFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WeakCachedFactory.js","names":["#getter","#cache"],"sources":["../src/WeakCachedFactory.ts"],"sourcesContent":["import { Factory } from \"./CachedFactory.ts\";\n\nexport class WeakCachedFactory<Key extends WeakKey, Value> {\n\t#cache = new WeakMap<Key, Value>();\n\t#getter: Factory<Key, Value>;\n\n\tconstructor(factory: Factory<Key, Value>) {\n\t\tthis.#getter = factory;\n\t}\n\n\tclear() {\n\t\tthis.#cache = new WeakMap<Key, Value>();\n\t}\n\n\tget(key: Key) {\n\t\tconst existing = this.#cache.get(key);\n\t\tif (existing) {\n\t\t\treturn existing;\n\t\t}\n\n\t\tconst value = this.#getter(key);\n\t\tthis.#cache.set(key, value);\n\t\treturn value;\n\t}\n}\n"],"mappings":";AAEA,IAAa,oBAAb,MAA2D;CAC1D,yBAAS,IAAI,QAAoB;CACjC;CAEA,YAAY,SAA8B;EACzC,KAAKA,UAAU;CAChB;CAEA,QAAQ;EACP,KAAKC,yBAAS,IAAI,QAAoB;CACvC;CAEA,IAAI,KAAU;EACb,MAAM,WAAW,KAAKA,OAAO,IAAI,GAAG;EACpC,IAAI,UACH,OAAO;EAGR,MAAM,QAAQ,KAAKD,QAAQ,GAAG;EAC9B,KAAKC,OAAO,IAAI,KAAK,KAAK;EAC1B,OAAO;CACR;AACD"}

package/lib/index.d.ts

@@ -1,12 +1,3 @@
-//#region src/index.d.ts
-type Factory<Key, Value> = (key: Key) => Value;
-declare class CachedFactory<Key, Value> {
-  #private;
-  constructor(factory: Factory<Key, Value>);
-  clear(): void;
-  entries(): MapIterator<[Key, Value]>;
-  get(key: Key): Value;
-}
-//#endregion
-export { CachedFactory, Factory };
-//# sourceMappingURL=index.d.ts.map
+import { CachedFactory, Factory } from "./CachedFactory.js";
+import { WeakCachedFactory } from "./WeakCachedFactory.js";
+export { CachedFactory, type Factory, WeakCachedFactory };

package/lib/index.js

@@ -1,25 +1,3 @@
-//#region src/index.ts
-var CachedFactory = class {
-	#cache = /* @__PURE__ */ new Map();
-	#getter;
-	constructor(factory) {
-		this.#getter = factory;
-	}
-	clear() {
-		this.#cache.clear();
-	}
-	entries() {
-		return this.#cache.entries();
-	}
-	get(key) {
-		const existing = this.#cache.get(key);
-		if (existing) return existing;
-		const value = this.#getter(key);
-		this.#cache.set(key, value);
-		return value;
-	}
-};
-//#endregion
-export { CachedFactory };
-
-//# sourceMappingURL=index.js.map
+import { CachedFactory } from "./CachedFactory.js";
+import { WeakCachedFactory } from "./WeakCachedFactory.js";
+export { CachedFactory, WeakCachedFactory };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "cached-factory",
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"description": "Creates and caches values under keys. 🏭",
 	"repository": {
 		"type": "git",
@@ -36,35 +36,35 @@
 		"@eslint/js": "10.0.1",
 		"@eslint/markdown": "8.0.1",
 		"@release-it/conventional-changelog": "11.0.0",
-		"@types/node": "25.6.0",
+		"@types/node": "25.9.0",
 		"@vitest/coverage-v8": "4.1.5",
 		"@vitest/eslint-plugin": "1.6.16",
 		"console-fail-test": "0.6.1",
 		"create-typescript-app": "2.60.1",
 		"cspell": "10.0.0",
-		"eslint": "10.2.1",
-		"eslint-plugin-jsdoc": "62.9.0",
-		"eslint-plugin-jsonc": "3.1.2",
-		"eslint-plugin-n": "17.24.0",
-		"eslint-plugin-package-json": "0.91.1",
+		"eslint": "10.4.0",
+		"eslint-plugin-jsdoc": "63.0.0",
+		"eslint-plugin-jsonc": "3.2.0",
+		"eslint-plugin-n": "18.1.0",
+		"eslint-plugin-package-json": "1.3.0",
 		"eslint-plugin-perfectionist": "5.9.0",
 		"eslint-plugin-regexp": "3.1.0",
-		"eslint-plugin-yml": "3.3.1",
+		"eslint-plugin-yml": "3.4.0",
 		"husky": "9.1.7",
-		"knip": "6.7.0",
-		"lint-staged": "16.4.0",
+		"knip": "6.16.0",
+		"lint-staged": "17.0.2",
 		"prettier": "3.8.3",
 		"prettier-plugin-curly": "0.4.1",
 		"prettier-plugin-packagejson": "3.0.2",
 		"prettier-plugin-sentences-per-line": "0.2.3",
 		"prettier-plugin-sh": "0.18.1",
-		"release-it": "20.0.1",
-		"tsdown": "0.21.10",
+		"release-it": "20.2.0",
+		"tsdown": "0.22.0",
 		"typescript": "6.0.3",
-		"typescript-eslint": "8.59.0",
+		"typescript-eslint": "8.61.0",
 		"vitest": "4.1.5"
 	},
-	"packageManager": "pnpm@10.33.2",
+	"packageManager": "pnpm@11.5.0",
 	"engines": {
 		"node": ">=18"
 	},

package/lib/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";KAAY,OAAA,gBAAuB,GAAA,EAAK,GAAA,KAAQ,KAAA;AAAA,cAEnC,aAAA;EAAA;cAIA,OAAA,EAAS,OAAA,CAAQ,GAAA,EAAK,KAAA;EAIlC,KAAA,CAAA;EAIA,OAAA,CAAA,GAAO,WAAA,EAAA,GAAA,EAAA,KAAA;EAIP,GAAA,CAAI,GAAA,EAAK,GAAA,GAAG,KAAA;AAAA"}

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","names":["#getter","#cache"],"sources":["../src/index.ts"],"sourcesContent":["export type Factory<Key, Value> = (key: Key) => Value;\n\nexport class CachedFactory<Key, Value> {\n\t#cache = new Map<Key, Value>();\n\t#getter: Factory<Key, Value>;\n\n\tconstructor(factory: Factory<Key, Value>) {\n\t\tthis.#getter = factory;\n\t}\n\n\tclear() {\n\t\tthis.#cache.clear();\n\t}\n\n\tentries() {\n\t\treturn this.#cache.entries();\n\t}\n\n\tget(key: Key) {\n\t\tconst existing = this.#cache.get(key);\n\t\tif (existing) {\n\t\t\treturn existing;\n\t\t}\n\n\t\tconst value = this.#getter(key);\n\t\tthis.#cache.set(key, value);\n\t\treturn value;\n\t}\n}\n"],"mappings":";AAEA,IAAa,gBAAb,MAAuC;CACtC,yBAAS,IAAI,KAAiB;CAC9B;CAEA,YAAY,SAA8B;AACzC,QAAA,SAAe;;CAGhB,QAAQ;AACP,QAAA,MAAY,OAAO;;CAGpB,UAAU;AACT,SAAO,MAAA,MAAY,SAAS;;CAG7B,IAAI,KAAU;EACb,MAAM,WAAW,MAAA,MAAY,IAAI,IAAI;AACrC,MAAI,SACH,QAAO;EAGR,MAAM,QAAQ,MAAA,OAAa,IAAI;AAC/B,QAAA,MAAY,IAAI,KAAK,MAAM;AAC3B,SAAO"}