evicting-cache 3.0.1 → 3.0.3

package/CHANGELOG.md

@@ -0,0 +1,139 @@
+## [3.0.3](https://github.com/D1g1talEntr0py/evicting-cache/compare/v3.0.2...v3.0.3) (2026-03-16)
+
+### Bug Fixes
+
+* **release:** I just want this to work... (6a8b4103f7720c00c502ca9cf50c4f262d35afb0)
+* **release:** kill me now (f8d2196a740389ea0acec8b9deedf408a2784c42)
+
+## [3.0.2](https://github.com/D1g1talEntr0py/evicting-cache/compare/v3.0.1...v3.0.2) (2026-03-16)
+
+### Bug Fixes
+
+* **ci:** Fix publishing to include a valid release (997fa6a8f56d9b3fe91f8cc2206b1169607ddb25)
+* **ci:** fixed autoInstallPeers mismatch (c8778b682546bd9767a3664a858435776b59f1b3)
+* **ci:** more fun with peer install conflicts (53fa74b13e0688059722ad8634c1bf8bfa596de5)
+* **ci:** more GitHub actions nonsense (e211d1ad81397f4b720dc534e4f8cbe9f02ce44f)
+
+### Documentation
+
+* fixed badges on README.md, again (b4996da990f80df4230abfe4fc929954931ba989)
+
+### Miscellaneous Chores
+
+* **deps:** updated dev dependencies and fixed package.json (6ee9c740653667b6f7f2ba5d26cab7280ae61b40)
+
+## [3.0.1](https://github.com/D1g1talEntr0py/evicting-cache/compare/v3.0.0...v3.0.1) (2026-03-01)
+
+### Bug Fixes
+
+* fixed invalid flag for type-check script (808b4d21b02c22a46aeaa4b39ff1103dc70f7bc9)
+
+### Continuous Integration
+
+* added repository to package.json (1dc7b1b2e15432e1020752d740c99d31009336f1)
+
+## [3.0.0](https://github.com/D1g1talEntr0py/evicting-cache/compare/v2.2.1...v3.0.0) (2026-03-01)
+
+### ⚠ BREAKING CHANGES
+
+* None - all changes are backward compatible
+
+### Features
+
+* add batch operations, statistics tracking, and performance optimizations (3dd757608e71e1d4d736cc7d2306ad5bec3392d2)
+Added new API methods:
+- delete(key) - explicit item removal matching Map API
+- forEach(callback, thisArg) - iteration with proper this binding
+- putAll/getAll/deleteAll - batch operations for multiple keys
+- getStats/resetStats - cache hit/miss statistics tracking
+
+Performance improvements:
+- Optimized evict() by removing unsafe type assertion
+- Optimized putAndEvict() by eliminating redundant has() check
+
+Other improvements:
+- Enhanced getOrPut() error handling documentation
+- Improved type safety using 'unknown' instead of 'any'
+- Added comprehensive test suite maintaining 100% coverage
+
+
+### Documentation
+
+* update badges on README.md (dfdde3bf8dd52f70035c376055fbcdfadd972f90)
+* update README with comprehensive documentation (8476509c194e674cca5c033fa701a996e067c3dd)
+- Add badges for npm version, downloads, license, TypeScript, and coverage
+- Add detailed API reference and usage examples for all methods
+- Add performance table showing O(1) operations
+- Standardize code examples to 2-space indentation
+- Fix import statement to use named export { EvictingCache }
+
+
+### Miscellaneous Chores
+
+* **deps:** Updates pnpm lockfile to reflect dependency upgrades (eb9bb5e7d07fecc581977be618cf3d2b0efe2810)
+Refreshes the lockfile to match bumped devDependencies and toolchain updates so installs are reproducible and CI uses the exact updated dependency tree.
+
+* **githooks:** Adds commit-msg hook (deb5d8a158283312172a043ee2ceb2b11fea13b6)
+Adds an executable hook that enforces Conventional Commits for all commit messages to keep commit history structured and machine-readable for release tooling and CI validation.
+
+* **package:** Updates package exports and devDependencies (ad8e4685fc938aae48baaa2fb254dfc2510a688d)
+Updates the package exports to point to built artifacts and bumps a set of development tooling versions to align with newer runtime and linting ecosystems; removes an inline tsbuild entry to rely on external build tooling.
+
+
+### Continuous Integration
+
+* add packageManager to package.json file (49d43111e3a56f5a2fe34ac915089228b2ba7c90)
+* Adds CI workflow (235caead19ce418229750e13b00ca768598916d5)
+Adds a GitHub Actions CI pipeline that runs installs, linting, type checks, tests with coverage, and builds across a Node matrix to ensure quality and compatibility across supported Node versions.
+
+* **release:** Adds release workflow & semantic-release config (0b8da372b6366b947d001a57e4415541e04105b7)
+Automates releases on main by wiring a release workflow and configuring semantic-release so versioning and changelogs are generated from Conventional Commits and publishes artifacts accordingly.
+
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.3.1] - 2025-10-28
+
+### Changed
+- Updated README with comprehensive documentation of all features
+- Added badges for npm version, downloads, license, TypeScript version, and test coverage
+- Improved code examples in README for clarity
+- Added detailed usage examples for all API methods
+- Added performance characteristics table
+- Added complete API reference section
+- Enhanced TypeScript usage examples
+
+### Fixed
+- Fixed import statement in README to use named export `{ EvictingCache }` instead of default import
+
+## [2.3.0] - 2025-10-27
+
+### Added
+- `delete(key)` method to explicitly remove items from the cache, matching standard Map API
+- `forEach(callback, thisArg?)` method to iterate over cache entries with proper `this` binding support
+- Batch operations for improved performance:
+  - `putAll(entries)` - Add multiple key-value pairs at once
+  - `getAll(keys)` - Retrieve multiple values (returns Map, excludes missing keys)
+  - `deleteAll(keys)` - Remove multiple keys (returns count of removed items)
+- Cache statistics tracking:
+  - `getStats()` - Returns hit/miss counts and calculated hit rate
+  - `resetStats()` - Resets statistics counters to zero
+- Statistics are automatically tracked on `get()` operations (hits and misses)
+- Comprehensive test suite for all new features maintaining 100% code coverage
+
+### Changed
+- Improved `getOrPut()` error handling with explicit documentation that cache state remains unchanged when producer function throws
+- Enhanced `getOrPut()` implementation to be more explicit about error handling behavior
+
+### Fixed
+- Performance optimization in `evict()` method - removed unsafe type assertion and simplified iterator usage
+- Performance optimization in `putAndEvict()` method - removed redundant `has()` check, now leverages `delete()` return value
+
+### Security
+- Replaced `any` type with `unknown` type in `forEach()` `thisArg` parameter for improved type safety
+
+## [2.2.1] - Previous Release

package/README.md

@@ -1,11 +1,11 @@
 # Evicting Cache
 
-[![npm version](https://img.shields.io/npm/v/@d1g1tal/evicting-cache?color=blue)](https://www.npmjs.com/package/@d1g1tal/evicting-cache)
-[![npm downloads](https://img.shields.io/npm/dm/@d1g1tal/evicting-cache)](https://www.npmjs.com/package/@d1g1tal/evicting-cache)
+[![npm version](https://img.shields.io/npm/v/evicting-cache?color=blue)](https://www.npmjs.com/package/evicting-cache)
+[![npm downloads](https://img.shields.io/npm/dm/evicting-cache)](https://www.npmjs.com/package/evicting-cache)
 [![CI](https://github.com/D1g1talEntr0py/evicting-cache/actions/workflows/ci.yml/badge.svg)](https://github.com/D1g1talEntr0py/evicting-cache/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/D1g1talEntr0py/evicting-cache/graph/badge.svg)](https://codecov.io/gh/D1g1talEntr0py/evicting-cache)
-[![License: MIT](https://img.shields.io/github/license/D1g1talEntr0py/evicting-cache)](https://github.com/D1g1talEntr0py/evicting-cache/blob/main/LICENSE)
-[![Node.js](https://img.shields.io/node/v/@d1g1tal/evicting-cache)](https://nodejs.org)
+[![License: ISC](https://img.shields.io/github/license/D1g1talEntr0py/evicting-cache)](https://github.com/D1g1talEntr0py/evicting-cache/blob/main/LICENSE)
+[![Node.js](https://img.shields.io/node/v/evicting-cache)](https://nodejs.org)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
 
 A lightweight, high-performance TypeScript implementation of an LRU (Least Recently Used) cache with automatic eviction.

package/dist/evicting-cache.d.ts

@@ -0,0 +1,181 @@
+type CacheStats = {
+    hits: number;
+    misses: number;
+    hitRate: number;
+};
+/** JavaScript implementation of a Least Recently Used(LRU) Cache using a Map. */
+declare class EvictingCache<K, V> {
+    private readonly _capacity;
+    private readonly cache;
+    private hits;
+    private misses;
+    /**
+     * Creates a new Evicting Cache with the given capacity.
+     *
+     * @param {number} [capacity=100] The maximum number of key-value pairs the cache can hold.
+     */
+    constructor(capacity?: number);
+    /**
+     * Returns the value associated with the given key from the cache and updates the LRU order.
+     *
+     * @param {K} key The key to get the value for.
+     * @returns {V | null} The associated value if the key is in the cache, or null otherwise.
+     */
+    get(key: K): V | null;
+    /**
+     * Returns true if the given key is in the cache, false otherwise.
+     *
+     * @param {K} key The key to check.
+     * @returns {boolean} True if the key is in the cache, false otherwise.
+     */
+    has(key: K): boolean;
+    /**
+     * Adds a new key-value pair to the cache and updates the LRU order.
+     * If adding the new pair will exceed the capacity, removes the least recently used pair from the cache.
+     *
+     * @param {K} key The key to add.
+     * @param {V} value The value to add.
+     * @returns {void}
+     */
+    put(key: K, value: V): void;
+    /**
+     * Removes the specified key from the cache.
+     *
+     * @param {K} key The key to remove.
+     * @returns {boolean} True if the key was in the cache and was removed, false otherwise.
+     */
+    delete(key: K): boolean;
+    /**
+     * Returns the value associated with the given key from the cache without updating the LRU order.
+     *
+     * @param {K} key The key to get the value for.
+     * @returns {V | null} The associated value if the key is in the cache, or null otherwise.
+     */
+    peek(key: K): V | null;
+    /**
+     * Returns the value for the key if it exists in the cache. If not, put the key-value pair into the cache and return the value.
+     * If the producer function throws an error, the cache state is not modified.
+     *
+     * @param {K} key The key.
+     * @param {function(): V} producer The value to put if the key does not exist in the cache.
+     * @returns {V} The value corresponding to the key.
+     */
+    getOrPut(key: K, producer: () => V): V;
+    /**
+     * Removes the least recently used key-value pair from the cache.
+     * @returns {boolean} True if an item was removed, false otherwise.
+     */
+    evict(): boolean;
+    /**
+     * Clears the cache and the LRU list.
+     * @returns {void}
+     */
+    clear(): void;
+    /**
+     * Executes a provided function once per each key/value pair in the cache, in insertion order.
+     * @param {(value: V, key: K, cache: EvictingCache<K, V>) => void} callbackfn Function to execute for each element.
+     * @param {unknown} [thisArg] Value to use as `this` when executing callback.
+     * @returns {void}
+     */
+    forEach(callbackfn: (value: V, key: K, cache: EvictingCache<K, V>) => void, thisArg?: unknown): void;
+    /**
+     * Adds multiple key-value pairs to the cache.
+     * Each pair is added individually, following the same LRU eviction rules as put().
+     * @param {Iterable<[K, V]>} entries The entries to add.
+     * @returns {void}
+     */
+    putAll(entries: Iterable<[K, V]>): void;
+    /**
+     * Gets multiple values from the cache.
+     * Each get updates the LRU order for that key.
+     *
+     * @param {Iterable<K>} keys The keys to get values for.
+     * @returns {Map<K, V>} A map of keys to their values (excludes missing keys).
+     */
+    getAll(keys: Iterable<K>): Map<K, V>;
+    /**
+     * Removes multiple keys from the cache.
+     *
+     * @param {Iterable<K>} keys The keys to remove.
+     * @returns {number} The number of keys that were removed.
+     */
+    deleteAll(keys: Iterable<K>): number;
+    /**
+     * Gets cache statistics including hit/miss counts and hit rate.
+     *
+     * @returns {CacheStats} Cache statistics.
+     */
+    getStats(): CacheStats;
+    /**
+     * Resets cache statistics to zero.
+     *
+     * @returns {void}
+     */
+    resetStats(): void;
+    /**
+     * Gets the capacity of the cache.
+     * This is the maximum number of key-value pairs the cache can hold.
+     * This is not the number of key-value pairs in the cache.
+     *
+     * @readonly
+     * @returns {number} The capacity of the cache.
+     */
+    get capacity(): number;
+    /**
+     * Gets the size of the cache.
+     * This is the number of key-value pairs in the cache.
+     * This is not the capacity of the cache.
+     * The capacity is the maximum number of key-value pairs the cache can hold.
+     * The size is the number of key-value pairs currently in the cache.
+     * The size will be less than or equal to the capacity.
+     *
+     * @returns {number} The size of the cache.
+     */
+    get size(): number;
+    /**
+     * Returns an iterator over the keys in the cache.
+     * The keys are returned in the order of least recently used to most recently used.
+     *
+     * @returns {IterableIterator<K>} An iterator over the keys in the cache.
+     */
+    keys(): IterableIterator<K>;
+    /**
+     * Returns an iterator over the values in the cache.
+     * The values are returned in the order of least recently used to most recently used.
+     *
+     * @returns {IterableIterator<V>} An iterator over the values in the cache.
+     */
+    values(): IterableIterator<V>;
+    /**
+     * Returns an iterator over the entries in the cache.
+     * The entries are returned in the order of least recently used to most recently used.
+     *
+     * @returns {IterableIterator<[K, V]>} An iterator over the entries in the cache.
+     */
+    entries(): IterableIterator<[K, V]>;
+    /**
+     * Returns an iterator over the entries in the cache.
+     * The entries are returned in the order of least recently used to most recently used.
+     *
+     * @returns {IterableIterator<[K, V]>} An iterator over the entries in the cache.
+     */
+    [Symbol.iterator](): IterableIterator<[K, V]>;
+    /**
+     * Gets the description of the object.
+     *
+     * @override
+     * @returns {string} The description of the object.
+     */
+    get [Symbol.toStringTag](): string;
+    /**
+     * Puts a key-value pair into the cache and evicts the least recently used item if necessary.
+     * If the key already exists, the item is removed and re-added to update its position.
+     * If the cache is full, the least recently used item is evicted and the new item is added.
+     * @param {K} key The key to put.
+     * @param {V} value The value to put.
+     * @returns {V} The value that was put.
+     */
+    private putAndEvict;
+}
+
+export { EvictingCache };

package/dist/evicting-cache.js

@@ -0,0 +1,2 @@
+var r=class{_capacity;cache;hits=0;misses=0;constructor(e=100){if(e<1)throw new RangeError("capacity must be greater than 0");if(!Number.isInteger(e))throw new RangeError("capacity must be an integer");this._capacity=e,this.cache=new Map}get(e){let t=this.cache.get(e);return t===void 0?(this.misses++,null):(this.hits++,this.cache.delete(e),this.cache.set(e,t),t)}has(e){return this.cache.has(e)}put(e,t){this.putAndEvict(e,t)}delete(e){return this.cache.delete(e)}peek(e){return this.cache.get(e)??null}getOrPut(e,t){let s=this.get(e);if(s!==null)return s;let i=t();return this.putAndEvict(e,i)}evict(){let e=this.cache.keys().next();return e.done?!1:this.cache.delete(e.value)}clear(){this.cache.clear()}forEach(e,t){let s=t!==void 0?e.bind(t):e;this.cache.forEach((i,a)=>s(i,a,this))}putAll(e){for(let[t,s]of e)this.put(t,s)}getAll(e){let t=new Map;for(let s of e){let i=this.get(s);i!==null&&t.set(s,i)}return t}deleteAll(e){let t=0;for(let s of e)this.cache.delete(s)&&t++;return t}getStats(){let e=this.hits+this.misses;return{hits:this.hits,misses:this.misses,hitRate:e===0?0:this.hits/e}}resetStats(){this.hits=0,this.misses=0}get capacity(){return this._capacity}get size(){return this.cache.size}keys(){return this.cache.keys()}values(){return this.cache.values()}entries(){return this.cache.entries()}[Symbol.iterator](){return this.entries()}get[Symbol.toStringTag](){return"EvictingCache"}putAndEvict(e,t){return!this.cache.delete(e)&&this._capacity<=this.cache.size&&this.evict(),this.cache.set(e,t),t}};export{r as EvictingCache};
+//# sourceMappingURL=evicting-cache.js.map

package/dist/evicting-cache.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/evicting-cache.ts"],
+  "sourcesContent": ["type CacheStats = {\n\thits: number;\n\tmisses: number;\n\thitRate: number;\n};\n\n/** JavaScript implementation of a Least Recently Used(LRU) Cache using a Map. */\nexport class EvictingCache<K, V> {\n\tprivate readonly _capacity: number;\n\tprivate readonly cache: Map<K, V>;\n\tprivate hits = 0;\n\tprivate misses = 0;\n\n\t/**\n\t * Creates a new Evicting Cache with the given capacity.\n\t *\n\t * @param {number} [capacity=100] The maximum number of key-value pairs the cache can hold.\n\t */\n\tconstructor(capacity: number = 100) {\n\t\tif (capacity < 1) { throw new RangeError('capacity must be greater than 0') }\n\t\tif (!Number.isInteger(capacity)) { throw new RangeError('capacity must be an integer') }\n\n\t\tthis._capacity = capacity;\n\t\tthis.cache = new Map();\n\t}\n\n\t/**\n\t * Returns the value associated with the given key from the cache and updates the LRU order.\n\t *\n\t * @param {K} key The key to get the value for.\n\t * @returns {V | null} The associated value if the key is in the cache, or null otherwise.\n\t */\n\tget(key: K): V | null {\n\t\tconst value = this.cache.get(key);\n\t\tif (value === undefined) {\n\t\t\tthis.misses++;\n\t\t\treturn null;\n\t\t}\n\n\t\tthis.hits++;\n\t\tthis.cache.delete(key);\n\t\t// Move the accessed item to the end (most recently used)\n\t\tthis.cache.set(key, value);\n\n\t\treturn value;\n\t}\n\n\t/**\n\t * Returns true if the given key is in the cache, false otherwise.\n\t *\n\t * @param {K} key The key to check.\n\t * @returns {boolean} True if the key is in the cache, false otherwise.\n\t */\n\thas(key: K): boolean {\n\t\treturn this.cache.has(key);\n\t}\n\n\t/**\n\t * Adds a new key-value pair to the cache and updates the LRU order.\n\t * If adding the new pair will exceed the capacity, removes the least recently used pair from the cache.\n\t *\n\t * @param {K} key The key to add.\n\t * @param {V} value The value to add.\n\t * @returns {void}\n\t */\n\tput(key: K, value: V): void {\n\t\tthis.putAndEvict(key, value);\n\t}\n\n\t/**\n\t * Removes the specified key from the cache.\n\t *\n\t * @param {K} key The key to remove.\n\t * @returns {boolean} True if the key was in the cache and was removed, false otherwise.\n\t */\n\tdelete(key: K): boolean {\n\t\treturn this.cache.delete(key);\n\t}\n\n\t/**\n\t * Returns the value associated with the given key from the cache without updating the LRU order.\n\t *\n\t * @param {K} key The key to get the value for.\n\t * @returns {V | null} The associated value if the key is in the cache, or null otherwise.\n\t */\n\tpeek(key: K): V | null {\n\t\treturn this.cache.get(key) ?? null;\n\t}\n\n\t/**\n\t * Returns the value for the key if it exists in the cache. If not, put the key-value pair into the cache and return the value.\n\t * If the producer function throws an error, the cache state is not modified.\n\t *\n\t * @param {K} key The key.\n\t * @param {function(): V} producer The value to put if the key does not exist in the cache.\n\t * @returns {V} The value corresponding to the key.\n\t */\n\tgetOrPut(key: K, producer: () => V): V {\n\t\tconst existing = this.get(key);\n\t\tif (existing !== null) { return existing }\n\n\t\t// If producer throws, cache state remains unchanged\n\t\tconst value = producer();\n\t\treturn this.putAndEvict(key, value);\n\t}\n\n\t/**\n\t * Removes the least recently used key-value pair from the cache.\n\t * @returns {boolean} True if an item was removed, false otherwise.\n\t */\n\tevict(): boolean {\n\t\tconst firstEntry = this.cache.keys().next();\n\t\tif (firstEntry.done) { return false }\n\n\t\treturn this.cache.delete(firstEntry.value);\n\t}\n\n\t/**\n\t * Clears the cache and the LRU list.\n\t * @returns {void}\n\t */\n\tclear(): void {\n\t\tthis.cache.clear();\n\t}\n\n\t/**\n\t * Executes a provided function once per each key/value pair in the cache, in insertion order.\n\t * @param {(value: V, key: K, cache: EvictingCache<K, V>) => void} callbackfn Function to execute for each element.\n\t * @param {unknown} [thisArg] Value to use as `this` when executing callback.\n\t * @returns {void}\n\t */\n\tforEach(callbackfn: (value: V, key: K, cache: EvictingCache<K, V>) => void, thisArg?: unknown): void {\n\t\tconst boundCallback = thisArg !== undefined ? callbackfn.bind(thisArg) : callbackfn;\n\t\tthis.cache.forEach((value, key) => boundCallback(value, key, this));\n\t}\n\n\t/**\n\t * Adds multiple key-value pairs to the cache.\n\t * Each pair is added individually, following the same LRU eviction rules as put().\n\t * @param {Iterable<[K, V]>} entries The entries to add.\n\t * @returns {void}\n\t */\n\tputAll(entries: Iterable<[K, V]>): void {\n\t\tfor (const [key, value] of entries) { this.put(key, value) }\n\t}\n\n\t/**\n\t * Gets multiple values from the cache.\n\t * Each get updates the LRU order for that key.\n\t *\n\t * @param {Iterable<K>} keys The keys to get values for.\n\t * @returns {Map<K, V>} A map of keys to their values (excludes missing keys).\n\t */\n\tgetAll(keys: Iterable<K>): Map<K, V> {\n\t\tconst result = new Map<K, V>();\n\t\tfor (const key of keys) {\n\t\t\tconst value = this.get(key);\n\t\t\tif (value !== null) { result.set(key, value) }\n\t\t}\n\n\t\treturn result;\n\t}\n\n\t/**\n\t * Removes multiple keys from the cache.\n\t *\n\t * @param {Iterable<K>} keys The keys to remove.\n\t * @returns {number} The number of keys that were removed.\n\t */\n\tdeleteAll(keys: Iterable<K>): number {\n\t\tlet count = 0;\n\t\tfor (const key of keys) {\n\t\t\tif (this.cache.delete(key)) { count++ }\n\t\t}\n\n\t\treturn count;\n\t}\n\n\t/**\n\t * Gets cache statistics including hit/miss counts and hit rate.\n\t *\n\t * @returns {CacheStats} Cache statistics.\n\t */\n\tgetStats(): CacheStats {\n\t\tconst total = this.hits + this.misses;\n\n\t\treturn { hits: this.hits, misses: this.misses, hitRate: total === 0 ? 0 : this.hits / total };\n\t}\n\n\t/**\n\t * Resets cache statistics to zero.\n\t *\n\t * @returns {void}\n\t */\n\tresetStats(): void {\n\t\tthis.hits = 0;\n\t\tthis.misses = 0;\n\t}\n\n\t/**\n\t * Gets the capacity of the cache.\n\t * This is the maximum number of key-value pairs the cache can hold.\n\t * This is not the number of key-value pairs in the cache.\n\t *\n\t * @readonly\n\t * @returns {number} The capacity of the cache.\n\t */\n\tget capacity(): number {\n\t\treturn this._capacity;\n\t}\n\n\t/**\n\t * Gets the size of the cache.\n\t * This is the number of key-value pairs in the cache.\n\t * This is not the capacity of the cache.\n\t * The capacity is the maximum number of key-value pairs the cache can hold.\n\t * The size is the number of key-value pairs currently in the cache.\n\t * The size will be less than or equal to the capacity.\n\t *\n\t * @returns {number} The size of the cache.\n\t */\n\tget size(): number {\n\t\treturn this.cache.size;\n\t}\n\n\t/**\n\t * Returns an iterator over the keys in the cache.\n\t * The keys are returned in the order of least recently used to most recently used.\n\t *\n\t * @returns {IterableIterator<K>} An iterator over the keys in the cache.\n\t */\n\tkeys(): IterableIterator<K> {\n\t\treturn this.cache.keys();\n\t}\n\n\t/**\n\t * Returns an iterator over the values in the cache.\n\t * The values are returned in the order of least recently used to most recently used.\n\t *\n\t * @returns {IterableIterator<V>} An iterator over the values in the cache.\n\t */\n\tvalues(): IterableIterator<V> {\n\t\treturn this.cache.values();\n\t}\n\n\t/**\n\t * Returns an iterator over the entries in the cache.\n\t * The entries are returned in the order of least recently used to most recently used.\n\t *\n\t * @returns {IterableIterator<[K, V]>} An iterator over the entries in the cache.\n\t */\n\tentries(): IterableIterator<[K, V]> {\n\t\treturn this.cache.entries();\n\t}\n\n\t/**\n\t * Returns an iterator over the entries in the cache.\n\t * The entries are returned in the order of least recently used to most recently used.\n\t *\n\t * @returns {IterableIterator<[K, V]>} An iterator over the entries in the cache.\n\t */\n\t[Symbol.iterator](): IterableIterator<[K, V]> {\n\t\treturn this.entries();\n\t}\n\n\t/**\n\t * Gets the description of the object.\n\t *\n\t * @override\n\t * @returns {string} The description of the object.\n\t */\n\tget [Symbol.toStringTag](): string {\n\t\treturn 'EvictingCache';\n\t}\n\n\t/**\n\t * Puts a key-value pair into the cache and evicts the least recently used item if necessary.\n\t * If the key already exists, the item is removed and re-added to update its position.\n\t * If the cache is full, the least recently used item is evicted and the new item is added.\n\t * @param {K} key The key to put.\n\t * @param {V} value The value to put.\n\t * @returns {V} The value that was put.\n\t */\n\tprivate putAndEvict(key: K, value: V): V {\n\t\tconst existed = this.cache.delete(key);\n\t\tif (!existed && this._capacity <= this.cache.size) { this.evict() }\n\n\t\tthis.cache.set(key, value);\n\n\t\treturn value;\n\t}\n}"],
+  "mappings": "AAOO,IAAMA,EAAN,KAA0B,CACf,UACA,MACT,KAAO,EACP,OAAS,EAOjB,YAAYC,EAAmB,IAAK,CACnC,GAAIA,EAAW,EAAK,MAAM,IAAI,WAAW,iCAAiC,EAC1E,GAAI,CAAC,OAAO,UAAUA,CAAQ,EAAK,MAAM,IAAI,WAAW,6BAA6B,EAErF,KAAK,UAAYA,EACjB,KAAK,MAAQ,IAAI,GAClB,CAQA,IAAIC,EAAkB,CACrB,IAAMC,EAAQ,KAAK,MAAM,IAAID,CAAG,EAChC,OAAIC,IAAU,QACb,KAAK,SACE,OAGR,KAAK,OACL,KAAK,MAAM,OAAOD,CAAG,EAErB,KAAK,MAAM,IAAIA,EAAKC,CAAK,EAElBA,EACR,CAQA,IAAID,EAAiB,CACpB,OAAO,KAAK,MAAM,IAAIA,CAAG,CAC1B,CAUA,IAAIA,EAAQC,EAAgB,CAC3B,KAAK,YAAYD,EAAKC,CAAK,CAC5B,CAQA,OAAOD,EAAiB,CACvB,OAAO,KAAK,MAAM,OAAOA,CAAG,CAC7B,CAQA,KAAKA,EAAkB,CACtB,OAAO,KAAK,MAAM,IAAIA,CAAG,GAAK,IAC/B,CAUA,SAASA,EAAQE,EAAsB,CACtC,IAAMC,EAAW,KAAK,IAAIH,CAAG,EAC7B,GAAIG,IAAa,KAAQ,OAAOA,EAGhC,IAAMF,EAAQC,EAAS,EACvB,OAAO,KAAK,YAAYF,EAAKC,CAAK,CACnC,CAMA,OAAiB,CAChB,IAAMG,EAAa,KAAK,MAAM,KAAK,EAAE,KAAK,EAC1C,OAAIA,EAAW,KAAe,GAEvB,KAAK,MAAM,OAAOA,EAAW,KAAK,CAC1C,CAMA,OAAc,CACb,KAAK,MAAM,MAAM,CAClB,CAQA,QAAQC,EAAoEC,EAAyB,CACpG,IAAMC,EAAgBD,IAAY,OAAYD,EAAW,KAAKC,CAAO,EAAID,EACzE,KAAK,MAAM,QAAQ,CAACJ,EAAOD,IAAQO,EAAcN,EAAOD,EAAK,IAAI,CAAC,CACnE,CAQA,OAAOQ,EAAiC,CACvC,OAAW,CAACR,EAAKC,CAAK,IAAKO,EAAW,KAAK,IAAIR,EAAKC,CAAK,CAC1D,CASA,OAAOQ,EAA8B,CACpC,IAAMC,EAAS,IAAI,IACnB,QAAWV,KAAOS,EAAM,CACvB,IAAMR,EAAQ,KAAK,IAAID,CAAG,EACtBC,IAAU,MAAQS,EAAO,IAAIV,EAAKC,CAAK,CAC5C,CAEA,OAAOS,CACR,CAQA,UAAUD,EAA2B,CACpC,IAAIE,EAAQ,EACZ,QAAWX,KAAOS,EACb,KAAK,MAAM,OAAOT,CAAG,GAAKW,IAG/B,OAAOA,CACR,CAOA,UAAuB,CACtB,IAAMC,EAAQ,KAAK,KAAO,KAAK,OAE/B,MAAO,CAAE,KAAM,KAAK,KAAM,OAAQ,KAAK,OAAQ,QAASA,IAAU,EAAI,EAAI,KAAK,KAAOA,CAAM,CAC7F,CAOA,YAAmB,CAClB,KAAK,KAAO,EACZ,KAAK,OAAS,CACf,CAUA,IAAI,UAAmB,CACtB,OAAO,KAAK,SACb,CAYA,IAAI,MAAe,CAClB,OAAO,KAAK,MAAM,IACnB,CAQA,MAA4B,CAC3B,OAAO,KAAK,MAAM,KAAK,CACxB,CAQA,QAA8B,CAC7B,OAAO,KAAK,MAAM,OAAO,CAC1B,CAQA,SAAoC,CACnC,OAAO,KAAK,MAAM,QAAQ,CAC3B,CAQA,CAAC,OAAO,QAAQ,GAA8B,CAC7C,OAAO,KAAK,QAAQ,CACrB,CAQA,IAAK,OAAO,WAAW,GAAY,CAClC,MAAO,eACR,CAUQ,YAAYZ,EAAQC,EAAa,CAExC,MAAI,CADY,KAAK,MAAM,OAAOD,CAAG,GACrB,KAAK,WAAa,KAAK,MAAM,MAAQ,KAAK,MAAM,EAEhE,KAAK,MAAM,IAAIA,EAAKC,CAAK,EAElBA,CACR,CACD",
+  "names": ["EvictingCache", "capacity", "key", "value", "producer", "existing", "firstEntry", "callbackfn", "thisArg", "boundCallback", "entries", "keys", "result", "count", "total"]
+}

package/package.json

@@ -1,14 +1,30 @@
 {
   "name": "evicting-cache",
   "author": "D1g1talEntr0py",
-  "version": "3.0.1",
-  "packageManager": "pnpm@10.30.3",
+  "version": "3.0.3",
   "license": "ISC",
   "description": "Cache implementation with an LRU evicting policy",
+  "homepage": "https://github.com/D1g1talEntr0py/evicting-cache#readme",
   "repository": {
     "type": "git",
     "url": "https://github.com/D1g1talEntr0py/evicting-cache"
   },
+  "bugs": {
+    "url": "https://github.com/D1g1talEntr0py/evicting-cache/issues"
+  },
+  "maintainers": [
+    {
+      "name": "D1g1talEntr0py",
+      "email": "jason.dimeo@gmail.com"
+    }
+  ],
+  "engines": {
+    "node": ">=20.16.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
   "type": "module",
   "exports": {
     ".": {
@@ -18,47 +34,47 @@
   },
   "files": [
     "dist/",
-    "src/"
-  ],
-  "scripts": {
-    "build": "tsbuild",
-    "build:watch": "tsbuild --watch",
-    "type-check": "tsbuild --noEmit",
-    "lint": "eslint",
-    "test": "vitest run",
-    "test:coverage": "vitest run --coverage",
-    "test:watch": "vitest",
-    "prepublish": "pnpm lint && pnpm test && pnpm -s build --minify --force",
-    "preversion": "pnpm lint && pnpm test",
-    "version": "node -e \"const fs=require('fs');const d=new Date().toISOString().split('T')[0];const v=require('./package.json').version;let c=fs.readFileSync('CHANGELOG.md','utf8');c=c.replace('## [Unreleased]','## ['+v+'] - '+d);fs.writeFileSync('CHANGELOG.md',c);\" && git add CHANGELOG.md"
-  },
-  "keywords": [
-    "cache",
-    "evicting-cache",
-    "lru",
-    "lru-cache",
-    "evicting-lru-cache"
+    "src/",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
   ],
   "devDependencies": {
-    "@d1g1tal/tsbuild": "^1.3.2",
-    "@eslint/compat": "^2.0.2",
+    "@d1g1tal/tsbuild": "^1.6.0",
+    "@eslint/compat": "^2.0.3",
     "@eslint/js": "^10.0.1",
     "@types/eslint": "^9.6.1",
-    "@types/node": "^25.3.3",
-    "@typescript-eslint/eslint-plugin": "^8.56.1",
-    "@typescript-eslint/parser": "^8.56.1",
-    "@vitest/coverage-v8": "^4.0.18",
-    "eslint": "^10.0.2",
-    "eslint-plugin-compat": "^7.0.0",
-    "eslint-plugin-jsdoc": "^62.7.1",
+    "@types/node": "^25.5.0",
+    "@typescript-eslint/eslint-plugin": "^8.57.1",
+    "@typescript-eslint/parser": "^8.57.1",
+    "@vitest/coverage-v8": "^4.1.0",
+    "eslint": "^10.0.3",
+    "eslint-plugin-compat": "^7.0.1",
+    "eslint-plugin-jsdoc": "^62.8.0",
     "globals": "^17.4.0",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.56.1",
-    "vitest": "^4.0.18"
+    "typescript-eslint": "^8.57.1",
+    "vitest": "^4.1.0"
   },
   "browserslist": [
     "defaults",
     "not ios_saf < 15",
     "not op_mini all"
-  ]
-}
+  ],
+  "keywords": [
+    "cache",
+    "evicting-cache",
+    "lru",
+    "lru-cache",
+    "evicting-lru-cache"
+  ],
+  "scripts": {
+    "build": "tsbuild",
+    "build:watch": "tsbuild --watch",
+    "type-check": "tsbuild --noEmit",
+    "lint": "eslint ./src",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest"
+  }
+}