fast-ttl-cache 0.0.8 → 0.1.1

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+import { CacheItem, CacheOptions } from './types.js';
+/**
+ * FastTTLCache 缓存类
+ * @brief 不使用 timer 实现的支持 ttl 和 capacity 的缓存类，惰性删除
+ */
+export default class FastTTLCache {
+    /** 缓存过期时间(毫秒) */
+    ttl: number;
+    /** 缓存最大容量 */
+    capacity: number;
+    /** 存储缓存项的Map */
+    private store;
+    /** 链表头部指针，指向最久未更新的节点 */
+    head: CacheItem | null;
+    /** 链表尾部指针，指向最新更新的节点 */
+    tail: CacheItem | null;
+    /** 缓存大小 */
+    size: number;
+    /**
+     * 构造函数
+     * @param options 配置选项，包含ttl(过期时间)和capacity(容量)
+     */
+    constructor(options?: CacheOptions);
+    /**
+     * 获取缓存，惰性删除
+     * @param key 缓存键
+     * @returns 如果缓存存在且未过期返回值，否则返回null
+     */
+    get(key: string): any | null;
+    /**
+     * 设置缓存，包含已存在或新增
+     * @param key 缓存键
+     * @param value 缓存值
+     */
+    put(key: string, value: any): void;
+    /**
+     * 移除节点
+     * @param item CacheItem
+     */
+    private del;
+    /**
+     * 将节点移动到队尾，队尾的节点一定是最后一个更新的
+     * @param item CacheItem
+     */
+    private moveToTail;
+}

package/dist/index.js

@@ -16,7 +16,7 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/index.mjs
+// src/index.ts
 var index_exports = {};
 __export(index_exports, {
   default: () => FastTTLCache
@@ -28,11 +28,16 @@ var FastTTLCache = class {
    * @param options 配置选项，包含ttl(过期时间)和capacity(容量)
    */
   constructor(options = {}) {
-    this.ttl = options.ttl || Infinity;
-    this.capacity = options.capacity || Infinity;
+    /** 存储缓存项的Map */
     this.store = /* @__PURE__ */ new Map();
-    this.head = this.tail = null;
+    /** 链表头部指针，指向最久未更新的节点 */
+    this.head = null;
+    /** 链表尾部指针，指向最新更新的节点 */
+    this.tail = null;
+    /** 缓存大小 */
     this.size = 0;
+    this.ttl = options.ttl || Infinity;
+    this.capacity = options.capacity || Infinity;
     Object.defineProperties(this, {
       size: {
         get() {
@@ -110,7 +115,7 @@ var FastTTLCache = class {
   }
   /**
    * 移除节点
-   * @param item
+   * @param item CacheItem
    */
   del(item) {
     const key = item.key;
@@ -132,16 +137,16 @@ var FastTTLCache = class {
   }
   /**
    * 将节点移动到队尾，队尾的节点一定是最后一个更新的
-   * @param item
+   * @param item CacheItem
    */
   moveToTail(item) {
     const key = item.key;
     if (!this.store.has(key)) return;
     if (this.tail === item) return;
     this.del(item);
-    this.tail.next = item;
     item.prev = this.tail;
     item.next = null;
+    this.tail.next = item;
     this.tail = item;
     this.store.set(key, item);
   }

package/dist/index.mjs

@@ -1,15 +1,20 @@
-// src/index.mjs
+// src/index.ts
 var FastTTLCache = class {
   /**
    * 构造函数
    * @param options 配置选项，包含ttl(过期时间)和capacity(容量)
    */
   constructor(options = {}) {
-    this.ttl = options.ttl || Infinity;
-    this.capacity = options.capacity || Infinity;
+    /** 存储缓存项的Map */
     this.store = /* @__PURE__ */ new Map();
-    this.head = this.tail = null;
+    /** 链表头部指针，指向最久未更新的节点 */
+    this.head = null;
+    /** 链表尾部指针，指向最新更新的节点 */
+    this.tail = null;
+    /** 缓存大小 */
     this.size = 0;
+    this.ttl = options.ttl || Infinity;
+    this.capacity = options.capacity || Infinity;
     Object.defineProperties(this, {
       size: {
         get() {
@@ -87,7 +92,7 @@ var FastTTLCache = class {
   }
   /**
    * 移除节点
-   * @param item
+   * @param item CacheItem
    */
   del(item) {
     const key = item.key;
@@ -109,16 +114,16 @@ var FastTTLCache = class {
   }
   /**
    * 将节点移动到队尾，队尾的节点一定是最后一个更新的
-   * @param item
+   * @param item CacheItem
    */
   moveToTail(item) {
     const key = item.key;
     if (!this.store.has(key)) return;
     if (this.tail === item) return;
     this.del(item);
-    this.tail.next = item;
     item.prev = this.tail;
     item.next = null;
+    this.tail.next = item;
     this.tail = item;
     this.store.set(key, item);
   }

package/dist/types.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 缓存项的数据结构，包含键值对和双向链表指针
+ */
+export interface CacheItem {
+    /** 缓存项的键 */
+    key: string;
+    /** 缓存项的值 */
+    value: any;
+    /** 前一个节点指针 */
+    prev: CacheItem | null;
+    /** 后一个节点指针 */
+    next: CacheItem | null;
+    /** 缓存时间戳 */
+    time: number;
+}
+/**
+ * FastTTLCache constructor options
+ */
+export interface CacheOptions {
+    /** 缓存过期时间(毫秒) */
+    ttl?: number;
+    /** 缓存最大容量 */
+    capacity?: number;
+}

package/dist/types.js

@@ -0,0 +1,17 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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/types.ts
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "fast-ttl-cache",
-  "version": "0.0.8",
+  "version": "0.1.1",
   "description": "ttl cache with capacity support use no timer",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "require": "./dist/index.js",
@@ -11,8 +12,9 @@
     }
   },
   "scripts": {
-    "build": "tsup src/ --format cjs,esm",
-    "prepublishOnly": "npm run build"
+    "build": "shx rm -rf dist/ && tsup src/ --format cjs,esm && tsc src/*.ts --declarationDir dist/ --esModuleInterop true --declaration --emitDeclarationOnly",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --verbose",
+    "prepublishOnly": "npm run test && npm run build"
   },
   "repository": {
     "type": "git",
@@ -21,6 +23,12 @@
   "author": "linye<llxy8687@foxmail.com>",
   "license": "MIT",
   "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.5.2",
+    "jest": "^30.1.3",
+    "jest-environment-node": "^30.1.2",
+    "shx": "^0.4.0",
+    "ts-jest": "^29.4.3",
     "tsup": "^8.5.0",
     "typescript": "^5.9.2"
   },