docs: correct README, API docs, and type definitions - #497
Merged
Merged
Conversation
- Fix constructor validation claim (LRU validates params, throws TypeError) - Correct onEvict to fire only on evict()/set(), not setWithEvicted() - Refresh test/suite counts (169/27) and branch coverage (99.39%) - Reconcile comparison table with measured min+gzip bundle sizes - Remove off-base lru-cache 2x claim; attribute dual-cache to quick-lru - Replace Security section with pointer to Technical Documentation - Add items property, clarify peek()/getMany()/keys() behavior
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Corrects factual errors and stale data in the README, API docs, and TypeScript definitions. Fixes the constructor validation claim (LRU validates params and throws TypeError), corrects
onEvictto fire only onevict()/set()(notsetWithEvicted()), refreshes test/suite counts (169/27) and branch coverage (99.39%), and reconciles the comparison table with measured min+gzip bundle sizes. Removes the off-base lru-cache "2x size" claim and attributes the dual-cache design to quick-lru. Replaces the Security section with a pointer to the Technical Documentation.Type of Change
Testing
Ran
npm run lint(0 warnings, 0 errors) andnpm test(169 tests, 27 suites, all passing). Coverage maintained at 100% lines / 99.39% branches / 100% functions.Coverage
Checklist
npm run lintpasses