cached-factory 0.1.0 → 0.3.0

package/README.md

@@ -1,34 +1,33 @@
 <h1 align="center">cached-factory</h1>
 
-<p align="center">Creates and caches values under keys. 🏭</p>
+<p align="center">
+	Creates and caches values under keys.
+	🏭
+</p>
 
 <p align="center">
-	<a href="#contributors" target="_blank">
-<!-- prettier-ignore-start -->
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-<img alt="All Contributors: 1" src="https://img.shields.io/badge/all_contributors-1-21bb42.svg" />
+	<!-- prettier-ignore-start -->
+	<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+	<a href="#contributors" target="_blank"><img alt="👪 All Contributors: 2" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-2-21bb42.svg" /></a>
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
-<!-- prettier-ignore-end -->
-	</a>
-	<a href="https://codecov.io/gh/JoshuaKGoldberg/cached-factory" target="_blank">
-	<img alt="Codecov Test Coverage" src="https://codecov.io/gh/JoshuaKGoldberg/cached-factory/branch/main/graph/badge.svg"/>
-	</a>
-	<a href="https://github.com/JoshuaKGoldberg/cached-factory/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank">
-		<img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" />
-	</a>
-	<a href="https://github.com/JoshuaKGoldberg/cached-factory/blob/main/LICENSE.md" target="_blank">
-		<img alt="License: MIT" src="https://img.shields.io/github/license/JoshuaKGoldberg/cached-factory?color=21bb42">
-	</a>
-	<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
-	<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
+	<!-- prettier-ignore-end -->
+	<a href="https://github.com/JoshuaKGoldberg/cached-factory/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
+	<a href="https://codecov.io/gh/JoshuaKGoldberg/cached-factory" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/JoshuaKGoldberg/cached-factory?label=%F0%9F%A7%AA%20coverage" /></a>
+	<a href="https://github.com/JoshuaKGoldberg/cached-factory/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg" /></a>
+	<a href="http://npmjs.com/package/cached-factory" target="_blank"><img alt="📦 npm version" src="https://img.shields.io/npm/v/cached-factory?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
+	<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
 </p>
 
 ## 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!"
@@ -38,16 +37,36 @@ 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" }
 cache.get("banana");
 
 // true
-cache.get("banana") === cached.get("banana");
+cache.get("banana") === cache.get("banana");
+```
+
+### `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
+## 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.
@@ -76,7 +95,8 @@ 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.
 >
@@ -84,26 +104,28 @@ cache.clear();
 > new CachedFactory((key: string) => `Cached: ${key}!`);
 > ```
 
+## Development
+
+See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md), then [`.github/DEVELOPMENT.md`](./.github/DEVELOPMENT.md).
+Thanks! 🏭
+
 ## Contributors
 
 <!-- spellchecker: disable -->
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
 <table>
   <tbody>
     <tr>
+      <td align="center" valign="top" width="14.28%"><a href="http://lishaduck.github.io"><img src="https://avatars.githubusercontent.com/u/88557639?v=4?s=100" width="100px;" alt="Eli"/><br /><sub><b>Eli</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/cached-factory/issues?q=author%3Alishaduck" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://www.joshuakgoldberg.com/"><img src="https://avatars.githubusercontent.com/u/3335181?v=4?s=100" width="100px;" alt="Josh Goldberg ✨"/><br /><sub><b>Josh Goldberg ✨</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/cached-factory/commits?author=JoshuaKGoldberg" title="Code">💻</a> <a href="#content-JoshuaKGoldberg" title="Content">🖋</a> <a href="https://github.com/JoshuaKGoldberg/cached-factory/commits?author=JoshuaKGoldberg" title="Documentation">📖</a> <a href="#ideas-JoshuaKGoldberg" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-JoshuaKGoldberg" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-JoshuaKGoldberg" title="Maintenance">🚧</a> <a href="#projectManagement-JoshuaKGoldberg" title="Project Management">📆</a> <a href="#tool-JoshuaKGoldberg" title="Tools">🔧</a></td>
     </tr>
   </tbody>
 </table>
 
-<!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 <!-- spellchecker: enable -->
 
-<!-- You can remove this notice if you don't want it 🙂 no worries! -->
-
-> 💙 This package is based on [@JoshuaKGoldberg](https://github.com/JoshuaKGoldberg)'s [template-typescript-node-package](https://github.com/JoshuaKGoldberg/template-typescript-node-package).
+> 💝 This package was templated with [`create-typescript-app`](https://github.com/JoshuaKGoldberg/create-typescript-app) using the [Bingo framework](https://create.bingo).

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,10 +1,3 @@
-type Factory<Key, Value> = (key: Key) => Value;
-declare class CachedFactory<Key, Value> {
-    #private;
-    constructor(factory: Factory<Key, Value>);
-    clear(): void;
-    entries(): IterableIterator<[Key, Value]>;
-    get(key: Key): Value;
-}
-
-export { CachedFactory, Factory };
+import { CachedFactory, Factory } from "./CachedFactory.js";
+import { WeakCachedFactory } from "./WeakCachedFactory.js";
+export { CachedFactory, type Factory, WeakCachedFactory };

package/lib/index.js

@@ -1,26 +1,3 @@
-class CachedFactory {
-  #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;
-  }
-}
-export {
-  CachedFactory
-};
-//# sourceMappingURL=index.js.map
+import { CachedFactory } from "./CachedFactory.js";
+import { WeakCachedFactory } from "./WeakCachedFactory.js";
+export { CachedFactory, WeakCachedFactory };

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "cached-factory",
-	"version": "0.1.0",
+	"version": "0.3.0",
 	"description": "Creates and caches values under keys. 🏭",
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/JoshuaKGoldberg/cached-factory"
+		"url": "git+https://github.com/JoshuaKGoldberg/cached-factory.git"
 	},
 	"license": "MIT",
 	"author": {
@@ -12,25 +12,19 @@
 		"email": "npm@joshuakgoldberg.com"
 	},
 	"type": "module",
-	"main": "./lib/index.js",
+	"main": "lib/index.js",
 	"files": [
-		"lib/",
-		"package.json",
-		"LICENSE.md",
-		"README.md"
+		"lib/"
 	],
 	"scripts": {
-		"build": "tsup",
-		"format": "prettier \"**/*\" --ignore-unknown",
+		"build": "tsdown",
+		"format": "prettier .",
 		"format:write": "pnpm format --write",
-		"lint": "eslint . .*js --max-warnings 0 --report-unused-disable-directives",
+		"lint": "eslint . --max-warnings 0",
 		"lint:knip": "knip",
-		"lint:md": "markdownlint \"**/*.md\" \".github/**/*.md\" --rules sentences-per-line",
-		"lint:package-json": "npmPkgJsonLint .",
 		"lint:packages": "pnpm dedupe --check",
 		"lint:spelling": "cspell \"**\" \".github/**/*\"",
-		"prepare": "husky install",
-		"should-semantic-release": "should-semantic-release --verbose",
+		"prepare": "husky",
 		"test": "vitest",
 		"tsc": "tsc"
 	},
@@ -38,47 +32,43 @@
 		"*": "prettier --ignore-unknown --write"
 	},
 	"devDependencies": {
-		"@types/eslint": "^8.44.2",
-		"@typescript-eslint/eslint-plugin": "^6.4.1",
-		"@typescript-eslint/parser": "^6.4.1",
-		"@vitest/coverage-istanbul": "^0.34.3",
-		"console-fail-test": "^0.2.3",
-		"cspell": "^7.0.1",
-		"eslint": "^8.48.0",
-		"eslint-config-prettier": "^9.0.0",
-		"eslint-plugin-deprecation": "^1.5.0",
-		"eslint-plugin-eslint-comments": "^3.2.0",
-		"eslint-plugin-import": "^2.28.1",
-		"eslint-plugin-jsdoc": "^46.5.0",
-		"eslint-plugin-jsonc": "^2.9.0",
-		"eslint-plugin-markdown": "^3.0.1",
-		"eslint-plugin-n": "^16.0.2",
-		"eslint-plugin-no-only-tests": "^3.1.0",
-		"eslint-plugin-perfectionist": "^1.5.1",
-		"eslint-plugin-regexp": "^1.15.0",
-		"eslint-plugin-vitest": "^0.2.8",
-		"eslint-plugin-yml": "^1.8.0",
-		"husky": "^8.0.3",
-		"jsonc-eslint-parser": "^2.3.0",
-		"knip": "^2.20.1",
-		"lint-staged": "^14.0.1",
-		"markdownlint": "^0.30.0",
-		"markdownlint-cli": "^0.35.0",
-		"npm-package-json-lint": "^7.0.0",
-		"npm-package-json-lint-config-default": "^6.0.0",
-		"prettier": "^3.0.2",
-		"prettier-plugin-curly": "^0.1.2",
-		"prettier-plugin-packagejson": "^2.4.5",
-		"release-it": "^16.1.5",
-		"sentences-per-line": "^0.2.1",
-		"should-semantic-release": "^0.1.1",
-		"tsup": "^7.2.0",
-		"typescript": "^5.1.6",
-		"vitest": "^0.34.3",
-		"yaml-eslint-parser": "^1.2.2"
+		"@eslint-community/eslint-plugin-eslint-comments": "4.7.1",
+		"@eslint/js": "10.0.1",
+		"@eslint/markdown": "8.0.1",
+		"@release-it/conventional-changelog": "11.0.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.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.4.0",
+		"husky": "9.1.7",
+		"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.2.0",
+		"tsdown": "0.22.0",
+		"typescript": "6.0.3",
+		"typescript-eslint": "8.61.0",
+		"vitest": "4.1.5"
 	},
-	"packageManager": "pnpm@9.15.0",
+	"packageManager": "pnpm@11.5.0",
 	"engines": {
 		"node": ">=18"
+	},
+	"publishConfig": {
+		"provenance": true
 	}
 }

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"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":"AAEO,MAAM,cAA0B;AAAA,EACtC,SAAS,oBAAI,IAAgB;AAAA,EAC7B;AAAA,EAEA,YAAY,SAA8B;AACzC,SAAK,UAAU;AAAA,EAChB;AAAA,EAEA,QAAQ;AACP,SAAK,OAAO,MAAM;AAAA,EACnB;AAAA,EAEA,UAAU;AACT,WAAO,KAAK,OAAO,QAAQ;AAAA,EAC5B;AAAA,EAEA,IAAI,KAAU;AACb,UAAM,WAAW,KAAK,OAAO,IAAI,GAAG;AACpC,QAAI,UAAU;AACb,aAAO;AAAA,IACR;AAEA,UAAM,QAAQ,KAAK,QAAQ,GAAG;AAC9B,SAAK,OAAO,IAAI,KAAK,KAAK;AAC1B,WAAO;AAAA,EACR;AACD;","names":[]}