Interfaceseedcordv0.13.0

EventGateContext

The event arm. NamesNames is the event(s) the gate supports, inferred from the ctxctx annotation, so a gate that reads one event's payloadpayload is rejected on a handler for a different event. The default supports every event.

interface EventGateContext<
    Names extends ValidNonInteractionKeys = ValidNonInteractionKeys
> extends GateContextBase

interface EventGateContext<
    Names extends ValidNonInteractionKeys = ValidNonInteractionKeys
> extends GateContextBase

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]
});

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]
});

Properties

channelId
core
eventName
guild
guildId
kind
member
payload
user

Names

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

Names extends ValidNonInteractionKeys = ValidNonInteractionKeys

Names extends ValidNonInteractionKeys = ValidNonInteractionKeys

channelId

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

readonly channelId: string | null

readonly channelId: string | null

Inherited from:GateContextBase

core

The running framework, for reaching the bot, config, the rate limiter, and the bus.

readonly core: Core

readonly core: Core

Inherited from:GateContextBase

eventName

The event being handled.

readonly eventName: Names

readonly eventName: Names

guild

The guild the action happened in, or null in a DM or a guildless event.

readonly guild: Guild | null

readonly guild: Guild | null

Inherited from:GateContextBase

guildId

The guild id, or null outside a guild.

readonly guildId: string | null

readonly guildId: string | null

Inherited from:GateContextBase

kind

Marks the event arm, narrow on it before reading payloadpayload.

readonly kind: 'event'

readonly kind: 'event'

member

The acting member, or null outside a guild or when uncached.

readonly member: GuildMember | null

readonly member: GuildMember | null

Inherited from:GateContextBase

payload

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

readonly payload: ClientEvents[Names]

readonly payload: ClientEvents[Names]

user

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

readonly user: User | null

readonly user: User | null

Inherited from:GateContextBase

Interfaceseedcordv0.13.0

EventGateContext

interface EventGateContext<
    Names extends ValidNonInteractionKeys = ValidNonInteractionKeys
> extends GateContextBase

interface EventGateContext<
    Names extends ValidNonInteractionKeys = ValidNonInteractionKeys
> extends GateContextBase

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]
});

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 payloadpayload to that event's args tuple.

Names extends ValidNonInteractionKeys = ValidNonInteractionKeys

Names extends ValidNonInteractionKeys = ValidNonInteractionKeys

channelId

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

readonly channelId: string | null

readonly channelId: string | null

Inherited from:GateContextBase

core

The running framework, for reaching the bot, config, the rate limiter, and the bus.

readonly core: Core

readonly core: Core

Inherited from:GateContextBase

eventName

The event being handled.

readonly eventName: Names

readonly eventName: Names

guild

The guild the action happened in, or null in a DM or a guildless event.

readonly guild: Guild | null

readonly guild: Guild | null

Inherited from:GateContextBase

guildId

The guild id, or null outside a guild.

readonly guildId: string | null

readonly guildId: string | null

Inherited from:GateContextBase

kind

Marks the event arm, narrow on it before reading payloadpayload.

readonly kind: 'event'

readonly kind: 'event'

member

The acting member, or null outside a guild or when uncached.

readonly member: GuildMember | null

readonly member: GuildMember | null

Inherited from:GateContextBase

payload

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

readonly payload: ClientEvents[Names]

readonly payload: ClientEvents[Names]

user

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

readonly user: User | null

readonly user: User | null

Inherited from:GateContextBase