jellydator / ttlcache / 12139686373

100%

master: 100%

push

github

feat: New `WithMaxCost` option for custom cache capacity management strategies

* new option to define the max memory the cache can use in bytes

* cache.set updated to cope with memory limitations

* options updated to implement the suggested new option

* cache impl updated + tests

* dependencies updated

* imports organized

* readme updated to document the new configuration option

* better explanation in the example

* readme line removed by accident restored

* function renamed (typo fixed)

* wording fixed

* useless sentence removed

* costs renamed to cost

* cost used in tests simplified

* CostCalcFunc renamed to CostFunc

* costsCalcFunc renamed to costFunc

* updateExpirations moved

* totalCost renamed to maxCost

* WithTotalCost option renamed to WithMaxCost

* example in README updated

* signature of the WithMaxCost option changed

* readme updated

* Item impl updated to hold the current cost and the corresponding cost calculation function; new constructor expecting options

* cache impl updated to make use of the new item properties

* new item options

* tests for the new options

* new Item related tests

* cache tests fixed to make them compile

* item option implementation updated to become a private interface

* cache set test updated

* made new item related functions private + eviction reason renamed

* moved initial item cost calsulation to the constructor function

* test functions renamed to reflect the private nature of functions under test

* version tracking fixed

* small readme update

53 of 53 new or added lines in 3 files covered. (100.0%)

680 of 682 relevant lines covered (99.71%)

23.64 hits per line