evicting-cache 3.0.3 → 3.0.4

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [3.0.4](https://github.com/D1g1talEntr0py/evicting-cache/compare/v3.0.3...v3.0.4) (2026-03-16)
+
+### Bug Fixes
+
+* **release:** updated invalid node version (7d2273211f13e5369698bfe2cb8d4455c5798c98)
+
+### Miscellaneous Chores
+
+* fix license (62279e557ef3289fcdaf693abc9bcb6d9c9499c0)
+* **publish:** remove /src folder from package (0d5fd5302b50ac7013cd7fee88d311a5dac2e389)
+
 ## [3.0.3](https://github.com/D1g1talEntr0py/evicting-cache/compare/v3.0.2...v3.0.3) (2026-03-16)
 
 ### Bug Fixes

package/LICENSE

@@ -1,12 +1,7 @@
-Copyright (c) 2023, Jason DiMeo
+ISC License
 
-Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided
-that the above copyright notice and this permission notice appear in all copies.
+Copyright (c) 2023, Jason DiMeo
 
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
-INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE
-FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
-ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
 
-Source: http://opensource.org/licenses/ISC
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "evicting-cache",
   "author": "D1g1talEntr0py",
-  "version": "3.0.3",
+  "version": "3.0.4",
   "license": "ISC",
   "description": "Cache implementation with an LRU evicting policy",
   "homepage": "https://github.com/D1g1talEntr0py/evicting-cache#readme",
@@ -34,7 +34,6 @@
   },
   "files": [
     "dist/",
-    "src/",
     "README.md",
     "CHANGELOG.md",
     "LICENSE"

package/src/evicting-cache.ts

@@ -1,292 +0,0 @@
-type CacheStats = {
-	hits: number;
-	misses: number;
-	hitRate: number;
-};
-
-/** JavaScript implementation of a Least Recently Used(LRU) Cache using a Map. */
-export class EvictingCache<K, V> {
-	private readonly _capacity: number;
-	private readonly cache: Map<K, V>;
-	private hits = 0;
-	private misses = 0;
-
-	/**
-	 * 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 = 100) {
-		if (capacity < 1) { throw new RangeError('capacity must be greater than 0') }
-		if (!Number.isInteger(capacity)) { throw new RangeError('capacity must be an integer') }
-
-		this._capacity = capacity;
-		this.cache = new Map();
-	}
-
-	/**
-	 * 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 {
-		const value = this.cache.get(key);
-		if (value === undefined) {
-			this.misses++;
-			return null;
-		}
-
-		this.hits++;
-		this.cache.delete(key);
-		// Move the accessed item to the end (most recently used)
-		this.cache.set(key, value);
-
-		return value;
-	}
-
-	/**
-	 * 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 {
-		return this.cache.has(key);
-	}
-
-	/**
-	 * 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 {
-		this.putAndEvict(key, value);
-	}
-
-	/**
-	 * 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 {
-		return this.cache.delete(key);
-	}
-
-	/**
-	 * 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 {
-		return this.cache.get(key) ?? 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 {
-		const existing = this.get(key);
-		if (existing !== null) { return existing }
-
-		// If producer throws, cache state remains unchanged
-		const value = producer();
-		return this.putAndEvict(key, value);
-	}
-
-	/**
-	 * Removes the least recently used key-value pair from the cache.
-	 * @returns {boolean} True if an item was removed, false otherwise.
-	 */
-	evict(): boolean {
-		const firstEntry = this.cache.keys().next();
-		if (firstEntry.done) { return false }
-
-		return this.cache.delete(firstEntry.value);
-	}
-
-	/**
-	 * Clears the cache and the LRU list.
-	 * @returns {void}
-	 */
-	clear(): void {
-		this.cache.clear();
-	}
-
-	/**
-	 * 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 {
-		const boundCallback = thisArg !== undefined ? callbackfn.bind(thisArg) : callbackfn;
-		this.cache.forEach((value, key) => boundCallback(value, key, this));
-	}
-
-	/**
-	 * 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 {
-		for (const [key, value] of entries) { this.put(key, value) }
-	}
-
-	/**
-	 * 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> {
-		const result = new Map<K, V>();
-		for (const key of keys) {
-			const value = this.get(key);
-			if (value !== null) { result.set(key, value) }
-		}
-
-		return result;
-	}
-
-	/**
-	 * 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 {
-		let count = 0;
-		for (const key of keys) {
-			if (this.cache.delete(key)) { count++ }
-		}
-
-		return count;
-	}
-
-	/**
-	 * Gets cache statistics including hit/miss counts and hit rate.
-	 *
-	 * @returns {CacheStats} Cache statistics.
-	 */
-	getStats(): CacheStats {
-		const total = this.hits + this.misses;
-
-		return { hits: this.hits, misses: this.misses, hitRate: total === 0 ? 0 : this.hits / total };
-	}
-
-	/**
-	 * Resets cache statistics to zero.
-	 *
-	 * @returns {void}
-	 */
-	resetStats(): void {
-		this.hits = 0;
-		this.misses = 0;
-	}
-
-	/**
-	 * 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 {
-		return this._capacity;
-	}
-
-	/**
-	 * 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 {
-		return this.cache.size;
-	}
-
-	/**
-	 * 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> {
-		return this.cache.keys();
-	}
-
-	/**
-	 * 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> {
-		return this.cache.values();
-	}
-
-	/**
-	 * 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]> {
-		return this.cache.entries();
-	}
-
-	/**
-	 * 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]> {
-		return this.entries();
-	}
-
-	/**
-	 * Gets the description of the object.
-	 *
-	 * @override
-	 * @returns {string} The description of the object.
-	 */
-	get [Symbol.toStringTag](): string {
-		return 'EvictingCache';
-	}
-
-	/**
-	 * 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(key: K, value: V): V {
-		const existed = this.cache.delete(key);
-		if (!existed && this._capacity <= this.cache.size) { this.evict() }
-
-		this.cache.set(key, value);
-
-		return value;
-	}
-}