fast-ttl-cache 0.1.0 → 0.1.2

package/dist/index.d.mts

@@ -0,0 +1,49 @@
+import { CacheItem, CacheOptions } from './types.mjs';
+
+/**
+ * FastTTLCache 缓存类
+ * @brief 不使用 timer 实现的支持 ttl 和 capacity 的缓存类，惰性删除
+ */
+declare 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;
+}
+
+export { FastTTLCache as default };

package/dist/index.d.ts

@@ -1,9 +1,10 @@
 import { CacheItem, CacheOptions } from './types.js';
+
 /**
  * FastTTLCache 缓存类
  * @brief 不使用 timer 实现的支持 ttl 和 capacity 的缓存类，惰性删除
  */
-export default class FastTTLCache {
+declare class FastTTLCache {
     /** 缓存过期时间(毫秒) */
     ttl: number;
     /** 缓存最大容量 */
@@ -26,7 +27,7 @@ export default class FastTTLCache {
      * @param key 缓存键
      * @returns 如果缓存存在且未过期返回值，否则返回null
      */
-    getToken(key: string): any | null;
+    get(key: string): any | null;
     /**
      * 设置缓存，包含已存在或新增
      * @param key 缓存键
@@ -44,3 +45,5 @@ export default class FastTTLCache {
      */
     private moveToTail;
 }
+
+export { FastTTLCache as default };

package/dist/index.js

@@ -65,7 +65,7 @@ var FastTTLCache = class {
    * @param key 缓存键
    * @returns 如果缓存存在且未过期返回值，否则返回null
    */
-  getToken(key) {
+  get(key) {
     const item = this.store.get(key);
     if (!item) return null;
     if (Date.now() - item.time > this.ttl) {

package/dist/index.mjs

@@ -42,7 +42,7 @@ var FastTTLCache = class {
    * @param key 缓存键
    * @returns 如果缓存存在且未过期返回值，否则返回null
    */
-  getToken(key) {
+  get(key) {
     const item = this.store.get(key);
     if (!item) return null;
     if (Date.now() - item.time > this.ttl) {

package/dist/types.d.mts

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

package/dist/types.d.ts

@@ -1,7 +1,7 @@
 /**
  * 缓存项的数据结构，包含键值对和双向链表指针
  */
-export interface CacheItem {
+interface CacheItem {
     /** 缓存项的键 */
     key: string;
     /** 缓存项的值 */
@@ -16,9 +16,11 @@ export interface CacheItem {
 /**
  * FastTTLCache constructor options
  */
-export interface CacheOptions {
+interface CacheOptions {
     /** 缓存过期时间(毫秒) */
     ttl?: number;
     /** 缓存最大容量 */
     capacity?: number;
 }
+
+export type { CacheItem, CacheOptions };

package/package.json

@@ -1,18 +1,20 @@
 {
   "name": "fast-ttl-cache",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "ttl cache with capacity support use no timer",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "require": "./dist/index.js",
       "import": "./dist/index.mjs"
     }
   },
   "scripts": {
-    "build": "shx rm -rf dist/ && tsup src/ --format cjs,esm && tsc src/*.ts --declarationDir dist/ --esModuleInterop true --declaration --emitDeclarationOnly",
+    "dev": "tsup src/ --clean --format cjs,esm --dts --watch",
+    "build": "tsup src/ --clean --format cjs,esm --dts",
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --verbose",
     "prepublishOnly": "npm run test && npm run build"
   },
@@ -27,7 +29,6 @@
     "@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"