fast-ttl-cache 0.0.5 → 0.0.6

package/README.md

@@ -37,20 +37,24 @@ cache.size; // return 0
 ## API
 ```FastTTLCache(options) consturctor```
 
-options.ttl: number of millseconds, defaults to Infinity
-options.capacity: number of max capacity, defaults to Infinity
+- ```options.ttl```: number of millseconds, defaults to Infinity
+- ```options.capacity```: number of max capacity, defaults to Infinity
 
 ```FastTTLCache.prototype.put(key, value)```
 
-Add or update the value into cache with key and timestamp.
+- Add or update the value into cache with key and timestamp.
 
 ```FastTTLCache.prototype.get(key)```
 
-Get the value of the key from cache, return null if the key is not exists or has been expired.
+- Get the value of the key from cache, return null if the key is not exists or has been expired.
+
+```FastTTLCache.prototype.del(key)```
+
+- delete key and it's value from cache, return false if the key is not exists, otherwise return true.
 
 ```FastTTLCache.prototype.size```
 
-return the current size of cache.
+- return the current size of cache, note because of the lazy deletion mechanism, it's not the exact number of cache items that are valid.
 
 ## License
 MIT

package/dist/index.js

@@ -64,7 +64,7 @@ var TTLCache = class {
     const item = this.store.get(key);
     if (!item) return null;
     if (Date.now() - item.time > this.ttl) {
-      this.removeItem(key);
+      this.del(key);
       return null;
     }
     return item.value;
@@ -105,15 +105,15 @@ var TTLCache = class {
     this.store.set(key, newItem);
     this.tail = key;
     if (this.size > this.capacity) {
-      this.removeItem(this.head);
+      this.del(this.head);
     }
   }
   /**
    * 移除节点
    * @param key
    */
-  removeItem(key) {
-    if (!this.store.has(key)) return;
+  del(key) {
+    if (!this.store.has(key)) return false;
     const curItem = this.store.get(key);
     if (this.size === 1) {
       this.head = this.tail = null;
@@ -128,6 +128,7 @@ var TTLCache = class {
       curItem.next.pre = curItem.pre;
     }
     this.store.delete(key);
+    return true;
   }
   /**
    * 将节点移动到队尾，队尾的节点一定是最后一个更新的
@@ -137,7 +138,7 @@ var TTLCache = class {
     if (!this.store.has(key)) return;
     if (this.tail === key) return;
     const curItem = this.store.get(key);
-    this.removeItem(key);
+    this.del(key);
     const curTail = this.store.get(this.tail);
     curTail.next = curItem;
     curItem.pre = curTail;

package/dist/index.mjs

@@ -41,7 +41,7 @@ var TTLCache = class {
     const item = this.store.get(key);
     if (!item) return null;
     if (Date.now() - item.time > this.ttl) {
-      this.removeItem(key);
+      this.del(key);
       return null;
     }
     return item.value;
@@ -82,15 +82,15 @@ var TTLCache = class {
     this.store.set(key, newItem);
     this.tail = key;
     if (this.size > this.capacity) {
-      this.removeItem(this.head);
+      this.del(this.head);
     }
   }
   /**
    * 移除节点
    * @param key
    */
-  removeItem(key) {
-    if (!this.store.has(key)) return;
+  del(key) {
+    if (!this.store.has(key)) return false;
     const curItem = this.store.get(key);
     if (this.size === 1) {
       this.head = this.tail = null;
@@ -105,6 +105,7 @@ var TTLCache = class {
       curItem.next.pre = curItem.pre;
     }
     this.store.delete(key);
+    return true;
   }
   /**
    * 将节点移动到队尾，队尾的节点一定是最后一个更新的
@@ -114,7 +115,7 @@ var TTLCache = class {
     if (!this.store.has(key)) return;
     if (this.tail === key) return;
     const curItem = this.store.get(key);
-    this.removeItem(key);
+    this.del(key);
     const curTail = this.store.get(this.tail);
     curTail.next = curItem;
     curItem.pre = curTail;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-ttl-cache",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "ttl cache with capacity support use no timer",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",