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 Gatewayconst guild = await shared.guild(id); // from any processWrites 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).
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RedisCache(
options):RedisCache
Defined in: packages/core/src/redis-cache.ts:96
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”RedisCache
Methods
Section titled “Methods”attach()
Section titled “attach()”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.
Parameters
Section titled “Parameters”source
Section titled “source”Returns
Section titled “Returns”this
channel()
Section titled “channel()”channel<
T>(channelId):Promise<T|undefined>
Defined in: packages/core/src/redis-cache.ts:488
A channel or thread, with its guild_id.
Type Parameters
Section titled “Type Parameters”T extends object = Payload
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
Returns
Section titled “Returns”Promise<T | undefined>
channels()
Section titled “channels()”channels<
T>(guildId):Promise<T[]>
Defined in: packages/core/src/redis-cache.ts:495
Every channel and thread of a guild.
Type Parameters
Section titled “Type Parameters”T extends object = Payload
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”Promise<T[]>
detach()
Section titled “detach()”detach(
source?):this
Defined in: packages/core/src/redis-cache.ts:131
Stops mirroring source (or every source).
Parameters
Section titled “Parameters”source?
Section titled “source?”Returns
Section titled “Returns”this
diagnostics()
Section titled “diagnostics()”diagnostics():
RedisCacheDiagnostics
Defined in: packages/core/src/redis-cache.ts:146
Returns
Section titled “Returns”flush()
Section titled “flush()”flush():
Promise<void>
Defined in: packages/core/src/redis-cache.ts:141
Resolves when every write queued so far has been applied (or failed).
Returns
Section titled “Returns”Promise<void>
guild()
Section titled “guild()”guild<
T>(guildId):Promise<T|undefined>
Defined in: packages/core/src/redis-cache.ts:473
The guild document (without its channels, roles and members).
Type Parameters
Section titled “Type Parameters”T extends object = Payload
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”Promise<T | undefined>
guildIds()
Section titled “guildIds()”guildIds():
Promise<string[]>
Defined in: packages/core/src/redis-cache.ts:480
Ids of every guild in the cache.
Returns
Section titled “Returns”Promise<string[]>
handle()
Section titled “handle()”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).
Parameters
Section titled “Parameters”string
unknown
Returns
Section titled “Returns”void
member()
Section titled “member()”member<
T>(guildId,userId):Promise<T|undefined>
Defined in: packages/core/src/redis-cache.ts:517
A member, with its user attached.
Type Parameters
Section titled “Type Parameters”T extends object = Payload
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
userId
Section titled “userId”string
Returns
Section titled “Returns”Promise<T | undefined>
members()
Section titled “members()”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.
Type Parameters
Section titled “Type Parameters”T extends object = Payload
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”Promise<T[]>
role()
Section titled “role()”role<
T>(guildId,roleId):Promise<T|undefined>
Defined in: packages/core/src/redis-cache.ts:499
Type Parameters
Section titled “Type Parameters”T extends object = Payload
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
roleId
Section titled “roleId”string
Returns
Section titled “Returns”Promise<T | undefined>
roles()
Section titled “roles()”roles<
T>(guildId):Promise<T[]>
Defined in: packages/core/src/redis-cache.ts:506
Type Parameters
Section titled “Type Parameters”T extends object = Payload
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”Promise<T[]>
user()
Section titled “user()”user<
T>(userId):Promise<T|undefined>
Defined in: packages/core/src/redis-cache.ts:510
Type Parameters
Section titled “Type Parameters”T extends object = Payload
Parameters
Section titled “Parameters”userId
Section titled “userId”string
Returns
Section titled “Returns”Promise<T | undefined>