@pixel-brewery/archipel-platform-caching

Classes

Class	Description
CachingHealthIndicator	Health indicator for the caching layer.
MemoryLayeredCache	In-memory layered cache with LRU eviction, TTL expiration and optional stale-while-revalidate support. Falls back to an asynchronous loader function on cache misses.
MemoryWindowedCounter	Windowed counter held in the memory of one process.
NoopCacheMetricsRecorder	No-op implementation of ICacheMetricsRecorder used as the default when no external metrics backend is configured.
PostgresWindowedCounter	Windowed counter kept in the application's own PostgreSQL database.
RedisLayeredCache	Redis-backed layered cache implementation. Falls back to an asynchronous loader function when the requested key is not present in Redis.
RedisWindowedCounter	Windowed counter shared by every instance through Redis.

Interfaces

Interface	Description
ICacheMetricsRecorder	Metrics recorder for cache operations. Implementations can forward measurements to Prometheus, OpenTelemetry, or any other backend.
ICacheStats	Cache statistics snapshot returned by cache implementations.
ICreateWindowedCounterOptions	Options for createWindowedCounter.
ILayeredCache	Generic layered cache contract supporting synchronous and asynchronous access patterns with optional warm-up and statistics.
ILayeredCacheOptions	Configuration options for MemoryLayeredCache.
IPostgresWindowedCounterOptions	Configuration options for PostgresWindowedCounter.
IRedisLayeredCacheOptions	Configuration options for RedisLayeredCache.
IRedisWindowedCounterOptions	Configuration options for RedisWindowedCounter.
ISqlClient	Minimal contract of a SQL client able to run a parameterized statement.
IWindowedCounter	Counts occurrences inside a fixed time window.
IWindowedCounterResult	Result of a windowed counter operation.

Variables

Variable	Description
CACHE_DEFAULT_TTL_MS	Default cache TTL in milliseconds applied when no provider-specific TTL is configured.
CACHE_MAX_ENTRIES	Maximum number of entries retained in an in-memory cache (LRU limit).
CACHE_STALE_WHILE_REVALIDATE	Whether expired entries are served while a background refresh is in progress.
PLATFORM_CACHING_CONFIG_ENTRIES	All configuration entries required by platform-caching.
REDIS_CONFIG_ENTRIES	Configuration entries required by the Redis caching provider.
REDIS_KEY_PREFIX	Key prefix applied to all Redis keys managed by the cache instance.
REDIS_TTL_SECONDS	TTL in seconds applied to every stored Redis entry.
REDIS_URL	Redis connection URL (e.g. redis://localhost:6379).

Functions

Function	Description
createWindowedCounter	Creates the windowed counter that fits the configured infrastructure.