@isaacs/ttlcache 1.2.1 → 1.3.0

package/README.md

@@ -53,9 +53,9 @@ where the `setTimeout` method does not return an object with an
 `unref()` method, the process will stay open as long as any
 unexpired entry exists in the cache.
 
-You may delete all entries (by using `cache.clear()` or
-`cache.delete(key)` with every key) in order to clear the
-timeouts and allow the process to exit normally.
+You may call `cache.cancelTimer()` to clear the timeout and
+allow the process to exit normally. Be advised that canceling the
+timer in this way will of course prevent anything from expiring.
 
 ## API
 
@@ -164,6 +164,14 @@ latest expiring.
 Return an iterator that walks through each `value` from soonest expiring to
 latest expiring.
 
+### `cache.cancelTimer()`
+
+Clear the internal timer, and stop automatically expiring items
+when their TTL expires.
+
+This allows the process to exit normally on Deno and other
+platforms that lack Node's `Timer.unref()` method.
+
 ## Internal Methods
 
 You should not ever call these, they are managed automatically.
@@ -188,6 +196,13 @@ automatically.
 Called when an item is removed from the cache and should be disposed.  Set
 this on the constructor options.
 
+### `setTimer`
+
+**Internal**
+
+Called when an with a ttl is added. This ensures that only one timer
+is setup at once. Called automatically.
+
 ## Algorithm
 
 The cache uses two `Map` objects.  The first maps item keys to their

package/index.d.ts

@@ -86,10 +86,17 @@ declare class TTLCache<K, V> implements Iterable<[K, V]> {
    * `cache.entries()`
    */
   public [Symbol.iterator](): Iterator<[K, V]>
+
+  /**
+   * Cancel the timer and stop automatically expiring entries.
+   * This allows the process to gracefully exit where Timer.unref()
+   * is not available.
+   */
+  public cancelTimer(): void
 }
 
 declare namespace TTLCache {
-  type DisposeReason = 'evict' | 'set' | 'delete'
+  type DisposeReason = 'evict' | 'set' | 'delete' | 'stale'
 
   type Disposer<K, V> = (
     value: V,

package/index.js

@@ -3,12 +3,14 @@
 // Relies on the fact that integer Object keys are kept sorted,
 // and managed very efficiently by V8.
 
+/* istanbul ignore next */
 const perf =
   typeof performance === 'object' &&
   performance &&
   typeof performance.now === 'function'
     ? performance
     : Date
+
 const now = () => perf.now()
 const isPosInt = n => n && n === Math.floor(n) && n > 0 && isFinite(n)
 const isPosIntOrInf = n => n === Infinity || isPosInt(n)
@@ -48,19 +50,54 @@ class TTLCache {
       this.dispose = dispose
     }
 
-    this.timers = new Set()
+    this.timer = undefined
+    this.timerExpiration = undefined
+  }
+
+  setTimer (expiration, ttl) {
+    if (this.timerExpiration < expiration) {
+      return
+    }
+
+    if (this.timer) {
+      clearTimeout(this.timer)
+    }
+
+    const t = setTimeout(() => {
+      this.timer = undefined
+      this.timerExpiration = undefined
+      this.purgeStale()
+      for (const exp in this.expirations) {
+        this.setTimer(exp, exp - now())
+        break
+      }
+    }, ttl)
+
+    /* istanbul ignore else - affordance for non-node envs */
+    if (t.unref) t.unref()
+
+    this.timerExpiration = expiration
+    this.timer = t
   }
 
   // hang onto the timer so we can clearTimeout if all items
   // are deleted.  Deno doesn't have Timer.unref(), so it
   // hangs otherwise.
-  cancelTimers() {
-    for (const t of this.timers) {
-      clearTimeout(t)
-      this.timers.delete(t)
+  cancelTimer() {
+    if (this.timer) {
+      clearTimeout(this.timer)
+      this.timerExpiration = undefined
+      this.timer = undefined
     }
   }
 
+  /* istanbul ignore next */
+  cancelTimers() {
+    process.emitWarning('TTLCache.cancelTimers has been renamed to ' +
+      'TTLCache.cancelTimer (no "s"), and will be removed in the next ' +
+      'major version update')
+    return this.cancelTimer()
+  }
 
   clear() {
     const entries =
@@ -68,7 +105,7 @@ class TTLCache {
     this.data.clear()
     this.expirationMap.clear()
     // no need for any purging now
-    this.cancelTimers()
+    this.cancelTimer()
     this.expirations = Object.create(null)
     for (const [key, val] of entries) {
       this.dispose(val, key, 'delete')
@@ -91,14 +128,8 @@ class TTLCache {
       const expiration = Math.floor(now() + ttl)
       this.expirationMap.set(key, expiration)
       if (!this.expirations[expiration]) {
-        const t = setTimeout(() => {
-          this.timers.delete(t)
-          this.purgeStale()
-        }, ttl)
-        /* istanbul ignore else - affordance for non-node envs */
-        if (t.unref) t.unref()
-        this.timers.add(t)
         this.expirations[expiration] = []
+        this.setTimer(expiration, ttl)
       }
       this.expirations[expiration].push(key)
     } else {
@@ -184,7 +215,7 @@ class TTLCache {
       }
       this.dispose(value, key, 'delete')
       if (this.size === 0) {
-        this.cancelTimers()
+        this.cancelTimer()
       }
       return true
     }
@@ -244,7 +275,7 @@ class TTLCache {
       }
     }
     if (this.size === 0) {
-      this.cancelTimers()
+      this.cancelTimer()
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isaacs/ttlcache",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "files": [
     "index.js",
     "index.d.ts"