EventMiddleware

Base class for Discord event middleware.

Middleware runs before event handlers and can stop the event by throwing a Silence. Unlike EventHandler, it runs the SAME for every event it is registered for, so it has no match. Specify a single event in the generic and { events } to read this.event fully typed. Span several events (or omit { events } for a catchall) and this.event narrows to never, read this.eventName and do work that does not depend on the payload shape. A middleware that needs each event's payload is written one event per class.

abstract class EventMiddleware<
    EventName extends ValidNonInteractionKeys = ValidNonInteractionKeys
> extends BaseHandler<ClientEvents[EventName]>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the EventMiddleware class

EventMiddleware(
    event: ClientEvents[EventName],
    core: Core,
    eventName?: EventName
)

Showing members with Protected visibility and higher.

Methods

getEvent()

EventName

One or more ClientEvents keys. Defaults to every event (catchall).

EventName extends ValidNonInteractionKeys = ValidNonInteractionKeys

event

protected readonly event: SingleEventPayload<EventName>

eventName

The event that fired this middleware. Read it on a catchall or multi-event middleware, where this.event is never, to do work that does not depend on the payload shape. A single-event middleware reads this.event directly and does not need this.

protected eventName: EventName

getEvent()

getEvent(): ValidEvent

Inherited from:BaseHandler