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 processType Parameters
Section titled “Type Parameters”V = unknown
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RedisCollection<
V>(options):RedisCollection<V>
Defined in: packages/collection/src/redis.ts:196
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”RedisCollection<V>
Properties
Section titled “Properties”
readonlyname:string
Defined in: packages/collection/src/redis.ts:194
The collection’s name.
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get stats():
CollectionStats
Defined in: packages/collection/src/redis.ts:225
Hits, misses and removals seen by this instance.
Returns
Section titled “Returns”Methods
Section titled “Methods”clear()
Section titled “clear()”clear():
Promise<number>
Defined in: packages/collection/src/redis.ts:367
Removes every entry. Returns how many there were.
Returns
Section titled “Returns”Promise<number>
delete()
Section titled “delete()”delete(
key):Promise<boolean>
Defined in: packages/collection/src/redis.ts:361
Removes key. Returns whether it was present.
Parameters
Section titled “Parameters”string | number
Returns
Section titled “Returns”Promise<boolean>
ensure()
Section titled “ensure()”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.
Parameters
Section titled “Parameters”string | number
factory
Section titled “factory”(key) => V | Promise<V>
number
Returns
Section titled “Returns”Promise<V>
entries()
Section titled “entries()”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.
Returns
Section titled “Returns”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.
Parameters
Section titled “Parameters”string | number
Returns
Section titled “Returns”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).
Parameters
Section titled “Parameters”string | number
Returns
Section titled “Returns”Promise<boolean>
keys()
Section titled “keys()”keys():
Promise<string[]>
Defined in: packages/collection/src/redis.ts:378
Live keys, least recently used first.
Returns
Section titled “Returns”Promise<string[]>
peek()
Section titled “peek()”peek(
key):Promise<V|undefined>
Defined in: packages/collection/src/redis.ts:294
The value without marking it used or restarting its window.
Parameters
Section titled “Parameters”string | number
Returns
Section titled “Returns”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).
Parameters
Section titled “Parameters”string | number
V
number
Returns
Section titled “Returns”Promise<RedisCollection<V>>
setWithoutTTL()
Section titled “setWithoutTTL()”setWithoutTTL(
key,value):Promise<RedisCollection<V>>
Defined in: packages/collection/src/redis.ts:329
Stores value with no expiry. It still counts towards maxSize.
Parameters
Section titled “Parameters”string | number
V
Returns
Section titled “Returns”Promise<RedisCollection<V>>
size()
Section titled “size()”size():
Promise<number>
Defined in: packages/collection/src/redis.ts:373
Live entries.
Returns
Section titled “Returns”Promise<number>
ttlRemaining()
Section titled “ttlRemaining()”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.
Parameters
Section titled “Parameters”string | number
Returns
Section titled “Returns”Promise<number | undefined>
values()
Section titled “values()”values():
Promise<V[]>
Defined in: packages/collection/src/redis.ts:404
Live values, least recently used first.
Returns
Section titled “Returns”Promise<V[]>