Class ModuleEventHandler<E>

Type Parameters

E extends AcceptedEventTypes

Hierarchy

ModuleBaseHandler
- ModuleEventHandler

Index

Constructors

Properties

execute once type

Methods

isAutocompleteHandler isButtonHandler isCommandHandler isEventHandler isMenuCommandHandler isMessageCommandHandler isModalSubmitHandler isSelectMenuHandler isUnconfiguredHandler setEvent setExecute setOnce validate

Constructors

constructor

new ModuleEventHandler<E>(): ModuleEventHandler<E>
Type Parameters
- E extends AcceptedEventTypes
Returns ModuleEventHandler<E>
Inherited from ModuleBaseHandler.constructor

Properties

execute

execute: GenericEventExecuteFunction<keyof ClientEvents>

once

once: boolean = false

`Readonly`type

type: string = ...

Methods

isAutocompleteHandler

isAutocompleteHandler(): this is ModuleAutocompleteHandler
Checks if this handler is an autocomplete handler.

Returns this is ModuleAutocompleteHandler
Whether this handler is an autocomplete handler.
Inherited from ModuleBaseHandler.isAutocompleteHandler
- Defined in src/ModuleHandlers/ModuleBaseHandler.ts:56

isButtonHandler

isButtonHandler(): this is ModuleButtonHandler
Checks if this handler is a button handler.

Returns this is ModuleButtonHandler
Whether this handler is a button handler.
Inherited from ModuleBaseHandler.isButtonHandler
- Defined in src/ModuleHandlers/ModuleBaseHandler.ts:64

isCommandHandler

isCommandHandler(): this is ModuleCommandHandler
Checks if this handler is a command handler.

Returns this is ModuleCommandHandler
Whether this handler is a command handler.
Inherited from ModuleBaseHandler.isCommandHandler
- Defined in src/ModuleHandlers/ModuleBaseHandler.ts:72

isEventHandler

isEventHandler(): this is ModuleEventHandler<AcceptedEventTypes>
Checks if this handler is an event handler.

Returns this is ModuleEventHandler<AcceptedEventTypes>
Whether this handler is an event handler.
Inherited from ModuleBaseHandler.isEventHandler
- Defined in src/ModuleHandlers/ModuleBaseHandler.ts:48

isMenuCommandHandler

isMenuCommandHandler(): this is ModuleMenuCommandHandler
Checks if this handler is a menu command handler.

Returns this is ModuleMenuCommandHandler
Whether this handler is a menu command handler.
Inherited from ModuleBaseHandler.isMenuCommandHandler
- Defined in src/ModuleHandlers/ModuleBaseHandler.ts:80

isMessageCommandHandler

isMessageCommandHandler(): this is ModuleMessageCommandHandler
Checks if this handler is a message command handler.

Returns this is ModuleMessageCommandHandler
Whether this handler is a message command handler.
Inherited from ModuleBaseHandler.isMessageCommandHandler
- Defined in src/ModuleHandlers/ModuleBaseHandler.ts:104

isModalSubmitHandler

isModalSubmitHandler(): this is ModuleModalSubmitHandler
Checks if this handler is a modal submit handler.

Returns this is ModuleModalSubmitHandler
Whether this handler is a modal submit handler.
Inherited from ModuleBaseHandler.isModalSubmitHandler
- Defined in src/ModuleHandlers/ModuleBaseHandler.ts:88

isSelectMenuHandler

isSelectMenuHandler(): this is ModuleSelectMenuHandler
Checks if this handler is a select menu handler.

Returns this is ModuleSelectMenuHandler
Whether this handler is a select menu handler.
Inherited from ModuleBaseHandler.isSelectMenuHandler
- Defined in src/ModuleHandlers/ModuleBaseHandler.ts:96

isUnconfiguredHandler

isUnconfiguredHandler(): this is ModuleBaseHandler
Checks if this handler is an unconfigured handler.

Returns this is ModuleBaseHandler
Whether this handler is an unconfigured handler.
Inherited from ModuleBaseHandler.isUnconfiguredHandler
- Defined in src/ModuleHandlers/ModuleBaseHandler.ts:40

setEvent

setEvent<K>(_event): ModuleEventHandler<K>
Sets the event for this handler.
Type Parameters
- K extends keyof ClientEvents
Parameters
- _event: K
  The event.
Returns ModuleEventHandler<K>
This instance for chaining.
- Defined in src/ModuleHandlers/ModuleEventHandler.ts:34

setExecute

setExecute(execute): this
Sets the execute function for this handler.
Parameters
- execute: E extends keyof ClientEvents
  ? GenericEventExecuteFunction<E<E>>
  : GenericExecuteFunction
  The execute function.
Returns this
This instance for chaining.
Overrides ModuleBaseHandler.setExecute
- Defined in src/ModuleHandlers/ModuleEventHandler.ts:41

setOnce

setOnce(once): this
Set whether this event handler should only be called once.
Parameters
- once: boolean
  Whether this event handler should only be called once.
Returns this
This instance for chaining.
- Defined in src/ModuleHandlers/ModuleEventHandler.ts:24

validate

validate(): boolean
Validates the handler, ensuring the execute function is set.

Returns boolean
Whether the handler is valid.
Overrides ModuleBaseHandler.validate
- Defined in src/ModuleHandlers/ModuleEventHandler.ts:50