fast-ttl-cache 0.0.4 → 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

@@ -0,0 +1,149 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.mjs
+var index_exports = {};
+__export(index_exports, {
+  default: () => TTLCache
+});
+module.exports = __toCommonJS(index_exports);
+var TTLCache = class {
+  /**
+   * 构造函数
+   * @param options 配置选项，包含ttl(过期时间)和capacity(容量)
+   */
+  constructor(options = {}) {
+    this.ttl = options.ttl || Infinity;
+    this.capacity = options.capacity || Infinity;
+    this.store = /* @__PURE__ */ new Map();
+    this.head = this.tail = null;
+    this.size = 0;
+    Object.defineProperties(this, {
+      size: {
+        get() {
+          return this.store.size;
+        },
+        configurable: false
+      },
+      store: {
+        configurable: false,
+        enumerable: false,
+        writable: false
+      },
+      head: {
+        configurable: false,
+        enumerable: false
+      },
+      tail: {
+        configurable: false,
+        enumerable: false
+      }
+    });
+  }
+  /**
+   * 获取缓存，惰性删除
+   * @param key 缓存键
+   * @returns 如果缓存存在且未过期返回值，否则返回null
+   */
+  get(key) {
+    const item = this.store.get(key);
+    if (!item) return null;
+    if (Date.now() - item.time > this.ttl) {
+      this.del(key);
+      return null;
+    }
+    return item.value;
+  }
+  /**
+   * 设置缓存，包含已存在或新增
+   * @param key 缓存键
+   * @param value 缓存值
+   */
+  put(key, value) {
+    if (this.size === 0) {
+      this.store.set(key, {
+        key,
+        value,
+        pre: null,
+        next: null,
+        time: Date.now()
+      });
+      this.head = this.tail = key;
+      return;
+    }
+    if (this.store.has(key)) {
+      const curItem = this.store.get(key);
+      curItem.value = value;
+      curItem.time = Date.now();
+      this.moveToTail(key);
+      return;
+    }
+    const curTail = this.store.get(this.tail);
+    const newItem = {
+      key,
+      value,
+      pre: curTail,
+      next: null,
+      time: Date.now()
+    };
+    curTail.next = newItem;
+    this.store.set(key, newItem);
+    this.tail = key;
+    if (this.size > this.capacity) {
+      this.del(this.head);
+    }
+  }
+  /**
+   * 移除节点
+   * @param key
+   */
+  del(key) {
+    if (!this.store.has(key)) return false;
+    const curItem = this.store.get(key);
+    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 {
+      curItem.pre.next = curItem.next;
+      curItem.next.pre = curItem.pre;
+    }
+    this.store.delete(key);
+    return true;
+  }
+  /**
+   * 将节点移动到队尾，队尾的节点一定是最后一个更新的
+   * @param key
+   */
+  moveToTail(key) {
+    if (!this.store.has(key)) return;
+    if (this.tail === key) return;
+    const curItem = this.store.get(key);
+    this.del(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);
+  }
+};

package/{index.mjs → dist/index.mjs}

@@ -1,5 +1,5 @@
-
-export default class TTLCache {
+// src/index.mjs
+var TTLCache = class {
   /**
    * 构造函数
    * @param options 配置选项，包含ttl(过期时间)和capacity(容量)
@@ -7,17 +7,31 @@ export default class TTLCache {
   constructor(options = {}) {
     this.ttl = options.ttl || Infinity;
     this.capacity = options.capacity || Infinity;
-    this.store = new Map();
+    this.store = /* @__PURE__ */ new Map();
     this.head = this.tail = null;
     this.size = 0;
-    Object.defineProperty(this, 'size', {
-      get() {
-        return this.store.size;
+    Object.defineProperties(this, {
+      size: {
+        get() {
+          return this.store.size;
+        },
+        configurable: false
       },
-      configurable: false
+      store: {
+        configurable: false,
+        enumerable: false,
+        writable: false
+      },
+      head: {
+        configurable: false,
+        enumerable: false
+      },
+      tail: {
+        configurable: false,
+        enumerable: false
+      }
     });
   }
-
   /**
    * 获取缓存，惰性删除
    * @param key 缓存键
@@ -26,86 +40,72 @@ export default class TTLCache {
   get(key) {
     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;
   }
-
   /**
    * 设置缓存，包含已存在或新增
    * @param key 缓存键
    * @param value 缓存值
    */
   put(key, value) {
-    // 缓存为空时的处理
     if (this.size === 0) {
       this.store.set(key, {
         key,
         value,
         pre: null,
         next: null,
-        time: Date.now(),
+        time: Date.now()
       });
       this.head = this.tail = key;
       return;
     }
-
-    // 数据已存在时的处理
     if (this.store.has(key)) {
-      // 更新节点的值和时间戳
       const curItem = this.store.get(key);
       curItem.value = value;
       curItem.time = Date.now();
-
-      // 移动到尾部
       this.moveToTail(key);
       return;
     }
-
-    // 新数据插入尾部
     const curTail = this.store.get(this.tail);
     const newItem = {
       key,
       value,
       pre: curTail,
       next: null,
-      time: Date.now(),
+      time: Date.now()
     };
     curTail.next = newItem;
     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) { // 只有一个节点的情况
+    if (this.size === 1) {
       this.head = this.tail = null;
-    } else if (this.head === key) { // 处理头部节点的情况
+    } else if (this.head === key) {
       this.head = curItem.next.key;
       curItem.next.pre = null;
-    } else if (this.tail === key) { // 处理尾部节点的情况
+    } else if (this.tail === key) {
       this.tail = curItem.pre.key;
       curItem.pre.next = null;
-    } else { // 处理中间节点的情况
+    } else {
       curItem.pre.next = curItem.next;
       curItem.next.pre = curItem.pre;
     }
-    // 从 store 里删除节点
     this.store.delete(key);
+    return true;
   }
   /**
    * 将节点移动到队尾，队尾的节点一定是最后一个更新的
@@ -113,24 +113,17 @@ export default class TTLCache {
    */
   moveToTail(key) {
     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;
     curItem.next = null;
     this.tail = key;
-    // 设置缓存
     this.store.set(key, curItem);
   }
 };
-
+export {
+  TTLCache as default
+};

package/package.json

@@ -1,17 +1,30 @@
 {
   "name": "fast-ttl-cache",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "ttl cache with capacity support use no timer",
-  "module": "./index.mjs",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
   "exports": {
     ".": {
-      "import": "./index.mjs"
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
     }
   },
+  "scripts": {
+    "build": "tsup src/ --format cjs,esm",
+    "prepublishOnly": "npm run build"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/xincici/fast-ttl-cache"
   },
   "author": "linye<llxy8687@foxmail.com>",
-  "license": "MIT"
+  "license": "MIT",
+  "devDependencies": {
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.2"
+  },
+  "files": [
+    "dist/"
+  ]
 }

package/test.mjs

@@ -1,36 +0,0 @@
-
-import TTLCache from './index.mjs';
-
-const sleep = ms => new Promise(res => setTimeout(res, ms));
-
-const c = new TTLCache({
-  ttl: 1000,
-  capacity: 3,
-});
-
-c.put('a', 'aaaa');
-c.put('a', 'aaaaaa');
-
-await sleep(200);
-c.put('b', 'bbbb');
-
-await sleep(500);
-c.put('c', 'cccc');
-
-await sleep(500);
-c.put('b', 'bbbbbb');
-
-await sleep(600);
-c.put('d', 'dddd');
-
-console.log('b', c.get('b'));
-
-await sleep(600);
-c.put('e', 'eeee');
-
-console.log(c);
-console.log(c.store.keys());
-console.log('b', c.get('b'));
-console.log('c', c.get('c'));
-console.log('a', c.get('a'));
-console.log('e', c.get('e'));