Class RedisCacheAdapter

Concrete cache adapter implementation utilizing Redis via ioredis.

Implements

CacheAdapterInterface

Index

Constructors

Accessors

Methods

del get getBuffer keys set

Constructors

constructor

new RedisCacheAdapter(options?: string | RedisOptions): RedisCacheAdapter
Parameters
- Optionaloptions: string | RedisOptions
Returns RedisCacheAdapter
- Defined in RedisCacheAdapter.ts:11

Accessors

manager

get manager(): RedisManager
Returns RedisManager
- Defined in RedisCacheAdapter.ts:15

Methods

del

del(...keys: string[]): Promise<void>
Deletes one or more keys from the cache.
Parameters
- ...keys: string[]
  Rest array of keys to remove.
Returns Promise<void>
Implementation of CacheAdapterInterface.del
- Defined in RedisCacheAdapter.ts:59

get

get(key: string): Promise<string | null>
Retrieves a string value by key.
Parameters
- key: string
  The cache key.
Returns Promise<string | null>
The resolved string or null.
Implementation of CacheAdapterInterface.get
- Defined in RedisCacheAdapter.ts:25

getBuffer

getBuffer(key: string): Promise<Buffer<ArrayBufferLike> | null>
Retrieves a raw buffer value by key.
Parameters
- key: string
  The cache key.
Returns Promise<Buffer<ArrayBufferLike> | null>
The resolved Buffer or null.
Implementation of CacheAdapterInterface.getBuffer
- Defined in RedisCacheAdapter.ts:35

keys

keys(pattern: string): Promise<string[]>
Locates all cache keys matching a specific pattern.
Parameters
- pattern: string
  Glob-style key matcher.
Returns Promise<string[]>
List of matching keys.
Implementation of CacheAdapterInterface.keys
- Defined in RedisCacheAdapter.ts:71

set

set(
    key: string,
    value: string | Buffer<ArrayBufferLike>,
    ttlSeconds?: number,
): Promise<void>
Stores a value in Redis with an optional TTL.
Parameters
- key: string
  The target key.
- value: string | Buffer<ArrayBufferLike>
  String or binary payload.
- OptionalttlSeconds: number
  Expiration time in seconds.
Returns Promise<void>
Implementation of CacheAdapterInterface.set
- Defined in RedisCacheAdapter.ts:46