@ureq/lib-cache-store 0.0.3 → 0.0.4

package/README.md

@@ -12,92 +12,93 @@ pnpm add @ureq/lib-cache-store
 
 ## 使用
 
-### MemoryCacheStore
+### MemoryStore
 
 内存缓存实现，适用于浏览器和 Node.js。
 
 ```typescript
-import { Request } from '@ureq/core';
-import { FetchRequestor } from '@ureq/impl-fetch';
-import { MemoryCacheStore } from '@ureq/lib-cache-store';
+import { MemoryStore } from '@ureq/lib-cache-store';
 
-const cacheStore = new MemoryCacheStore();
+const cache = new MemoryStore();
 
-const request = new Request(
-  new FetchRequestor(),
-  {
-    cache: {
-      store: cacheStore,
-      ttl: 60000  // 60 秒
-    }
-  }
-);
+// 存储数据（TTL 单位：毫秒）
+cache.set('key', { data: 'value' }, 60000);
+
+// 获取数据
+const data = cache.get('key');
+
+// 检查是否存在
+const exists = cache.has('key');
+
+// 删除数据
+cache.delete('key');
+
+// 清空缓存
+cache.clear();
 ```
 
-### StorageCacheStore
+### StorageStore
 
 基于 Web Storage API 的缓存实现（localStorage/sessionStorage）。
 
 ```typescript
-import { StorageCacheStore } from '@ureq/lib-cache-store';
+import { StorageStore } from '@ureq/lib-cache-store';
 
 // 使用 localStorage
-const localCache = new StorageCacheStore(localStorage);
+const localCache = new StorageStore(localStorage);
 
 // 使用 sessionStorage
-const sessionCache = new StorageCacheStore(sessionStorage);
+const sessionCache = new StorageStore(sessionStorage);
 
-const request = new Request(
-  new FetchRequestor(),
-  {
-    cache: {
-      store: localCache,
-      ttl: 3600000  // 1 小时
-    }
-  }
-);
+// 使用方式与 MemoryStore 相同
+localCache.set('user', { id: 1, name: 'John' }, 3600000);
+const user = localCache.get('user');
 ```
 
 ## API
 
-### MemoryCacheStore
+### MemoryStore
 
 ```typescript
-class MemoryCacheStore implements CacheStore {
-  get<T>(key: string): Promise<T | null>;
-  set<T>(key: string, value: T, ttl: number): Promise<void>;
-  delete(key: string): Promise<void>;
-  clear(): Promise<void>;
+class MemoryStore {
+  set<T>(key: string, value: T, ttl?: number): void;
+  get<T>(key: string): T | undefined;
+  has(key: string): boolean;
+  delete(key: string): void;
+  clear(): void;
 }
 ```
 
-### StorageCacheStore
+### StorageStore
 
 ```typescript
-class StorageCacheStore implements CacheStore {
-  constructor(storage: Storage);
+class StorageStore {
+  constructor(storage?: Storage);
   
-  get<T>(key: string): Promise<T | null>;
-  set<T>(key: string, value: T, ttl: number): Promise<void>;
-  delete(key: string): Promise<void>;
-  clear(): Promise<void>;
+  set<T>(key: string, value: T, ttl?: number): void;
+  get<T>(key: string): T | undefined;
+  has(key: string): boolean;
+  delete(key: string): void;
+  clear(): void;
 }
 ```
 
 ## 特性
 
-### MemoryCacheStore
+### MemoryStore
 
 - ✅ 快速访问
 - ✅ 支持浏览器和 Node.js
 - ✅ 自动过期清理
+- ✅ 同步 API
 - ⚠️ 数据不持久化
 
-### StorageCacheStore
+### StorageStore
 
 - ✅ 数据持久化
 - ✅ 跨页面共享（localStorage）
 - ✅ 自动过期清理
+- ✅ 同步 API
 - ⚠️ 仅支持浏览器
 - ⚠️ 存储空间有限（通常 5-10MB）
 
@@ -106,59 +107,62 @@ class StorageCacheStore implements CacheStore {
 ### 基础用法
 
 ```typescript
-import { MemoryCacheStore } from '@ureq/lib-cache-store';
+import { MemoryStore } from '@ureq/lib-cache-store';
 
-const cache = new MemoryCacheStore();
+const cache = new MemoryStore();
 
-// 存储数据
-await cache.set('key', { data: 'value' }, 60000);
+// 存储数据（TTL: 60 秒）
+cache.set('key', { data: 'value' }, 60000);
 
 // 获取数据
-const data = await cache.get('key');
+const data = cache.get('key');
+
+// 检查是否存在
+if (cache.has('key')) {
+  console.log('Key exists');
+}
 
 // 删除数据
-await cache.delete('key');
+cache.delete('key');
 
 // 清空缓存
-await cache.clear();
+cache.clear();
 ```
 
 ### 持久化缓存
 
 ```typescript
-import { StorageCacheStore } from '@ureq/lib-cache-store';
+import { StorageStore } from '@ureq/lib-cache-store';
 
-const cache = new StorageCacheStore(localStorage);
+const cache = new StorageStore(localStorage);
 
 // 数据会保存到 localStorage
-await cache.set('user', { id: 1, name: 'John' }, 3600000);
+cache.set('user', { id: 1, name: 'John' }, 3600000);
 
 // 刷新页面后仍然可以获取
-const user = await cache.get('user');
+const user = cache.get('user');
 ```
 
-### 自定义缓存实现
+### 与 @ureq/core 集成
 
 ```typescript
-import { CacheStore } from '@ureq/core';
+import { Request } from '@ureq/core';
+import { FetchRequestor } from '@ureq/impl-fetch';
+import { LibCacheStore } from '@ureq/business';
+import { MemoryStore } from '@ureq/lib-cache-store';
 
-class RedisCacheStore implements CacheStore {
-  async get<T>(key: string): Promise<T | null> {
-    // 从 Redis 获取
-  }
-  
-  async set<T>(key: string, value: T, ttl: number): Promise<void> {
-    // 存储到 Redis
-  }
-  
-  async delete(key: string): Promise<void> {
-    // 从 Redis 删除
-  }
-  
-  async clear(): Promise<void> {
-    // 清空 Redis
+const memoryStore = new MemoryStore();
+const cacheStore = new LibCacheStore(memoryStore);
+
+const request = new Request(
+  new FetchRequestor(),
+  {
+    cache: {
+      store: cacheStore,
+      ttl: 60000
+    }
   }
-}
+);
 ```
 
 ## 文档

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ureq/lib-cache-store",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Cache store implementations for universal request library",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -18,6 +18,6 @@
   "scripts": {
     "build": "tsup --config tsup.config.ts",
     "dev": "tsup --config tsup.config.ts --watch",
-    "test": "vitest"
+    "test": "vitest --run"
   }
 }