@isaacs/ttlcache 1.2.0 → 1.2.2

package/README.md

@@ -29,7 +29,7 @@ Custom size calculation is not supported.  Max capacity is simply the count
 of items in the cache.
 
 ```js
-const TTLCache = require('ttlcache')
+const TTLCache = require('@isaacs/ttlcache')
 const cache = new TTLCache({ max: 10000, ttl: 1000 })
 
 // set some value
@@ -44,13 +44,26 @@ cache.get(1) // returns undefined
 cache.has(1) // returns false
 ```
 
+## Caveat Regarding Timers and Graceful Exits
+
+On Node.js, this module uses the `Timeout.unref()` method to
+prevent its internal `setTimeout` calls from keeping the process
+running indefinitely.  However, on other systems such as Deno,
+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.
+
 ## API
 
 ### `const TTLCache = require('@isaacs/ttlcache')` or `import TTLCache from '@isaacs/ttlcache'`
 
 Default export is the `TTLCache` class.
 
-### `new TTLCache({ ttl, max = Infinty, updateAgeOnGet = false, noUpdateTTL = false })`
+### `new TTLCache({ ttl, max = Infinty, updateAgeOnGet = false, noUpdateTTL = false, noDisposeOnSet = false })`
 
 Create a new `TTLCache` object.
 

package/index.d.ts

@@ -89,7 +89,7 @@ declare class TTLCache<K, V> implements Iterable<[K, V]> {
 }
 
 declare namespace TTLCache {
-  type DisposeReason = 'evict' | 'set' | 'delete'
+  type DisposeReason = 'evict' | 'set' | 'delete' | 'stale'
 
   type Disposer<K, V> = (
     value: V,
@@ -135,6 +135,13 @@ declare namespace TTLCache {
      */
     updateAgeOnGet?: boolean
 
+    /**
+     * Do not call dispose() function when overwriting a key with a new value
+     *
+     * @default false
+     */
+    noDisposeOnSet?: boolean
+
     /**
      * Function that is called on items when they are dropped from the cache.
      * This can be handy if you want to close file descriptors or do other
@@ -149,10 +156,8 @@ declare namespace TTLCache {
 
   type SetOptions = {
     /**
-     * Set to true to suppress calling the dispose() function if the entry
-     * key is still accessible within the cache.
-     *
-     * @default false
+     * Do not call dispose() function when overwriting a key with a new value
+     * Overrides the value set in the constructor.
      */
     noDisposeOnSet?: boolean
 

package/index.js

@@ -3,15 +3,15 @@
 // Relies on the fact that integer Object keys are kept sorted,
 // and managed very efficiently by V8.
 
-const maybeReqPerfHooks = fallback => {
-  try {
-    return require('perf_hooks').performance
-  } catch (e) {
-    return fallback
-  }
-}
-const timeProvider = maybeReqPerfHooks(Date)
-const now = () => timeProvider.now()
+/* 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)
 
@@ -22,6 +22,7 @@ class TTLCache {
     updateAgeOnGet = false,
     noUpdateTTL = false,
     dispose,
+    noDisposeOnSet = false,
   } = {}) {
     // {[expirationTime]: [keys]}
     this.expirations = Object.create(null)
@@ -41,19 +42,35 @@ class TTLCache {
     this.max = max
     this.updateAgeOnGet = updateAgeOnGet
     this.noUpdateTTL = noUpdateTTL
+    this.noDisposeOnSet = noDisposeOnSet
     if (dispose !== undefined) {
       if (typeof dispose !== 'function') {
         throw new TypeError('dispose must be function if set')
       }
       this.dispose = dispose
     }
+
+    this.timers = new Set()
+  }
+
+  // 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)
+    }
   }
 
+
   clear() {
     const entries =
       this.dispose !== TTLCache.prototype.dispose ? [...this] : []
     this.data.clear()
     this.expirationMap.clear()
+    // no need for any purging now
+    this.cancelTimers()
     this.expirations = Object.create(null)
     for (const [key, val] of entries) {
       this.dispose(val, key, 'delete')
@@ -76,9 +93,13 @@ class TTLCache {
       const expiration = Math.floor(now() + ttl)
       this.expirationMap.set(key, expiration)
       if (!this.expirations[expiration]) {
-        const t = setTimeout(() => this.purgeStale(), ttl)
+        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.expirations[expiration].push(key)
@@ -156,12 +177,17 @@ class TTLCache {
       this.data.delete(key)
       this.expirationMap.delete(key)
       const exp = this.expirations[current]
-      if (exp && exp.length <= 1) {
-        delete this.expirations[current]
-      } else {
-        this.expirations[current] = exp.filter(k => k !== key)
+      if (exp) {
+        if (exp.length <= 1) {
+          delete this.expirations[current]
+        } else {
+          this.expirations[current] = exp.filter(k => k !== key)
+        }
       }
       this.dispose(value, key, 'delete')
+      if (this.size === 0) {
+        this.cancelTimers()
+      }
       return true
     }
     return false
@@ -171,23 +197,29 @@ class TTLCache {
     for (const exp in this.expirations) {
       const keys = this.expirations[exp]
       if (this.size - keys.length >= this.max) {
+        delete this.expirations[exp]
+        const entries = []
         for (const key of keys) {
-          const val = this.data.get(key)
+          entries.push([key, this.data.get(key)])
           this.data.delete(key)
           this.expirationMap.delete(key)
+        }
+        for (const [key, val] of entries) {
           this.dispose(val, key, 'evict')
         }
-        delete this.expirations[exp]
       } else {
         const s = this.size - this.max
+        const entries = []
         for (const key of keys.splice(0, s)) {
-          const val = this.data.get(key)
+          entries.push([key, this.data.get(key)])
           this.data.delete(key)
           this.expirationMap.delete(key)
+        }
+        for (const [key, val] of entries) {
           this.dispose(val, key, 'evict')
         }
+        return
       }
-      return
     }
   }
 
@@ -201,13 +233,20 @@ class TTLCache {
       if (exp === 'Infinity' || exp > n) {
         return
       }
-      for (const key of this.expirations[exp]) {
-        const val = this.data.get(key)
+      const keys = [...this.expirations[exp]]
+      const entries = []
+      delete this.expirations[exp]
+      for (const key of keys) {
+        entries.push([key, this.data.get(key)])
         this.data.delete(key)
         this.expirationMap.delete(key)
+      }
+      for (const [key, val] of entries) {
         this.dispose(val, key, 'stale')
       }
-      delete this.expirations[exp]
+    }
+    if (this.size === 0) {
+      this.cancelTimers()
     }
   }
 

package/package.json

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