Constructor
new Peek(fileName)
Parameters:
| Name | Type | Description |
|---|---|---|
fileName |
string |
- Version:
-
- 1.0
- Source:
Extends
Methods
getNMembers(numberOfMembers, queue)
Aggregates n-members of the queue into a response messsage.
Returns an adequat messge if not enough members are in queue.
Parameters:
| Name | Type | Description |
|---|---|---|
numberOfMembers |
number | Number of members to peek into to queue from the head |
queue |
Object | The queue itself. |
- Source:
execute(message, args)
Executes the main logic of the command
Parameters:
| Name | Type | Description |
|---|---|---|
message |
* | A discord.js message object representing a request. |
args |
* | Arguments passed in addition to the command call |
- Overrides:
- Source:
getCommand() → {Object}
Creates and returns a object representation of the command. Used to init discord.js commands.
- Overrides:
- Source:
getResponse(name) → {string}
Returns a command specific response for a user, additionally supplied arguments besides name are used to replace template sequeuence of the string.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | The key of the response. Used to access the responses for the calling command. |
- Overrides:
- Source: