Event
Represents an event.
Constructor
new Event(client, 'ready', options);
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| client | ShewenyClient | The client. | None | No |
| name | String | The name of the event | None | No |
| options | EventOptions | The options of the event | None | No |
Properties
client
The framework client.
Return : ShewenyClient
description
The description of the event.
Return : String
emitter
The emitter of the event.
Return : EventEmitter
manager
The manager of this structure.
Return : EventsManager
name
The name of the event.
Return : String
once
If the event is emitted juste once or not.
Return : Boolean
path
The path of the file.
Return : String
Methods
client
The framework client.
Return : ShewenyClient
description
The description of the event.
Return : String
emitter
If the event is emitted juste once or not.
Return : EventEmitter
manager
The manager of this structure.
Return : EventsManager
name
The name of the event.
Return : String
once
If the event is emitted juste once or not.
Return : Boolean
path
The path of the file.
Return : String PS D:\Development\Projects\Sheweny\website> node .\sort-content.js
before()
Executed before event checks.
Parameters :
| Name | Type | Description |
|---|---|---|
| ...args | args Events | Args for events |
Return : Promise<any> | any
[abstract] execute()
The execution of event.
Parameters :
| Name | Type | Description |
|---|---|---|
| ...args | args Events | Args for events |
Return : Promise<any> | any
[async] register()
Register the event.
Return : Promise<Event> | Null
[async] reload()
Reload a event of bot.
Return : Promise<Event> | Null
unregister()
Unregister a event from the bot.
Return : Boolean