fast-ttl-cache 0.0.5 → 0.0.7

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

@@ -19,10 +19,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.mjs
 var index_exports = {};
 __export(index_exports, {
-  default: () => TTLCache
+  default: () => FastTTLCache
 });
 module.exports = __toCommonJS(index_exports);
-var TTLCache = class {
+var FastTTLCache = class {
   /**
    * 构造函数
    * @param options 配置选项，包含ttl(过期时间)和capacity(容量)
@@ -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(item);
       return null;
     }
     return item.value;
@@ -76,73 +76,73 @@ var TTLCache = class {
    */
   put(key, value) {
     if (this.size === 0) {
-      this.store.set(key, {
+      const item2 = {
         key,
         value,
-        pre: null,
+        prev: null,
         next: null,
         time: Date.now()
-      });
-      this.head = this.tail = key;
+      };
+      this.head = this.tail = item2;
+      this.store.set(key, item2);
       return;
     }
     if (this.store.has(key)) {
-      const curItem = this.store.get(key);
-      curItem.value = value;
-      curItem.time = Date.now();
-      this.moveToTail(key);
+      const item2 = this.store.get(key);
+      item2.value = value;
+      item2.time = Date.now();
+      this.moveToTail(item2);
       return;
     }
-    const curTail = this.store.get(this.tail);
-    const newItem = {
+    const item = {
       key,
       value,
-      pre: curTail,
+      prev: this.tail,
       next: null,
       time: Date.now()
     };
-    curTail.next = newItem;
-    this.store.set(key, newItem);
-    this.tail = key;
+    this.tail.next = item;
+    this.tail = item;
+    this.store.set(key, item);
     if (this.size > this.capacity) {
-      this.removeItem(this.head);
+      this.del(this.head);
     }
   }
   /**
    * 移除节点
-   * @param key
+   * @param item
    */
-  removeItem(key) {
-    if (!this.store.has(key)) return;
-    const curItem = this.store.get(key);
+  del(item) {
+    const key = item.key;
+    if (!this.store.has(key)) return false;
     if (this.size === 1) {
       this.head = this.tail = null;
-    } else if (this.head === key) {
-      this.head = curItem.next.key;
-      curItem.next.pre = null;
-    } else if (this.tail === key) {
-      this.tail = curItem.pre.key;
-      curItem.pre.next = null;
+    } else if (this.head === item) {
+      this.head = item.next;
+      this.head.prev = null;
+    } else if (this.tail === item) {
+      this.tail = item.prev;
+      this.tail.next = null;
     } else {
-      curItem.pre.next = curItem.next;
-      curItem.next.pre = curItem.pre;
+      item.prev.next = item.next;
+      item.next.prev = item.prev;
     }
     this.store.delete(key);
+    return true;
   }
   /**
    * 将节点移动到队尾，队尾的节点一定是最后一个更新的
-   * @param key
+   * @param item
    */
-  moveToTail(key) {
+  moveToTail(item) {
+    const key = item.key;
     if (!this.store.has(key)) return;
-    if (this.tail === key) return;
-    const curItem = this.store.get(key);
-    this.removeItem(key);
-    const curTail = this.store.get(this.tail);
-    curTail.next = curItem;
-    curItem.pre = curTail;
-    curItem.next = null;
-    this.tail = key;
-    this.store.set(key, curItem);
+    if (this.tail === item) return;
+    this.del(item);
+    this.tail.next = item;
+    item.prev = this.tail;
+    item.next = null;
+    this.tail = item;
+    this.store.set(key, item);
   }
 };

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // src/index.mjs
-var TTLCache = class {
+var FastTTLCache = class {
   /**
    * 构造函数
    * @param options 配置选项，包含ttl(过期时间)和capacity(容量)
@@ -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(item);
       return null;
     }
     return item.value;
@@ -53,76 +53,76 @@ var TTLCache = class {
    */
   put(key, value) {
     if (this.size === 0) {
-      this.store.set(key, {
+      const item2 = {
         key,
         value,
-        pre: null,
+        prev: null,
         next: null,
         time: Date.now()
-      });
-      this.head = this.tail = key;
+      };
+      this.head = this.tail = item2;
+      this.store.set(key, item2);
       return;
     }
     if (this.store.has(key)) {
-      const curItem = this.store.get(key);
-      curItem.value = value;
-      curItem.time = Date.now();
-      this.moveToTail(key);
+      const item2 = this.store.get(key);
+      item2.value = value;
+      item2.time = Date.now();
+      this.moveToTail(item2);
       return;
     }
-    const curTail = this.store.get(this.tail);
-    const newItem = {
+    const item = {
       key,
       value,
-      pre: curTail,
+      prev: this.tail,
       next: null,
       time: Date.now()
     };
-    curTail.next = newItem;
-    this.store.set(key, newItem);
-    this.tail = key;
+    this.tail.next = item;
+    this.tail = item;
+    this.store.set(key, item);
     if (this.size > this.capacity) {
-      this.removeItem(this.head);
+      this.del(this.head);
     }
   }
   /**
    * 移除节点
-   * @param key
+   * @param item
    */
-  removeItem(key) {
-    if (!this.store.has(key)) return;
-    const curItem = this.store.get(key);
+  del(item) {
+    const key = item.key;
+    if (!this.store.has(key)) return false;
     if (this.size === 1) {
       this.head = this.tail = null;
-    } else if (this.head === key) {
-      this.head = curItem.next.key;
-      curItem.next.pre = null;
-    } else if (this.tail === key) {
-      this.tail = curItem.pre.key;
-      curItem.pre.next = null;
+    } else if (this.head === item) {
+      this.head = item.next;
+      this.head.prev = null;
+    } else if (this.tail === item) {
+      this.tail = item.prev;
+      this.tail.next = null;
     } else {
-      curItem.pre.next = curItem.next;
-      curItem.next.pre = curItem.pre;
+      item.prev.next = item.next;
+      item.next.prev = item.prev;
     }
     this.store.delete(key);
+    return true;
   }
   /**
    * 将节点移动到队尾，队尾的节点一定是最后一个更新的
-   * @param key
+   * @param item
    */
-  moveToTail(key) {
+  moveToTail(item) {
+    const key = item.key;
     if (!this.store.has(key)) return;
-    if (this.tail === key) return;
-    const curItem = this.store.get(key);
-    this.removeItem(key);
-    const curTail = this.store.get(this.tail);
-    curTail.next = curItem;
-    curItem.pre = curTail;
-    curItem.next = null;
-    this.tail = key;
-    this.store.set(key, curItem);
+    if (this.tail === item) return;
+    this.del(item);
+    this.tail.next = item;
+    item.prev = this.tail;
+    item.next = null;
+    this.tail = item;
+    this.store.set(key, item);
   }
 };
 export {
-  TTLCache as default
+  FastTTLCache as default
 };

package/package.json

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