Cache with time-to-keep expiry

.github/workflows/tests.yml

@@ -3,15 +3,19 @@ name: Tests
 on: [push, pull_request]
 
 jobs:
+
   tests:
     strategy:
       matrix:
+        # npm will not run under 10.x or earlier and so they cannot be tested
         node-version:
             - 12.x
             - 13.x
             - 14.x
             - 15.x
             - 16.x
+            - 18.x
+            - latest
 
     runs-on: ubuntu-latest
 

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.40.0
+
+* Adding `#isEqual` to Set helpers (@mrflip). (provisional)
+
 ## 0.39.2
 
 * Fixing typings of low-level structure consuming methods (@jerome-benoit).

index.d.ts

@@ -27,6 +27,7 @@ export {default as KDTree} from './kd-tree';
 export {default as LinkedList} from './linked-list';
 export {default as LRUCache} from './lru-cache';
 export {default as LRUCacheWithDelete} from './lru-cache-with-delete';
+export {default as LRUCacheWithExpiry} from './lru-cache-with-expiry';
 export {default as LRUMap} from './lru-map';
 export {default as LRUMapWithDelete} from './lru-map-with-delete';
 export {default as MultiMap} from './multi-map';

index.js

@@ -36,6 +36,7 @@ module.exports = {
   LinkedList: require('./linked-list.js'),
   LRUCache: require('./lru-cache.js'),
   LRUCacheWithDelete: require('./lru-cache-with-delete.js'),
+  LRUCacheWithExpiry: require('./lru-cache-with-expiry.js'),
   LRUMap: require('./lru-map.js'),
   LRUMapWithDelete: require('./lru-map-with-delete.js'),
   MultiMap: require('./multi-map.js'),

lru-cache-with-delete.js

@@ -35,8 +35,21 @@ function LRUCacheWithDelete(Keys, Values, capacity) {
 
 for (var k in LRUCache.prototype)
   LRUCacheWithDelete.prototype[k] = LRUCache.prototype[k];
-if (typeof Symbol !== 'undefined')
+
+/**
+ * If possible, attaching the
+ * * #.entries method to Symbol.iterator (allowing `for (const foo of cache) { ... }`)
+ * * the summaryString method to Symbol.toStringTag (allowing `\`${cache}\`` to work)
+ * * the inspect method to Symbol.for('nodejs.util.inspect.custom') (making `console.log(cache)` liveable)
+ */
+if (typeof Symbol !== 'undefined') {
   LRUCacheWithDelete.prototype[Symbol.iterator] = LRUCache.prototype[Symbol.iterator];
+  Object.defineProperty(LRUCacheWithDelete.prototype, Symbol.toStringTag, {
+    get: function () { return `${this.constructor.name}:${this.size}/${this.capacity}`; },
+  });
+  LRUCacheWithDelete.prototype[Symbol.for('nodejs.util.inspect.custom')] = LRUCache.prototype.inspect;
+}
+Object.defineProperty(LRUCacheWithDelete.prototype, 'summary', Object.getOwnPropertyDescriptor(LRUCache.prototype, 'summary'));
 
 /**
  * Method used to clear the structure.

lru-cache-with-expiry.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Mnemonist LRUCacheWithExpiry Typings
+ * =====================================
+ */
+import LRUCacheWithDelete from './lru-cache-with-delete';
+
+export interface Logger {
+  trace(message: string, story: any): void
+  debug(message: string, story: any): void
+  info(message:  string, story: any): void
+  warn(message:  string, story: any): void
+  error(message: string, story: any): void
+}
+
+export default class LRUCacheWithExpiry<K, V> extends LRUCacheWithDelete<K, V> {
+
+  expire(): void;
+
+  monitor(interval: number, options: {
+    logger: Logger,
+    didError: (err: Error, inst: LRUCacheWithExpiry<K, V>) => boolean,
+    didExpire: (inst: LRUCacheWithExpiry<K, V>, begT: number) => void,
+  }): void;
+}