EventGateContext

The event arm. It extends GuildPermissionsContext with the event payload and the djs objects derived from it. Names is the event(s) the gate supports, inferred from the ctx annotation, so a gate that reads one event's payload is rejected on a handler for a different event. The default supports every event.

interface EventGateContext<
    Names extends ValidNonInteractionKeys = ValidNonInteractionKeys
> extends GuildPermissionsContext

import { Events } from 'discord.js';

// gate keyed to one event, so payload is typed to that event's args tuple
const OnMessage = defineGate('msg', (ctx: EventGateContext<Events.MessageCreate>) => {
    void ctx.payload; // [Message]
});

Names

The event name or names the gate reads, typing payload to that event's args tuple.

Names extends ValidNonInteractionKeys = ValidNonInteractionKeys

core

The running framework, with the gateway's bot and bus.

readonly core: Core

eventName

The event being handled.

readonly eventName: Names

guild

The guild derived from the payload, or null.

readonly guild: Guild | null

kind

The literal 'event', narrow on it before reading payload.

readonly kind: 'event'

member

The acting member derived from the payload, or null.

readonly member: GuildMember | null

payload

The event's arguments, typed to that event's args tuple.

readonly payload: ClientEvents[Names]

user

The acting user derived from the payload, or null when the event carries none.

readonly user: User | null