@nest-omni/core 4.1.3-1 → 4.1.3-10

package/cache/examples/basic-usage.js

@@ -1,4 +1,7 @@
 "use strict";
+/**
+ * 基础缓存使用示例
+ */
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -22,16 +25,18 @@ exports.CacheMonitoringService = exports.PostService = exports.UserService = voi
 exports.demonstrateCacheUsage = demonstrateCacheUsage;
 const common_1 = require("@nestjs/common");
 const index_1 = require("../index");
+// 模拟的仓库类
 class UserRepository {
     findOne(id) {
         return __awaiter(this, void 0, void 0, function* () {
+            // 模拟数据库查询
             console.log(`[DB] 查询用户 ${id}`);
             return {
                 id,
                 name: `User ${id}`,
                 email: `user${id}@example.com`,
                 profile: {
-                    bio: `这是用户 ${id} 的个人简介`.repeat(10),
+                    bio: `这是用户 ${id} 的个人简介`.repeat(10), // 长文本，用于测试压缩
                     avatar: `avatar_${id}.jpg`,
                 },
             };
@@ -80,37 +85,45 @@ class PostRepository {
                 .map((_, i) => ({
                 id: `post_${authorId}_${i}`,
                 title: `文章 ${i}`,
-                content: `这是文章 ${i} 的内容`.repeat(15),
+                content: `这是文章 ${i} 的内容`.repeat(15), // 长内容，用于测试压缩
                 authorId,
                 createdAt: new Date(),
             }));
         });
     }
 }
+/**
+ * 用户服务示例
+ */
 let UserService = class UserService {
     constructor(cacheService, userRepository) {
         this.cacheService = cacheService;
         this.userRepository = userRepository;
     }
+    // 基础缓存使用
     getUser(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.cacheService.getOrSet(`user:${id}`, () => this.userRepository.findOne(id), { ttl: 300000 });
         });
     }
+    // 使用装饰器缓存
     getUserProfile(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.userRepository.findOne(id);
         });
     }
+    // 条件缓存 - 不缓存管理员用户
     getUserData(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.userRepository.findOne(id);
         });
     }
+    // 批量获取用户
     getUsersBatch(ids) {
         return __awaiter(this, void 0, void 0, function* () {
             const keys = ids.map((id) => `user:${id}`);
             const cachedUsers = yield this.cacheService.mget(keys);
+            // 找出缓存中没有的用户
             const uncachedIds = [];
             const result = [];
             cachedUsers.forEach((user, index) => {
@@ -121,8 +134,10 @@ let UserService = class UserService {
                     uncachedIds.push(ids[index]);
                 }
             });
+            // 批量查询未缓存的用户
             if (uncachedIds.length > 0) {
                 const newUsers = yield this.userRepository.findMany(uncachedIds);
+                // 批量设置缓存
                 const cacheItems = newUsers.map((user) => ({
                     key: `user:${user.id}`,
                     value: user,
@@ -133,22 +148,26 @@ let UserService = class UserService {
             return result;
         });
     }
+    // 更新用户并缓存
     updateUser(id, data) {
         return __awaiter(this, void 0, void 0, function* () {
             const updatedUser = yield this.userRepository.save(Object.assign({ id }, data));
             return updatedUser;
         });
     }
+    // 删除用户并清除缓存
     deleteUser(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.userRepository.delete(id);
         });
     }
+    // 使用标签失效
     invalidateAllProfiles() {
         return __awaiter(this, void 0, void 0, function* () {
             console.log('清除所有用户资料缓存');
         });
     }
+    // 缓存大数据（测试压缩）
     cacheLargeData(id) {
         return __awaiter(this, void 0, void 0, function* () {
             const largeData = {
@@ -173,11 +192,13 @@ let UserService = class UserService {
                     averageRating: (Math.random() * 5).toFixed(2),
                 },
             };
+            // 这个数据会被自动压缩，因为大于 1KB
             yield this.cacheService.set(`user:${id}:large-data`, largeData, {
-                ttl: 3600000,
+                ttl: 3600000, // 1小时
             });
         });
     }
+    // 获取大数据
     getLargeData(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.cacheService.get(`user:${id}:large-data`);
@@ -188,7 +209,7 @@ exports.UserService = UserService;
 __decorate([
     (0, index_1.Cacheable)({
         key: (id) => `user:${id}:profile`,
-        ttl: 600000,
+        ttl: 600000, // 10分钟
         dependencies: [new index_1.TagDependency(['user-profile'])],
     }),
     __metadata("design:type", Function),
@@ -235,18 +256,24 @@ exports.UserService = UserService = __decorate([
     __metadata("design:paramtypes", [index_1.CacheService,
         UserRepository])
 ], UserService);
+/**
+ * 文章服务示例 - 展示依赖使用
+ */
 let PostService = class PostService {
     constructor(cacheService, postRepository) {
         this.cacheService = cacheService;
         this.postRepository = postRepository;
     }
+    // 使用数据库依赖 - 当用户表更新时，相关文章缓存会自动失效
     getPostsByAuthor(authorId) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.postRepository.findByAuthor(authorId);
         });
     }
+    // 使用回调依赖 - 基于配置版本
     getFeaturedPosts() {
         return __awaiter(this, void 0, void 0, function* () {
+            // 模拟获取推荐文章
             console.log('[DB] 获取推荐文章');
             return Array(10)
                 .fill(null)
@@ -261,6 +288,7 @@ let PostService = class PostService {
     }
     getConfigVersion() {
         return __awaiter(this, void 0, void 0, function* () {
+            // 模拟获取配置版本
             return '1.0.0';
         });
     }
@@ -269,7 +297,7 @@ exports.PostService = PostService;
 __decorate([
     (0, index_1.Cacheable)({
         key: (authorId) => `posts:by-author:${authorId}`,
-        ttl: 600000,
+        ttl: 600000, // 10分钟
         dependencies: [
             new index_1.DbDependency('SELECT updated_at FROM users WHERE id = ?', (authorId) => [authorId]),
         ],
@@ -281,10 +309,11 @@ __decorate([
 __decorate([
     (0, index_1.Cacheable)({
         key: 'posts:featured',
-        ttl: 1800000,
+        ttl: 1800000, // 30分钟
         dependencies: [
             new index_1.CallbackDependency(() => __awaiter(void 0, void 0, void 0, function* () {
-                return yield 'v1.0.0';
+                // 检查配置版本，如果配置改变则失效缓存
+                return yield 'v1.0.0'; // 简化为固定值
             })),
         ],
     }),
@@ -297,10 +326,14 @@ exports.PostService = PostService = __decorate([
     __metadata("design:paramtypes", [index_1.CacheService,
         PostRepository])
 ], PostService);
+/**
+ * 缓存统计和监控示例
+ */
 let CacheMonitoringService = class CacheMonitoringService {
     constructor(cacheService) {
         this.cacheService = cacheService;
     }
+    // 获取缓存统计信息
     getCacheStats() {
         const stats = this.cacheService.getStats();
         console.log('=== 缓存统计信息 ===');
@@ -317,13 +350,16 @@ let CacheMonitoringService = class CacheMonitoringService {
         }
         return stats;
     }
+    // 重置统计
     resetStats() {
         this.cacheService.resetStats();
         console.log('缓存统计已重置');
     }
+    // 定期监控
     startMonitoring(intervalMs = 60000) {
         setInterval(() => {
             const stats = this.getCacheStats();
+            // 如果命中率过低，发出警告
             if (stats.hitRate < 0.7) {
                 console.warn(`⚠️ 缓存命中率过低: ${(stats.hitRate * 100).toFixed(2)}%`);
             }
@@ -336,38 +372,56 @@ exports.CacheMonitoringService = CacheMonitoringService = __decorate([
     (0, common_1.Injectable)(),
     __metadata("design:paramtypes", [index_1.CacheService])
 ], CacheMonitoringService);
+/**
+ * 使用示例
+ */
 function demonstrateCacheUsage() {
     return __awaiter(this, void 0, void 0, function* () {
-        const userService = new UserService(new index_1.CacheService({}, {}, {}, true, 1024), new UserRepository());
+        // 注意：在实际应用中，这些服务会通过依赖注入获得
+        const userService = new UserService(new index_1.CacheService(
+        // 这些参数在实际应用中会通过模块配置自动注入
+        {}, // CLS Provider
+        {}, // Memory Provider
+        {}, // Redis Provider
+        true, // 启用压缩
+        1024), new UserRepository());
         const postService = new PostService(new index_1.CacheService({}, {}, {}, true, 1024), new PostRepository());
         const monitoringService = new CacheMonitoringService(new index_1.CacheService({}, {}, {}, true, 1024));
         console.log('🚀 开始缓存演示...\n');
         try {
+            // 1. 基础缓存演示
             console.log('1. 基础缓存使用:');
             const user1 = yield userService.getUser('1');
             console.log(`获取用户: ${user1.name}`);
+            // 第二次获取应该从缓存获取
             const user1Cached = yield userService.getUser('1');
             console.log(`从缓存获取用户: ${user1Cached.name}\n`);
+            // 2. 装饰器缓存演示
             console.log('2. 装饰器缓存:');
             const profile = yield userService.getUserProfile('2');
             console.log(`获取用户资料: ${profile.name}`);
             const profileCached = yield userService.getUserProfile('2');
             console.log(`从缓存获取用户资料: ${profileCached.name}\n`);
+            // 3. 批量操作演示
             console.log('3. 批量操作:');
             const users = yield userService.getUsersBatch(['1', '2', '3', '4', '5']);
             console.log(`批量获取 ${users.length} 个用户\n`);
+            // 4. 大数据压缩演示
             console.log('4. 大数据压缩:');
             yield userService.cacheLargeData('1');
             console.log('缓存大数据完成（应该自动压缩）');
             const largeData = yield userService.getLargeData('1');
             console.log(`获取大数据: 用户 ${largeData.user.name}, 文章数 ${largeData.posts.length}\n`);
+            // 5. 依赖系统演示
             console.log('5. 依赖系统:');
             const posts = yield postService.getPostsByAuthor('1');
             console.log(`获取作者文章: ${posts.length} 篇`);
             const featuredPosts = yield postService.getFeaturedPosts();
             console.log(`获取推荐文章: ${featuredPosts.length} 篇\n`);
+            // 6. 缓存统计
             console.log('6. 缓存统计:');
             monitoringService.getCacheStats();
+            // 7. 缓存失效演示
             console.log('\n7. 缓存失效:');
             yield userService.invalidateAllProfiles();
             console.log('已清除所有用户资料缓存');

package/cache/index.js

@@ -1,14 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyGenerator = exports.DependencyManager = exports.CacheLayer = exports.TimeDependency = exports.TagDependency = exports.FileDependency = exports.DbDependency = exports.ChainDependency = exports.CallbackDependency = exports.REDIS_CLIENT = exports.BaseCacheProvider = exports.RedisCacheProvider = exports.MemoryCacheProvider = exports.ClsCacheProvider = exports.setCacheService = exports.getCacheService = exports.CachePut = exports.CacheEvict = exports.Cacheable = exports.CacheSerializationService = exports.CacheMetricsService = exports.CacheWarmupService = exports.CacheHealthChecker = exports.CacheService = exports.CACHE_COMPRESSION_THRESHOLD = exports.CACHE_COMPRESSION_ENABLED = exports.CACHE_SERVICE = exports.CacheModule = void 0;
+// Module
 var cache_module_1 = require("./cache.module");
 Object.defineProperty(exports, "CacheModule", { enumerable: true, get: function () { return cache_module_1.CacheModule; } });
 Object.defineProperty(exports, "CACHE_SERVICE", { enumerable: true, get: function () { return cache_module_1.CACHE_SERVICE; } });
+// Constants
 var cache_constants_1 = require("./cache.constants");
 Object.defineProperty(exports, "CACHE_COMPRESSION_ENABLED", { enumerable: true, get: function () { return cache_constants_1.CACHE_COMPRESSION_ENABLED; } });
 Object.defineProperty(exports, "CACHE_COMPRESSION_THRESHOLD", { enumerable: true, get: function () { return cache_constants_1.CACHE_COMPRESSION_THRESHOLD; } });
+// Service
 var cache_service_1 = require("./cache.service");
 Object.defineProperty(exports, "CacheService", { enumerable: true, get: function () { return cache_service_1.CacheService; } });
+// Additional Services
 var cache_health_1 = require("./cache.health");
 Object.defineProperty(exports, "CacheHealthChecker", { enumerable: true, get: function () { return cache_health_1.CacheHealthChecker; } });
 var cache_warmup_service_1 = require("./cache.warmup.service");
@@ -17,12 +21,14 @@ var cache_metrics_service_1 = require("./cache-metrics.service");
 Object.defineProperty(exports, "CacheMetricsService", { enumerable: true, get: function () { return cache_metrics_service_1.CacheMetricsService; } });
 var cache_serialization_service_1 = require("./cache-serialization.service");
 Object.defineProperty(exports, "CacheSerializationService", { enumerable: true, get: function () { return cache_serialization_service_1.CacheSerializationService; } });
+// Decorators
 var decorators_1 = require("./decorators");
 Object.defineProperty(exports, "Cacheable", { enumerable: true, get: function () { return decorators_1.Cacheable; } });
 Object.defineProperty(exports, "CacheEvict", { enumerable: true, get: function () { return decorators_1.CacheEvict; } });
 Object.defineProperty(exports, "CachePut", { enumerable: true, get: function () { return decorators_1.CachePut; } });
 Object.defineProperty(exports, "getCacheService", { enumerable: true, get: function () { return decorators_1.getCacheService; } });
 Object.defineProperty(exports, "setCacheService", { enumerable: true, get: function () { return decorators_1.setCacheService; } });
+// Providers
 var providers_1 = require("./providers");
 Object.defineProperty(exports, "ClsCacheProvider", { enumerable: true, get: function () { return providers_1.ClsCacheProvider; } });
 Object.defineProperty(exports, "MemoryCacheProvider", { enumerable: true, get: function () { return providers_1.MemoryCacheProvider; } });
@@ -30,6 +36,7 @@ Object.defineProperty(exports, "RedisCacheProvider", { enumerable: true, get: fu
 Object.defineProperty(exports, "BaseCacheProvider", { enumerable: true, get: function () { return providers_1.BaseCacheProvider; } });
 var redis_cache_provider_1 = require("./providers/redis-cache.provider");
 Object.defineProperty(exports, "REDIS_CLIENT", { enumerable: true, get: function () { return redis_cache_provider_1.REDIS_CLIENT; } });
+// Dependencies
 var dependencies_1 = require("./dependencies");
 Object.defineProperty(exports, "CallbackDependency", { enumerable: true, get: function () { return dependencies_1.CallbackDependency; } });
 Object.defineProperty(exports, "ChainDependency", { enumerable: true, get: function () { return dependencies_1.ChainDependency; } });
@@ -37,8 +44,10 @@ Object.defineProperty(exports, "DbDependency", { enumerable: true, get: function
 Object.defineProperty(exports, "FileDependency", { enumerable: true, get: function () { return dependencies_1.FileDependency; } });
 Object.defineProperty(exports, "TagDependency", { enumerable: true, get: function () { return dependencies_1.TagDependency; } });
 Object.defineProperty(exports, "TimeDependency", { enumerable: true, get: function () { return dependencies_1.TimeDependency; } });
+// Interfaces
 var interfaces_1 = require("./interfaces");
 Object.defineProperty(exports, "CacheLayer", { enumerable: true, get: function () { return interfaces_1.CacheLayer; } });
+// Utils (advanced usage)
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "DependencyManager", { enumerable: true, get: function () { return utils_1.DependencyManager; } });
 Object.defineProperty(exports, "KeyGenerator", { enumerable: true, get: function () { return utils_1.KeyGenerator; } });

package/cache/interfaces/cache-dependency.interface.d.ts

@@ -1,11 +1,64 @@
+/**
+ * Cache dependency interface - similar to Yii2 cache dependency system
+ *
+ * A cache dependency represents a dependency relationship between cached data
+ * and some external state. When the external state changes, the cached data
+ * becomes invalid.
+ *
+ * @example
+ * ```typescript
+ * // Tag-based dependency
+ * new TagDependency(['user-list'])
+ *
+ * // Database-based dependency
+ * new DbDependency('SELECT MAX(updated_at) FROM users WHERE id = ?', [userId])
+ *
+ * // Callback-based dependency
+ * new CallbackDependency(() => ConfigService.get('app.version'))
+ * ```
+ */
 export interface CacheDependency {
+    /**
+     * Get a unique key that identifies this dependency
+     * This key is used to store the dependency state
+     *
+     * @returns Unique dependency key
+     */
     getKey(): string;
+    /**
+     * Get the current state/value of this dependency
+     * This value will be compared with stored state to detect changes
+     *
+     * @returns Current dependency data/state
+     */
     getData(): Promise<any>;
+    /**
+     * Check if the dependency has changed by comparing old data with current data
+     *
+     * @param oldData - Previously stored dependency data
+     * @returns true if dependency has changed, false otherwise
+     */
     isChanged(oldData: any): Promise<boolean>;
+    /**
+     * Reset/clear the dependency state
+     * Used when manually invalidating dependencies
+     */
     reset?(): Promise<void>;
 }
+/**
+ * Serialized dependency data stored alongside cached values
+ */
 export interface DependencyData {
+    /**
+     * Dependency key
+     */
     key: string;
+    /**
+     * Dependency state snapshot at cache time
+     */
     data: any;
+    /**
+     * Timestamp when dependency was captured
+     */
     timestamp: number;
 }

package/cache/interfaces/cache-options.interface.d.ts

@@ -1,32 +1,113 @@
 import type { CacheDependency } from './cache-dependency.interface';
+/**
+ * Cache layer enum - defines the three-tier cache architecture
+ */
 export declare enum CacheLayer {
+    /** L1: Request-level cache (nestjs-cls) - fastest, scoped to request */
     CLS = "cls",
+    /** L2: Process-level cache (native Map) - fast, scoped to process */
     MEMORY = "memory",
+    /** L3: Distributed cache (Redis) - persistent, shared across processes */
     REDIS = "redis"
 }
+/**
+ * Cache configuration options
+ */
 export interface CacheOptions {
+    /**
+     * Time to live in milliseconds
+     * @example 300_000 // 5 minutes
+     */
     ttl?: number;
+    /**
+     * Cache layers to use
+     * @default [CacheLayer.MEMORY, CacheLayer.REDIS]
+     */
     layers?: CacheLayer[];
+    /**
+     * Key prefix for namespacing
+     * @example 'user:' will result in keys like 'user:123'
+     */
     prefix?: string;
+    /**
+     * Condition function to determine if value should be cached
+     * @param args - Method arguments
+     * @returns true to cache, false to skip
+     */
     condition?: (...args: any[]) => boolean | Promise<boolean>;
+    /**
+     * Cache dependencies - cache will be invalidated when dependencies change
+     * Similar to Yii2 cache dependency system
+     */
     dependencies?: CacheDependency[];
+    /**
+     * Whether to backfill upper cache layers when value is found in lower layer
+     * @default true
+     */
     backfill?: boolean;
+    /**
+     * Namespace for grouping related cache keys
+     */
     namespace?: string;
 }
+/**
+ * Options for cache decorator key generation
+ */
 export interface CacheKeyOptions {
+    /**
+     * Static key or key generator function
+     */
     key?: string | ((...args: any[]) => string);
+    /**
+     * Key prefix
+     */
     prefix?: string;
+    /**
+     * Whether to include all method arguments in key generation
+     * @default false
+     */
     includeAllArgs?: boolean;
 }
+/**
+ * Options for @Cacheable decorator
+ */
 export interface CacheableOptions extends CacheOptions, CacheKeyOptions {
 }
+/**
+ * Options for @CacheEvict decorator
+ */
 export interface CacheEvictOptions {
+    /**
+     * Keys to evict (can be static strings or generator functions)
+     */
     keys?: Array<string | ((...args: any[]) => string)>;
+    /**
+     * Patterns to match for eviction (supports wildcards)
+     * @example ['user:*', 'posts:list:*']
+     */
     patterns?: string[];
+    /**
+     * Tags to invalidate
+     */
     tags?: string[];
+    /**
+     * Cache layers to evict from
+     */
     layers?: CacheLayer[];
+    /**
+     * Condition to determine if eviction should occur
+     * @param args - Method arguments
+     * @param result - Method return value
+     */
     condition?: (...args: any[]) => boolean | Promise<boolean>;
+    /**
+     * Whether to evict before or after method execution
+     * @default 'after'
+     */
     timing?: 'before' | 'after';
 }
+/**
+ * Options for @CachePut decorator
+ */
 export interface CachePutOptions extends CacheOptions, CacheKeyOptions {
 }

package/cache/interfaces/cache-options.interface.js

@@ -1,9 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CacheLayer = void 0;
+/**
+ * Cache layer enum - defines the three-tier cache architecture
+ */
 var CacheLayer;
 (function (CacheLayer) {
+    /** L1: Request-level cache (nestjs-cls) - fastest, scoped to request */
     CacheLayer["CLS"] = "cls";
+    /** L2: Process-level cache (native Map) - fast, scoped to process */
     CacheLayer["MEMORY"] = "memory";
+    /** L3: Distributed cache (Redis) - persistent, shared across processes */
     CacheLayer["REDIS"] = "redis";
 })(CacheLayer || (exports.CacheLayer = CacheLayer = {}));

package/cache/interfaces/cache-provider.interface.d.ts

@@ -1,28 +1,106 @@
+/**
+ * Base cache provider interface
+ * All cache providers (CLS, Memory, Redis) implement this interface
+ */
 export interface CacheProvider {
+    /**
+     * Get value from cache
+     *
+     * @param key - Cache key
+     * @returns Cached value or null if not found
+     */
     get<T>(key: string): Promise<T | null>;
+    /**
+     * Set value in cache
+     *
+     * @param key - Cache key
+     * @param value - Value to cache
+     * @param ttl - Time to live in milliseconds
+     */
     set<T>(key: string, value: T, ttl?: number): Promise<void>;
+    /**
+     * Delete value from cache
+     *
+     * @param key - Cache key or array of keys
+     */
     delete(key: string | string[]): Promise<void>;
+    /**
+     * Delete keys matching a pattern (supports wildcards)
+     *
+     * @param pattern - Pattern to match (e.g., 'user:*')
+     * @returns Number of keys deleted
+     */
     deletePattern?(pattern: string): Promise<number>;
+    /**
+     * Clear all cache entries
+     */
     clear(): Promise<void>;
+    /**
+     * Check if a key exists in cache
+     *
+     * @param key - Cache key
+     */
     has(key: string): Promise<boolean>;
+    /**
+     * Get multiple values at once
+     *
+     * @param keys - Array of cache keys
+     * @returns Array of values (null for missing keys)
+     */
     mget<T>(keys: string[]): Promise<(T | null)[]>;
+    /**
+     * Set multiple values at once
+     *
+     * @param items - Array of key-value pairs
+     * @param ttl - Time to live in milliseconds
+     */
     mset(items: Array<{
         key: string;
         value: any;
     }>, ttl?: number): Promise<void>;
+    /**
+     * Get provider name
+     */
     getName(): string;
 }
+/**
+ * Cache statistics
+ */
 export interface CacheStats {
+    /**
+     * Total number of get operations
+     */
     totalGets: number;
+    /**
+     * Number of cache hits
+     */
     hits: number;
+    /**
+     * Number of cache misses
+     */
     misses: number;
+    /**
+     * Hit rate (hits / totalGets)
+     */
     hitRate: number;
+    /**
+     * Stats per layer
+     */
     byLayer: Record<string, {
         hits: number;
         misses: number;
         hitRate: number;
     }>;
+    /**
+     * Total number of set operations
+     */
     totalSets: number;
+    /**
+     * Total number of delete operations
+     */
     totalDeletes: number;
+    /**
+     * Total number of clear operations
+     */
     totalClears: number;
 }

package/cache/providers/base-cache.provider.d.ts

@@ -1,4 +1,7 @@
 import type { CacheProvider } from '../interfaces/cache-provider.interface';
+/**
+ * Base cache provider with common utility methods
+ */
 export declare abstract class BaseCacheProvider implements CacheProvider {
     abstract get<T>(key: string): Promise<T | null>;
     abstract set<T>(key: string, value: T, ttl?: number): Promise<void>;
@@ -7,10 +10,21 @@ export declare abstract class BaseCacheProvider implements CacheProvider {
     abstract clear(): Promise<void>;
     abstract has(key: string): Promise<boolean>;
     abstract getName(): string;
+    /**
+     * Get multiple values at once
+     * Default implementation - can be overridden for better performance
+     */
     mget<T>(keys: string[]): Promise<(T | null)[]>;
+    /**
+     * Set multiple values at once
+     * Default implementation - can be overridden for better performance
+     */
     mset(items: Array<{
         key: string;
         value: any;
     }>, ttl?: number): Promise<void>;
+    /**
+     * Convert wildcard pattern to RegExp
+     */
     protected patternToRegex(pattern: string): RegExp;
 }