refactor: simplify set() and setWithEvicted() API by removing resetTtl parameter

Author: avoidwork

coverage.txt

@@ -3,8 +3,8 @@
 ℹ file      | line % | branch % | funcs % | uncovered lines
 ℹ ----------------------------------------------------------
 ℹ src       |        |          |         | 
-ℹ  lru.js   | 100.00 |    94.67 |  100.00 | 
+ℹ  lru.js   |  99.60 |    93.15 |  100.00 | 342-343
 ℹ ----------------------------------------------------------
-ℹ all files | 100.00 |    94.67 |  100.00 | 
+ℹ all files |  99.60 |    93.15 |  100.00 | 
 ℹ ----------------------------------------------------------
 ℹ end of coverage report

docs/API.md

@@ -288,7 +288,7 @@ console.log(cache.keys()); // ['b', 'c', 'a']
 
 ---
 
-### `set(key, value, bypass?, resetTtl?)`
+### `set(key, value)`
 
 Stores value and moves to most recently used.
 
@@ -299,18 +299,16 @@ console.log(cache.keys()); // ['a', 'b', 'c']
 
 **Parameters:**
 
-| Name       | Type      | Default         | Description                        |
-| ---------- | --------- | --------------- | ---------------------------------- |
-| `key`      | `string`  | -               | Item key                           |
-| `value`    | `*`       | -               | Item value                         |
-| `bypass`   | `boolean` | `false`         | Internal flag for `setWithEvicted` |
-| `resetTtl` | `boolean` | `this.resetTtl` | Reset TTL for this operation       |
+| Name  | Type  | Description |
+| ----- | ----- | ----------- |
+| `key` | `string` | Item key |
+| `value` | `*` | Item value |
 
 **Returns:** `LRU` - this instance (for chaining)
 
 ---
 
-### `setWithEvicted(key, value, resetTtl?)`
+### `setWithEvicted(key, value)`
 
 Stores value and returns evicted item if cache was full.
 
@@ -325,11 +323,10 @@ console.log(cache.keys()); // ['b', 'c']
 
 **Parameters:**
 
-| Name       | Type      | Default         | Description                  |
-| ---------- | --------- | --------------- | ---------------------------- |
-| `key`      | `string`  | -               | Item key                     |
-| `value`    | `*`       | -               | Item value                   |
-| `resetTtl` | `boolean` | `this.resetTtl` | Reset TTL for this operation |
+| Name  | Type  | Description |
+| ----- | ----- | ----------- |
+| `key` | `string` | Item key |
+| `value` | `*` | Item value |
 
 **Returns:** `{ key, value, expiry } | null` - Evicted item or null
 

docs/TECHNICAL_DOCUMENTATION.md

@@ -159,17 +159,17 @@ The LRU cache maintains a doubly-linked list $L$ and a hash table $H$ for O(1) o
 
 **Note:** The mathematical notation uses `create(k, v)` to represent the item creation logic that is inline in the actual implementation.
 
-#### Set Operation: $set(k, v, bypass = false, resetTtl = resetTtl) \rightarrow \text{LRU}$
+#### Set Operation: $set(k, v) \rightarrow \text{LRU}$
 
 $$
 \begin{align}
-set(k, v, bypass, resetTtl) &= \begin{cases}
-update(k, v, bypass, resetTtl) & \text{if } k \in H \\
+set(k, v) &= \begin{cases}
+update(k, v) & \text{if } k \in H \\
 insert(k, v) & \text{if } k \notin H
 \end{cases} \\
-update(k, v, bypass, resetTtl) &= H[k].value \leftarrow v \land moveToEnd(H[k]) \\
+update(k, v) &= H[k].value \leftarrow v \land moveToEnd(H[k]) \\
 & \quad \land \begin{cases}
-H[k].expiry \leftarrow t_{now} + ttl & \text{if } bypass = false \land resetTtl = true \land ttl > 0 \\
+H[k].expiry \leftarrow t_{now} + ttl & \text{if } resetTtl = true \land ttl > 0 \\
 \text{no-op} & \text{otherwise}
 \end{cases} \\
 insert(k, v) &= \begin{cases}
@@ -187,16 +187,16 @@ $$
 
 **Time Complexity:** $O(1)$ amortized
 
-#### Set With Evicted Operation: $setWithEvicted(k, v, resetTtl = resetTtl) \rightarrow \{key: K, value: V, expiry: \mathbb{N}_0\} \cup \{\bot\}$
+#### Set With Evicted Operation: $setWithEvicted(k, v) \rightarrow \{key: K, value: V, expiry: \mathbb{N}_0\} \cup \{\bot\}$
 
 $$
 \begin{align}
-setWithEvicted(k, v, resetTtl) &= \begin{cases}
-update(k, v, resetTtl) \land \bot & \text{if } k \in H \\
+setWithEvicted(k, v) &= \begin{cases}
+update(k, v) \land \bot & \text{if } k \in H \\
 evicted \land create(k, v) & \text{if } k \notin H \land max > 0 \land size = max \\
 \bot \land create(k, v) & \text{if } k \notin H \land (max = 0 \lor size < max)
 \end{cases} \\
-update(k, v, resetTtl) &= H[k].value \leftarrow v \land moveToEnd(H[k]) \\
+update(k, v) &= H[k].value \leftarrow v \land moveToEnd(H[k]) \\
 & \quad \land \begin{cases}
 H[k].expiry \leftarrow t_{now} + ttl & \text{if } resetTtl = true \land ttl > 0 \\
 \text{no-op} & \text{otherwise}
@@ -208,8 +208,6 @@ H[k].expiry \leftarrow t_{now} + ttl & \text{if } resetTtl = true \land ttl > 0
 \end{align}
 $$
 
-**Note:** Unlike `set()`, `setWithEvicted()` does not use a `bypass` parameter, so TTL is reset when `resetTtl = true`.
-
 **Time Complexity:** $O(1)$ amortized
 
 #### Get Operation: $get(k) \rightarrow V \cup \{\bot\}$
@@ -289,9 +287,8 @@ $$
 
 **TTL Reset Behavior:**
 
-- TTL is only reset during `set()` operations when `resetTtl = true` and `bypass = false`
+- TTL is reset during `set()` and `setWithEvicted()` operations when `resetTtl = true`
 - `get()` operations never reset TTL, regardless of the `resetTtl` setting
-- `setWithEvicted()` operations reset TTL when `resetTtl = true` (does not use bypass parameter)
 
 ### Space Complexity
 
@@ -341,12 +338,8 @@ export class LRU<T> {
 	get(key: any): T | undefined;
 	has(key: any): boolean;
 	keys(): any[];
-	set(key: any, value: T, bypass?: boolean, resetTtl?: boolean): this;
-	setWithEvicted(
-		key: any,
-		value: T,
-		resetTtl?: boolean,
-	): { key: any; value: T; expiry: number } | null;
+	set(key: any, value: T): this;
+	setWithEvicted(key: any, value: T): { key: any; value: T; expiry: number } | null;
 	values(keys?: any[]): T[];
 }
 

src/lru.js

@@ -323,7 +323,6 @@ export class LRU {
 	 * @memberof LRU
 	 * @param {string} key - The key to set.
 	 * @param {*} value - The value to store.
-	 * @param {boolean} [resetTtl=this.resetTtl] - Whether to reset the TTL for this operation.
 	 * @returns {Object|null} The evicted item (if any) with shape {key, value, expiry, prev, next}, or null.
 	 * @example
 	 * const cache = new LRU(2);
@@ -333,13 +332,13 @@ export class LRU {
 	 * @see {@link LRU#evict}
 	 * @since 11.3.0
 	 */
-	setWithEvicted(key, value, resetTtl = this.resetTtl) {
+	setWithEvicted(key, value) {
 		let evicted = null;
 		let item = this.items[key];
 
 		if (item !== undefined) {
 			item.value = value;
-			if (resetTtl) {
+			if (this.resetTtl) {
 				item.expiry = this.ttl > 0 ? Date.now() + this.ttl : this.ttl;
 			}
 			this.moveToEnd(item);
@@ -380,7 +379,6 @@ export class LRU {
 	 * @memberof LRU
 	 * @param {string} key - The key to set.
 	 * @param {*} value - The value to store.
-	 * @param {boolean} [resetTtl=this.resetTtl] - Whether to reset the TTL for this operation.
 	 * @returns {LRU} The LRU instance for method chaining.
 	 * @example
 	 * cache.set('key1', 'value1')
@@ -390,13 +388,13 @@ export class LRU {
 	 * @see {@link LRU#setWithEvicted}
 	 * @since 1.0.0
 	 */
-	set(key, value, resetTtl = this.resetTtl) {
+	set(key, value) {
 		let item = this.items[key];
 
 		if (item !== undefined) {
 			item.value = value;
 
-			if (resetTtl) {
+			if (this.resetTtl) {
 				item.expiry = this.ttl > 0 ? Date.now() + this.ttl : this.ttl;
 			}