Skip to content

RedisCache

Defined in: packages/core/src/redis-cache.ts:80

A Redis mirror of guilds, channels, roles, members and users.

const shared = new RedisCache({ client: new Bun.RedisClient(process.env.REDIS_URL) });
shared.attach(client); // or each shard's Gateway
const guild = await shared.guild(id); // from any process

Writes for one guild are applied in Gateway order; a failed write is reported through onError and never reaches the Gateway. Reads throw on a Redis error. Values are raw Discord payloads (APIGuild-shaped JSON).

new RedisCache(options): RedisCache

Defined in: packages/core/src/redis-cache.ts:96

RedisCacheOptions

RedisCache

attach(source): this

Defined in: packages/core/src/redis-cache.ts:115

Mirrors the dispatches of a Client (its raw event) or of one Gateway (RAW). Attach each shard’s Gateway, or the client once.

RawDispatchSource

this


channel<T>(channelId): Promise<T | undefined>

Defined in: packages/core/src/redis-cache.ts:488

A channel or thread, with its guild_id.

T extends object = Payload

string

Promise<T | undefined>


channels<T>(guildId): Promise<T[]>

Defined in: packages/core/src/redis-cache.ts:495

Every channel and thread of a guild.

T extends object = Payload

string

Promise<T[]>


detach(source?): this

Defined in: packages/core/src/redis-cache.ts:131

Stops mirroring source (or every source).

RawDispatchSource

this


diagnostics(): RedisCacheDiagnostics

Defined in: packages/core/src/redis-cache.ts:146

RedisCacheDiagnostics


flush(): Promise<void>

Defined in: packages/core/src/redis-cache.ts:141

Resolves when every write queued so far has been applied (or failed).

Promise<void>


guild<T>(guildId): Promise<T | undefined>

Defined in: packages/core/src/redis-cache.ts:473

The guild document (without its channels, roles and members).

T extends object = Payload

string

Promise<T | undefined>


guildIds(): Promise<string[]>

Defined in: packages/core/src/redis-cache.ts:480

Ids of every guild in the cache.

Promise<string[]>


handle(event, data): void

Defined in: packages/core/src/redis-cache.ts:158

Applies one Gateway dispatch. attach() calls it; call it yourself to feed events from elsewhere (an IPC relay, a replay).

string

unknown

void


member<T>(guildId, userId): Promise<T | undefined>

Defined in: packages/core/src/redis-cache.ts:517

A member, with its user attached.

T extends object = Payload

string

string

Promise<T | undefined>


members<T>(guildId): Promise<T[]>

Defined in: packages/core/src/redis-cache.ts:530

Every cached member of a guild, with users. Large guilds: mind the size.

T extends object = Payload

string

Promise<T[]>


role<T>(guildId, roleId): Promise<T | undefined>

Defined in: packages/core/src/redis-cache.ts:499

T extends object = Payload

string

string

Promise<T | undefined>


roles<T>(guildId): Promise<T[]>

Defined in: packages/core/src/redis-cache.ts:506

T extends object = Payload

string

Promise<T[]>


user<T>(userId): Promise<T | undefined>

Defined in: packages/core/src/redis-cache.ts:510

T extends object = Payload

string

Promise<T | undefined>