Skip to content

RedisCollection

Defined in: packages/collection/src/redis.ts:178

A key-value collection kept in Redis and shared by every process that opens it with the same name, with the retention policy of Collection: a TTL (sliding by default), a maxSize evicting the least recently used across every process, and onEvict.

Every operation is one atomic script, so two processes never see a half-applied write. The API is async, and values travel as strings (JSON by default).

const sessions = new RedisCollection<Session>({
client: new Bun.RedisClient(process.env.REDIS_URL),
name: "sessions",
ttl: 15 * 60_000,
maxSize: 10_000,
});
await sessions.set(userId, session);
const session = await sessions.get(userId); // from any process

V = unknown

new RedisCollection<V>(options): RedisCollection<V>

Defined in: packages/collection/src/redis.ts:196

RedisCollectionOptions<V>

RedisCollection<V>

readonly name: string

Defined in: packages/collection/src/redis.ts:194

The collection’s name.

get stats(): CollectionStats

Defined in: packages/collection/src/redis.ts:225

Hits, misses and removals seen by this instance.

CollectionStats

clear(): Promise<number>

Defined in: packages/collection/src/redis.ts:367

Removes every entry. Returns how many there were.

Promise<number>


delete(key): Promise<boolean>

Defined in: packages/collection/src/redis.ts:361

Removes key. Returns whether it was present.

string | number

Promise<boolean>


ensure(key, factory, ttl?): Promise<V>

Defined in: packages/collection/src/redis.ts:337

Returns the value for key, or stores and returns what factory gives. If two processes race, one value wins and both get it.

string | number

(key) => V | Promise<V>

number

Promise<V>


entries(): Promise<[string, V][]>

Defined in: packages/collection/src/redis.ts:385

Live entries, least recently used first. Reading them does not count as a use.

Promise<[string, V][]>


get(key): Promise<V | undefined>

Defined in: packages/collection/src/redis.ts:275

The value for key, or undefined. Marks it recently used and, with slide, restarts its TTL window.

string | number

Promise<V | undefined>


has(key): Promise<boolean>

Defined in: packages/collection/src/redis.ts:303

Whether key is present (does not count as a use).

string | number

Promise<boolean>


keys(): Promise<string[]>

Defined in: packages/collection/src/redis.ts:378

Live keys, least recently used first.

Promise<string[]>


peek(key): Promise<V | undefined>

Defined in: packages/collection/src/redis.ts:294

The value without marking it used or restarting its window.

string | number

Promise<V | undefined>


set(key, value, ttl?): Promise<RedisCollection<V>>

Defined in: packages/collection/src/redis.ts:308

Stores value with the default TTL, or ttl ms (0: never expires).

string | number

V

number

Promise<RedisCollection<V>>


setWithoutTTL(key, value): Promise<RedisCollection<V>>

Defined in: packages/collection/src/redis.ts:329

Stores value with no expiry. It still counts towards maxSize.

string | number

V

Promise<RedisCollection<V>>


size(): Promise<number>

Defined in: packages/collection/src/redis.ts:373

Live entries.

Promise<number>


ttlRemaining(key): Promise<number | undefined>

Defined in: packages/collection/src/redis.ts:409

Milliseconds left before key expires; undefined when it never expires or is absent.

string | number

Promise<number | undefined>


values(): Promise<V[]>

Defined in: packages/collection/src/redis.ts:404

Live values, least recently used first.

Promise<V[]>