Class Listener`Abstract`

Represents a listener.

Hierarchy (View Summary)

AkairoModule<ListenerHandler, Listener, ListenerHandlerEvents>
- Listener

Index

Constructors

Properties

category categoryID client emitter event filepath handler id type

Methods

exec reload remove toString

Constructors

constructor

new Listener(id: string, options: ListenerOptions): Listener
Parameters
- id: string
  Listener ID.
- options: ListenerOptions
  Options for the listener.
Returns Listener
Overrides AkairoModule.constructor
- Defined in src/struct/listeners/Listener.ts:31

Properties

category

category: Category<string, Listener>

The category this module belongs to.

categoryID

categoryID: string

The ID of the category this module belongs to.

client

client: AkairoClient

The client thant instantiated this module.

emitter

emitter: string | EventEmitter<DefaultEventMap>

The event emitter.

event

event: string

The event name listened to.

filepath

filepath: string

The filepath of this module.

handler

handler: ListenerHandler

The handler for this module.

id

id: string

The ID of this module.

type

type: ListenerType

Type of listener.

Methods

`Abstract`exec

exec(...args: any[]): any
Executes the listener.
Parameters
- ...args: any[]
  Arguments.
Returns any
- Defined in src/struct/listeners/Listener.ts:46

reload

reload(): Promise<Listener>
Reloads this module.

Returns Promise<Listener>
Inherited from AkairoModule.reload
- Defined in src/struct/AkairoModule.ts:66

remove

remove(): Listener
Removes this module.

Returns Listener
Inherited from AkairoModule.remove
- Defined in src/struct/AkairoModule.ts:73

toString

toString(): string
Returns the ID of this module.

Returns string
Inherited from AkairoModule.toString
- Defined in src/struct/AkairoModule.ts:80