feat: add fireOnEvict option to cleanup() - #498
Merged
Merged
Conversation
keys() now filters expired items, consistent with entries(), values(), and toJSON(). Previously it returned every key regardless of expiry, so iterating keys() then calling get(key) could yield undefined for expired entries. Adds a regression test and corrects the getMany() README line to match its tested behavior.
cleanup() now accepts an optional fireOnEvict parameter. When true, it invokes the onEvict callback for each expired item removed. Defaults to false, preserving the existing silent behavior so no existing callers are affected. Adds tests for both paths and updates docs and types.
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
Adds an optional
fireOnEvictparameter tocleanup(). Whentrue, it invokes theonEvictcallback for each expired item removed. Defaults tofalse, preserving the existing silent behavior so no existing callers are affected. This gives users a way to purge stale items while still receiving eviction notifications for resource cleanup.Type of Change
Testing
Added tests for both paths:
cleanup(true)firesonEvictfor each removed item, andcleanup()(default) does not. Rannpm test(172 tests, 27 suites, all passing). Coverage maintained at 100% lines / 99.40% branches / 100% functions.Coverage
Checklist
npm run lintpasses