Class BaseCache<T>Abstract

Abstract base class providing common functionality for cache implementations. Handles statistics tracking, key building, entry creation, and logging.

Example

class FileCache extends BaseCache<string> {
  constructor(config?: CacheConfig) {
    super({ logPrefix: '[FileCache]', ...config });
  }
  // Implement abstract methods...
}

Type Parameters

  • T = any

    The type of values stored in the cache

Hierarchy (view full)

Implements

Constructors

constructor

Properties

config logger stats

Methods

buildKey clear createCacheEntry delete get getStats has isExpired keys log resetStats set size updateStats

Constructors

constructor

Properties

config

config: node.common.apis.cache.CacheConfig

Cache configuration

logger

logger: any

Protectedstats

stats: node.common.apis.cache.CacheStats

Methods

ProtectedbuildKey

  • buildKey(key): string
  • Protected

    Builds a full cache key by combining prefix, namespace, and the provided key.

    Parameters

    • key: string

      The base cache key

    Returns string

    The fully qualified cache key

Abstractclear

  • clear(): Promise<void>

  • Removes all entries from the cache. Must be implemented by concrete cache classes.

    Returns Promise<void>

ProtectedcreateCacheEntry

Abstractdelete

  • delete(key): Promise<boolean>

  • Removes a specific key from the cache. Must be implemented by concrete cache classes.

    Parameters

    • key: string

      The cache key to delete

    Returns Promise<boolean>

    True if the key was successfully deleted

Abstractget

  • get(key): Promise<null | T>

  • Retrieves a value from the cache by key. Must be implemented by concrete cache classes.

    Parameters

    • key: string

      The cache key to retrieve

    Returns Promise<null | T>

    The cached value or null if not found or expired

getStats

Abstracthas

  • has(key): Promise<boolean>

  • Checks if a key exists in the cache and is not expired. Must be implemented by concrete cache classes.

    Parameters

    • key: string

      The cache key to check

    Returns Promise<boolean>

    True if the key exists and is valid

ProtectedisExpired

  • isExpired(entry): boolean
  • Protected

    Checks if a cache entry has expired based on its expiration timestamp.

    Parameters

    Returns boolean

    True if the entry has expired

Abstractkeys

  • keys(): Promise<string[]>

  • Returns all keys currently stored in the cache. Must be implemented by concrete cache classes.

    Returns Promise<string[]>

    Array of all cache keys

Protectedlog

  • log(message, data?): void
  • Protected

    Logs a message if verbose logging is enabled.

    Parameters

    • message: string

      The log message

    • Optionaldata: any

      Optional additional data to log

    Returns void

resetStats

  • resetStats(): void

  • Resets all cache statistics to zero.

    Returns void

Abstractset

  • set(key, value, options?): Promise<void>

  • Stores a value in the cache with optional configuration. Must be implemented by concrete cache classes.

    Parameters

    Returns Promise<void>

Abstractsize

  • size(): Promise<number>

  • Returns the number of entries in the cache. Must be implemented by concrete cache classes.

    Returns Promise<number>

    Current cache size

ProtectedupdateStats

  • updateStats(operation, context?): void
  • Protected

    Updates cache statistics for performance monitoring.

    Parameters

    • operation:
          | "set"
          | "delete"
          | "hit"
          | "miss"

      The type of operation that occurred

    • Optionalcontext: {
          fullKey?: string;
          key?: string;
          reason?: string;
          [key: string]: any;
      }

      Additional context for hit/miss logging

      • [key: string]: any
      • OptionalfullKey?: string
      • Optionalkey?: string
      • Optionalreason?: string

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods