Skip to content

Commit f2fc84b

Browse files
committed
docs: Document getMany() side effects
- getMany() calls get() for each key - Updates LRU order (items move to MRU position) - Removes expired items (affects stats: hits, misses, deletes) - Clarify this is not a read-only operation
1 parent 5bad7e5 commit f2fc84b

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ Expired items are deleted and return `undefined`.
324324

325325
### `getMany(keys)`
326326

327-
Batch retrieves multiple items.
327+
Batch retrieves multiple items. Calls `get()` for each key, so it updates LRU order and may remove expired items.
328328

329329
```javascript
330330
cache.set("a", 1).set("b", 2).set("c", 3);
@@ -340,7 +340,7 @@ console.log(result); // { a: 1, c: 3 }
340340

341341
**Returns:** `Object` - Object mapping keys to values (undefined for missing/expired keys)
342342

343-
**Note:** Returns `undefined` for non-existent or expired keys.
343+
**Note:** Returns `undefined` for non-existent or expired keys. This method is NOT read-only - it updates LRU order (items move to most recently used) and may delete expired items, affecting `hits`, `misses`, and `deletes` stats.
344344

345345
---
346346

0 commit comments

Comments
 (0)