Interfacecorev0.1.0-next.5

GateContextBase

The transport-agnostic gate context, the scalar identity of the acting user resolvable from any transport's payload. Every field except corecore is nullable, since an event or DM may carry no guild or member. Each transport extends it with its own arm. For example, the gateway adds the djs useruser/guildguild/membermember objects and the live interaction or event payload.

interface GateContextBase

interface GateContextBase

// a gate reading only the base fields fits any handler on any transport
const NeedsGuild = defineGate('NeedsGuild', (ctx: GateContextBase) => {
    if (!ctx.guildId) throw new NotInGuild();
});

// a gate reading only the base fields fits any handler on any transport
const NeedsGuild = defineGate('NeedsGuild', (ctx: GateContextBase) => {
    if (!ctx.guildId) throw new NotInGuild();
});

appPermissions

The bot's permissions in the invoked channel, the wire app_permissionsapp_permissions value. Null on gateway events.

readonly appPermissions: bigint | null

readonly appPermissions: bigint | null

channelId

The channel id, or null when the source carries none.

readonly channelId: string | null

readonly channelId: string | null

core

Gates read the config and the rate limiter through it.

readonly core: CoreBase

readonly core: CoreBase

guildId

The guild id, or null outside a guild.

readonly guildId: string | null

readonly guildId: string | null

memberPermissions

The member's permission bits, or null outside a guild. On an interaction these are the channel-scoped permissions the payload contains, on a gateway event the member's guild-level ones.

readonly memberPermissions: bigint | null

readonly memberPermissions: bigint | null

memberRoleIds

The member's role ids without the everyone role, the shape a raw interaction payload contains. Empty outside a guild or when the source contains none.

readonly memberRoleIds: readonly string[]

readonly memberRoleIds: readonly string[]

routeId

The dispatched handler as kind:routekind:route (slash:dailyslash:daily, button:confirmbutton:confirm), or null off a route (a plain event handler, or a gate run outside a handler). runHandlerGatesrunHandlerGates sets it from the handler's metadata. CooldownCooldown uses it so its window is stable across restarts and isolates.

readonly routeId: string | null

readonly routeId: string | null

userId

The acting user's id, or null on an event that carries none.

readonly userId: string | null

readonly userId: string | null