Class RedisCacheStore

Redis cache store (via ioredis).

Shares cache across instances/processes. Values are JSON-serialized; TTLs use native key expiry; tags are tracked in Redis sets so invalidation is a set lookup + delete. ioredis is imported lazily and is an optional peer dependency, so this module carries no Redis weight until a Redis store is actually used.

Implements

CacheStore

Index

Constructors

constructor

new RedisCacheStore(options: RedisStoreOptions): RedisCacheStore
Parameters
- options: RedisStoreOptions
  The Redis store options.
Returns RedisCacheStore

Properties

`Readonly`name

name: string

A human-readable store name (e.g. 'memory', 'redis').

Methods

add

add<T = unknown>(
    key: string,
    value: T,
    options?: CacheSetOptions,
): Promise<boolean>
Type Parameters
- T = unknown
Parameters
- key: string
- value: T
- options: CacheSetOptions = {}
Returns Promise<boolean>

Inherit Doc

Implementation of CacheStore.add

clear

clear(): Promise<void>

Returns Promise<void>

Inherit Doc

Implementation of CacheStore.clear

decrement

decrement(key: string, amount?: number): Promise<number>
Parameters
- key: string
- amount: number = 1
Returns Promise<number>

Inherit Doc

Implementation of CacheStore.decrement

delete

delete(key: string): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>

Inherit Doc

Implementation of CacheStore.delete

get

get<T = unknown>(key: string): Promise<T>
Type Parameters
- T = unknown
Parameters
- key: string
Returns Promise<T>

Inherit Doc

Implementation of CacheStore.get

has

has(key: string): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>

Inherit Doc

Implementation of CacheStore.has

increment

increment(key: string, amount?: number): Promise<number>
Parameters
- key: string
- amount: number = 1
Returns Promise<number>

Inherit Doc

Implementation of CacheStore.increment

invalidateTags

invalidateTags(tags: string[]): Promise<void>
Parameters
- tags: string[]
Returns Promise<void>

Inherit Doc

Implementation of CacheStore.invalidateTags

pull

pull<T = unknown>(key: string): Promise<T>
Type Parameters
- T = unknown
Parameters
- key: string
Returns Promise<T>

Inherit Doc

Implementation of CacheStore.pull

remember

remember<T = unknown>(
    key: string,
    factory: () => T | Promise<T>,
    options?: CacheSetOptions,
): Promise<T>
Type Parameters
- T = unknown
Parameters
- key: string
- factory: () => T | Promise<T>
- options: CacheSetOptions = {}
Returns Promise<T>

Inherit Doc

Implementation of CacheStore.remember

set

set<T = unknown>(
    key: string,
    value: T,
    options?: CacheSetOptions,
): Promise<void>
Type Parameters
- T = unknown
Parameters
- key: string
- value: T
- options: CacheSetOptions = {}
Returns Promise<void>

Inherit Doc

Implementation of CacheStore.set

`Static`create

create(options: RedisStoreOptions): RedisCacheStore
Create a Redis store.
Parameters
- options: RedisStoreOptions
  The Redis store options.
Returns RedisCacheStore
A new store.

Class RedisCacheStore

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RedisCacheStore

Properties

Readonlyname

Methods

add

Type Parameters

Parameters

Returns Promise<boolean>

Inherit Doc

clear

Returns Promise<void>

Inherit Doc

decrement

Parameters

Returns Promise<number>

Inherit Doc

delete

Parameters

Returns Promise<boolean>

Inherit Doc

get

Type Parameters

Parameters

Returns Promise<T>

Inherit Doc

has

Parameters

Returns Promise<boolean>

Inherit Doc

increment

Parameters

Returns Promise<number>

Inherit Doc

invalidateTags

Parameters

Returns Promise<void>

Inherit Doc

pull

Type Parameters

Parameters

Returns Promise<T>

Inherit Doc

remember

Type Parameters

Parameters

Returns Promise<T>

Inherit Doc

set

Type Parameters

Parameters

Returns Promise<void>

Inherit Doc

Staticcreate

Parameters

Returns RedisCacheStore

Settings

On This Page

`Readonly`name

`Static`create