Class RedisStore

Redis-backed cache store implementation.

Values are JSON-serialized before storage so that arbitrary types can be cached. The prefix is applied at construction time and used exclusively by clear() to scope the SCAN+DEL to this instance's keys.

Since

0.1.0

Implements

CacheStore

Index

Constructors

constructor

Methods

clear connect delete disconnect get has isHealthy isReady set

Constructors

constructor

new RedisStore(
    prefix: string,
    options?: {
        client?: IRedisClient;
        commandTimeoutMs?: number;
        connectionErrorReporter?: ConnectionErrorReporter;
        url?: string;
    },
): RedisStore
Parameters
- prefix: string
  Key prefix for scoping clear() to this instance's keys. An empty prefix would scan * in clear() — acceptable only for single- tenant Redis deployments.
- Optionaloptions: {
      client?: IRedisClient;
      commandTimeoutMs?: number;
      connectionErrorReporter?: ConnectionErrorReporter;
      url?: string;
  }
  Redis connection and client options
  - Optionalclient?: IRedisClient
    
    Injected ioredis-compatible client (bypasses lazy import)
  - OptionalcommandTimeoutMs?: number
    
    Bound on one Redis command of the client this store BUILDS (default DEFAULT_REDIS_COMMAND_TIMEOUT_MS; 0 disables it). Never applied to an injected client.
  - OptionalconnectionErrorReporter?: ConnectionErrorReporter
    
    Receives the connection errors (ioredis 'error' events) of the client this store BUILDS, instead of ioredis printing each one to the console. Never attached to an injected client. CachePlugin supplies one backed by its logger.
  - Optionalurl?: string
    
    Redis connection URL (default redis://localhost:6379)
Returns RedisStore

Throws
If commandTimeoutMs is not a number from 0 to 2147483647
- Defined in packages/cache-plugin/src/stores/redis-store.ts:199

Methods

clear

clear(): Promise<void>
Remove all entries scoped to this backend's prefix.

The prefix is provided at construction time (not per-call), so each backend can scope the clear appropriately:
- Redis: SCAN MATCH ${prefix}* + batch DEL
- Memory: empty the internal map (each plugin instance owns its own map, so it naturally holds only this prefix's keys)
Returns Promise<void>
Implementation of CacheStore.clear
- Defined in packages/cache-plugin/src/stores/redis-store.ts:324

connect

connect(): Promise<void>
Establish the backend connection (if applicable).

Returns Promise<void>
Implementation of CacheStore.connect
- Defined in packages/cache-plugin/src/stores/redis-store.ts:215

delete

delete(key: string): Promise<boolean>
Delete a value. The key is already-prefixed by CacheService.
Parameters
- key: string
  Already-prefixed cache key
Returns Promise<boolean>
true if removed
Implementation of CacheStore.delete
- Defined in packages/cache-plugin/src/stores/redis-store.ts:300

disconnect

disconnect(): Promise<void>
Gracefully disconnect.

Returns Promise<void>
Implementation of CacheStore.disconnect
- Defined in packages/cache-plugin/src/stores/redis-store.ts:229

get

get<T>(key: string): Promise<T | null>
Read a value. The key is already-prefixed by CacheService.
Type Parameters
- T
  Expected value type
Parameters
- key: string
  Already-prefixed cache key
Returns Promise<T | null>
The deserialized value, or null when absent/expired
Implementation of CacheStore.get
- Defined in packages/cache-plugin/src/stores/redis-store.ts:264

has

has(key: string): Promise<boolean>
Check existence. The key is already-prefixed by CacheService.
Parameters
- key: string
  Already-prefixed cache key
Returns Promise<boolean>
true if present and unexpired
Implementation of CacheStore.has
- Defined in packages/cache-plugin/src/stores/redis-store.ts:312

isHealthy

isHealthy(): Promise<boolean>
Probes Redis with a typed ping() (M90b). false after disconnect — a store with no client cannot answer — and otherwise true only when the server answers, a rejection being unreachability.

The plugin caches and bounds this probe; this method is the raw per-call question.

Returns Promise<boolean>
true when Redis answers ping

Since
0.5.0
Implementation of CacheStore.isHealthy
- Defined in packages/cache-plugin/src/stores/redis-store.ts:252

isReady

isReady(): boolean
Reports whether the backend is ready for operations.

Returns boolean
Implementation of CacheStore.isReady
- Defined in packages/cache-plugin/src/stores/redis-store.ts:237

set

set<T>(key: string, value: T, ttlSeconds?: number): Promise<void>
Write a value. The key is already-prefixed by CacheService.
Type Parameters
- T
  Value type
Parameters
- key: string
  Already-prefixed cache key
- value: T
  Value to store
- OptionalttlSeconds: number
  Optional TTL in seconds
Returns Promise<void>
Implementation of CacheStore.set
- Defined in packages/cache-plugin/src/stores/redis-store.ts:284

Class RedisStore

Since

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Optionalclient?: IRedisClient

OptionalcommandTimeoutMs?: number

OptionalconnectionErrorReporter?: ConnectionErrorReporter

Optionalurl?: string

Returns RedisStore

Throws

Methods

clear

Returns Promise<void>

connect

Returns Promise<void>

delete

Parameters

Returns Promise<boolean>

disconnect

Returns Promise<void>

get

Type Parameters

Parameters

Returns Promise<T | null>

has

Parameters

Returns Promise<boolean>

isHealthy

Returns Promise<boolean>

Since

isReady

Returns boolean

set

Type Parameters

Parameters

Returns Promise<void>

Settings

On This Page

`Optional`client?: IRedisClient

`Optional`commandTimeoutMs?: number

`Optional`connectionErrorReporter?: ConnectionErrorReporter

`Optional`url?: string