Main bot constructor
-Emitted after connecting to Discord API
-Emitted whenever bot receives a Discord message
-Emitted whenever bots receives a Discord message or interaction that gets recognized as a CommandBot command
-Emitted on every bot error
-Discord API application ID
-Discord.js {@link Client} instance
-Instance command manager
-Messages and embeds configuration
-Help message configuration
-SystemMessageManager storing messages' configuration
-Bot name
-Discord Bot token
Sets or gets the default captureRejection value for all emitters.
@@ -35,7 +31,7 @@ events. Listeners installed using this symbol are called before the regularInstalling a listener using this symbol does not change the behavior once an
'error' event is emitted, therefore the process will still crash if no
regular 'error' listener is installed.
Starts your Discord bot
whether this operation has been completed successfully
A representation of CHAT_INPUT command (also known as a slash command)
-ChatCommand constructor
a manager that this command belongs to
ChatCommandInit object containing all options needed to create a ChatCommand
-Subcommands and groups of this command
-List of different names that can be used to invoke a command (when using prefix interactions)
-Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)
-Discord API default_permission
-Command description displayed in the help message or in slash commands menu (Default description: "No description")
-If set to false, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError
-List of Discord guild (server) IDs in which this command can be used
-Manager in which this command is registered
-Command name
-List of parameters that can passed to this command
-Object containing check functions and permission bitfields
-Whether this command should be registered as a slash command (default: true)
-CommandBot's internal command type
-Command usage displayed in the help message
-Whether this command is visible in the help message (default: true)
-Returns list of attached subcommands
-Returns true if the command has subcommands attached
-Attaches subcommand or subcommand group to this ChatCommand (this makes the base command usable only via prefix interactions)
subcommand type
initialization options
A computed subcommand object
-parameter options
Discord interaction
an InputManager containing all interaction-related data or null
-subcommand name
a SubCommand object or null
-Check base command type
base command type
Whether this command can be used as the given type
-Check child command type
child command type
Whether this command can be used as a child command of the given type
-Checks command type
command type
Whether this command can be used as the given type
-Invoke the command
input data manager
-Converts ChatCommand instance to object that is recognized by the Discord API
Discord API object
Generated using TypeDoc
Bot core command object
-Command core constructor
manager bound to this command
@@ -8,30 +8,30 @@command internal type
initialization options
-Discord API default_permission
-Manager in which this command is registered
-Command name
-CommandBot's internal command type
-Check base command type
base command type
Whether this command can be used as the given type
-Check child command type
child command type
Whether this command can be used as a child command of the given type
-Checks command type
command type
Whether this command can be used as the given type
-Converts a command instance to an APICommandObject
An object that is accepted by the Discord API
Generated using TypeDoc
Object that stores the registered commands and is responsible for data exchanging with the Discord API
-client that this manager belongs to
parameters defining appearance of the help message
-List of commands registered in the manager
-Cache of Discord API commands data
-A string used to split all incoming input data from Discord messages
-Client connected to this manager
-A string used to separate subcommand groups and subcommands
-Help command associated with this manager
-A manager holding all guild-specific prefixes and a global prefix
-Discord API URL
-Discord API commands cache
-Number of commands registered in this manager
-Creates and registers command in the manager based on the given options
an object containing all properties required to create this type of command
A computed command object that inherits from Command
-Performs internal data type conversions
-Process an interaction
interaction object to fetch a command from
An InputManager containing all input data (command, arguments, target etc.)
-Get command registered in this manager
command name or alias
A command object
-Fetches command object from the Discord API
Discord command ID
Discord command object
-Retrieves cache from the manager
-Fetches command ID by name from the Discord APi
name of the command
command type you want to get ID for
Command ID from the Discord API
-Get permissions from Discord Permissions API for a specified command
command ID
-Lists all commands in the manager
An array of commands registered in this manager
-Lists commands registered in the Discord API
List of commands from Discord API
-Register all commands in this manager in the Discord API
-Set permissions using Discord Permissions API
command ID
permissions to set
-list of commands to cache
guild ID
-Generated using TypeDoc
Generated using TypeDoc
Object that stores permission resolvables and properties (bouund to a PermissionCommand)
-command attached to this permissions object
-Command permissions
-Command bound to this object
-If set to "ALL", the command can only be used when all specified conditions are met. (works only for Discord.js permissions object)
-Permission bitfield
-Whether this object uses custom function to check permissions
-Checks if the interaction sender is permitted to use the command attached to this object
command interaction or Discord message
diff --git a/docs/classes/ContextMenuCommand.html b/docs/classes/ContextMenuCommand.html index fa59e4e..eedc8a0 100644 --- a/docs/classes/ContextMenuCommand.html +++ b/docs/classes/ContextMenuCommand.html @@ -1,47 +1,47 @@Representation of all context menu Discord interactions
-Context menu command constructor
manager that this command belongs to
initialization options
-Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)
-Type of context menu interaction
-Discord API default_permission
-If set to false, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError
-List of Discord guild (server) IDs in which this command can be used
-Manager in which this command is registered
-Command name
-Object containing check functions and permission bitfields
-CommandBot's internal command type
-Check base command type
base command type
Whether this command can be used as the given type
-Check child command type
child command type
Whether this command can be used as a child command of the given type
-Checks command type
command type
Whether this command can be used as the given type
-Invoke the command
input data
-Discord API object
+Discord API object
Generated using TypeDoc
Function (executable) command
-Executable command constructor
command manager attached to this command
@@ -8,45 +8,45 @@command type
command initailization options
-Command function (called on command execution)
-Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)
-Discord API default_permission
-Manager in which this command is registered
-Command name
-CommandBot's internal command type
-Reply handler
Discord interaction object
result of command function execution
-Check base command type
base command type
Whether this command can be used as the given type
-Check child command type
child command type
Whether this command can be used as a child command of the given type
-Checks command type
command type
Whether this command can be used as the given type
-Invoke the command
input data manager
A Promise that resolves after the function command is completed
-Converts a command instance to an APICommandObject
An object that is accepted by the Discord API
Generated using TypeDoc
Guild-scoped executable command
-Guild-scoped command constructor
command manager attached to this command
@@ -8,40 +8,40 @@command type
command initialization options
-Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)
-Discord API default_permission
-If set to false, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError
-List of Discord guild (server) IDs in which this command can be used
-Manager in which this command is registered
-Command name
-CommandBot's internal command type
-Check base command type
base command type
Whether this command can be used as the given type
-Check child command type
child command type
Whether this command can be used as a child command of the given type
-Checks command type
command type
Whether this command can be used as the given type
-Invoke the command
input data
-Converts a command instance to an APICommandObject
An object that is accepted by the Discord API
Generated using TypeDoc
Help message constructor
command manager related to this command
appearance properties
-Help message appearance options
-List of different names that can be used to invoke a command (when using prefix interactions)
-Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)
-Discord API default_permission
-Command description displayed in the help message or in slash commands menu (Default description: "No description")
-If set to false, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError
-List of Discord guild (server) IDs in which this command can be used
-Manager in which this command is registered
-Command name
-List of parameters that can passed to this command
-Object containing check functions and permission bitfields
-Whether this command should be registered as a slash command (default: true)
-CommandBot's internal command type
-Command usage displayed in the help message
-Whether this command is visible in the help message (default: true)
-Returns list of attached subcommands
-Returns true if the command has subcommands attached
-Attaches subcommand or subcommand group to this ChatCommand (this makes the base command usable only via prefix interactions)
subcommand type
initialization options
A computed subcommand object
-parameter options
Discord interaction
an InputManager containing all interaction-related data or null
-Discord interaction
A computed help message in form of {@link MessageEmbed}
-subcommand name
a SubCommand object or null
-Check base command type
base command type
Whether this command can be used as the given type
-Check child command type
child command type
Whether this command can be used as a child command of the given type
-Checks command type
command type
Whether this command can be used as the given type
-Invoke the command
input data manager
-Converts ChatCommand instance to object that is recognized by the Discord API
Discord API object
Generated using TypeDoc
Object that stores all interaction input data (target, arguments, content and the interaction itself)
-command related to this manager
interaction or message
list of input arguments
-All input arguments
-Command related to this manager
-Command interaction or message
-Command target (when using context menu interactions)
-Get input values
parameter name
diff --git a/docs/classes/MissingParameterError.html b/docs/classes/MissingParameterError.html index e94af98..6f6b715 100644 --- a/docs/classes/MissingParameterError.html +++ b/docs/classes/MissingParameterError.html @@ -1,10 +1,10 @@Error indicating that a required parameter is missing in the request
-missing parameter object
-Missing parameter object
-Converts error object to user-readable message
Formatted error message
Object indicating command execution success
-command that succeeded
-Command that succeeded
Generated using TypeDoc
Error indicating that an input value cannot be converted to a expected type
-value with an invalid type
expected type
-Value converted to a string
-Expected type
-Converts error object to user-readable message
Formatted error message
Executable command with attached permission system
-Constructor of command with attached permissions
command manager attached to this command
@@ -8,38 +8,38 @@command type
command initalization options
-Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)
-Discord API default_permission
-Manager in which this command is registered
-Command name
-Object containing check functions and permission bitfields
-CommandBot's internal command type
-Check base command type
base command type
Whether this command can be used as the given type
-Check child command type
child command type
Whether this command can be used as a child command of the given type
-Checks command type
command type
Whether this command can be used as the given type
-Invoke the command
input data
-Converts a command instance to an APICommandObject
An object that is accepted by the Discord API
Generated using TypeDoc
Guild-scoped executable command with permissions attached
Guild-scoped, executable, permissions command constructor
command manager attached to this command
@@ -9,42 +9,42 @@command type
command initialization options
-Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)
-Discord API default_permission
-If set to false, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError
-List of Discord guild (server) IDs in which this command can be used
-Manager in which this command is registered
-Command name
-Object containing check functions and permission bitfields
-CommandBot's internal command type
-Check base command type
base command type
Whether this command can be used as the given type
-Check child command type
child command type
Whether this command can be used as a child command of the given type
-Checks command type
command type
Whether this command can be used as the given type
-Invoke the command
input data
-Converts a command instance to an APICommandObject
An object that is accepted by the Discord API
Generated using TypeDoc
Error indicating that a caller doesn't have enough permissions to execute a command
-command that user wanted and failed to invoke
-Command that user wanted and failed to invoke
-User that doesn't have the permissions
-Converts error object to user-readable message
Formatted error message
manager attached to this object
-Global scope identifier
-Prefixes data
-Command manager associated with the object
-Manager global prefix
-Get prefix for a specified scope
guild object or ID
a prefix used in given scope
-Remove prefix for the specified scope
-Set prefix for a specific scope
new prefix
diff --git a/docs/classes/SubCommand.html b/docs/classes/SubCommand.html index 02e0101..4e0eba0 100644 --- a/docs/classes/SubCommand.html +++ b/docs/classes/SubCommand.html @@ -1,49 +1,49 @@Representation of SUB_COMMAND Discord interaction
-Subcommand constructor (SUB_COMMAND parameter in Discord API)
command parent
initialization options
-Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)
-Discord API default_permission
-Command description displayed in the help message or in slash commands menu (Default description: "No description")
-Manager in which this command is registered
-Command name
-List of parameters that can passed to this command
-Command parent
-Object containing check functions and permission bitfields
-CommandBot's internal command type
-Command usage displayed in the help message
-Check base command type
base command type
Whether this command can be used as the given type
-Check child command type
child command type
Whether this command can be used as a child command of the given type
-Checks command type
command type
Whether this command can be used as the given type
-Invoke the command
input data
-Discord API object
+Discord API object
Generated using TypeDoc
Group of subcommands
-group parent command
initialization options
-Group members (children)
-Discord API default_permission
-Group description (default: "No description")
-Manager in which this command is registered
-Command name
-Group parent command
-CommandBot's internal command type
-List of subcommands attached to this group
-Attach a subcommand to this group
subcommand initialization options
A computed SubCommand object
-Check base command type
base command type
Whether this command can be used as the given type
-Check child command type
child command type
Whether this command can be used as a child command of the given type
-Checks command type
command type
Whether this command can be used as the given type
-Discord API object
+Discord API object
Generated using TypeDoc
Stores configuration and generates system messages
System messages - predefined messages sent by the bot in special cases (for example after an error, or when a command doesn't exist)
Sent when an error occurs during the execution of a command
-Sent when someone tries to run a command that does not exist (mainly by using prefix interactions)
-Sent whenever caller's permissions are not sufficient to run a command
-Sent when a command function returns void without throwing an error
Client parent attached to this manager
-Global time (in ms) after a message gets deleted
Generates and sends a system message
"ERROR" | "PERMISSION" | "NOT_FOUND" | "SUCCESS"
diff --git a/docs/index.html b/docs/index.html index a2d4c22..486fd21 100644 --- a/docs/index.html +++ b/docs/index.html @@ -23,7 +23,7 @@Reference for available objects and structures is available here. All descriptions can also be accessed from your code editor/IDE. TypeScript declaration files are also included (.d.ts) for some programs (like Visual Studio Code) to give autocompletion suggestions.
+Reference for available objects and structures is available here. All descriptions can also be accessed from your code editor/IDE. TypeScript declaration files are also included (.d.ts) for some programs (like Visual Studio Code) to give autocompletion suggestions.
// CommonJS
const { Bot } = require("commandbot");
// ES Modules (to use ESM add "type": "module" to package.json file)
import { Bot } from "commandbot";
const bot = new Bot({
name: "YOUR_BOT_NAME",
globalPrefix: "!",
argumentSeparator: ",",
commandSeparator: "/",
clientOptions: {
intents: [..."DISCORD_API_INTENTS"],
},
token: "DISCORD_BOT_TOKEN",
applicationId: "APPLICATION_ID",
});
+const bot = new Bot({
name: "YOUR_BOT_NAME",
globalPrefix: "!",
argumentSeparator: ",",
commandSeparator: "/",
clientOptions: {
intents: [..."DISCORD_API_INTENTS"],
},
token: "DISCORD_BOT_TOKEN",
applicationId: "APPLICATION_ID",
help: {
enabled: true,
title: "List of commands",
usage: "[command name]",
description: "Show all commands available to use in my fantastic Discord bot.",
bottomText: "Hello World",
color: "#0055ff",
visible: false,
},
});
- Create and add commands to the Bot instance (see Commands)
@@ -127,17 +127,17 @@
Creating a command
-To create a command, use CommandManager.prototype.add method
+To create a command, use CommandManager.prototype.add method
Command types
-- CHAT - message interactions using command prefixes or slash commands
-- USER - right-click context menu interactions on users
-- MESSAGE - right-click context menu interactions on messages
+- CHAT - message interactions using command prefixes or slash commands
+- USER - right-click context menu interactions on users
+- MESSAGE - right-click context menu interactions on messages
Chat command example:
bot.commands.add("CHAT", {
name: "greet",
parameters: [
{
name: "user",
description: "User to greet",
optional: false,
type: "user",
},
],
aliases: ["hello"],
description: "Welcome someone to your server",
usage: "[user]",
dm: false,
guilds: ["123456789874561230"],
slash: true,
visible: true,
permissions: {
resolvable: ["ADMINISTRATOR"],
checkType: "ANY",
},
function: async (i) => {
const user = await i.get("user").toObject();
return `Hello ${user.toString()}`;
},
});
-Command function schema is defined here
+Command function schema is defined here
Parameters
@@ -147,15 +147,15 @@
Types
-To get an entity ID from ObjectID use the id property. You can also call toObject method to retrieve full entity object from Discord API
+To get an entity ID from ObjectID use the id property. You can also call toObject method to retrieve full entity object from Discord API
Defining
-Pass a list of ParameterSchema objects to parameters property
+Pass a list of ParameterSchema objects to parameters property
Example parameter object:
{
name: "user",
description: "User to mention",
optional: false,
type: "user"
}
@@ -163,7 +163,7 @@
Reading input value
-To read parameter values use InputManager.prototype.get() (passed in the first argument of a command function)
+To read parameter values use InputManager.prototype.get() (passed in the first argument of a command function)
Example:
function: (i) => {
const userObj = i.get('member', 'user')
if(userObj) {
const user = userObj.toObject();
if(user) {
return `Hello, ${user.toString()}`
}
else {
throw new Error('User not found')
}
}
}
@@ -171,7 +171,7 @@
Events
-CommandBot is using EventEmitter that is built into Node.js. You can listen to events using the on method. Event types are available here.
+CommandBot is using EventEmitter that is built into Node.js. You can listen to events using the on method. Event types are available here.
Messages
@@ -180,12 +180,12 @@
System messages
-System messages can be composed and sent automatically when a certain action happens. All message types are available here. Their configuration is stored in Bot.prototype.messages.system property. Each of these messages can be customized with SystemMessageAppearance objects. There is also a global deleteTimeout property so messages can automatically be deleted after a given time.
+System messages can be composed and sent automatically when a certain action happens. All message types are available here. Their configuration is stored in Bot.prototype.messages property. Each of these messages can be customized with SystemMessageAppearance objects. There is also a global deleteTimeout property so messages can automatically be deleted after a given time.
Help message
-Its configuration is stored in Bot.prototype.messages.help property and can be customized with HelpMessageParams object.
+To configure it use the help property in the bot's constructor and pass there a HelpMessageParams object.
WARNING! You can't customize these messages after starting the bot. Changing these properties while the bot is running will have no effect.
diff --git a/docs/interfaces/APICommandInit.html b/docs/interfaces/APICommandInit.html
index df7e75c..13295f8 100644
--- a/docs/interfaces/APICommandInit.html
+++ b/docs/interfaces/APICommandInit.html
@@ -1,7 +1,7 @@
APICommandInit | commandbot Interface APICommandInit
Initialization options of core Command object
- Hierarchy
- APICommandInit
Index
Properties
Properties
Optional default_
+Hierarchy
- APICommandInit
Index
Properties
Properties
Optional default_
Discord API default permission
-name
+name
Command name
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/APICommandObject.html b/docs/interfaces/APICommandObject.html
index 780dd9a..636cfea 100644
--- a/docs/interfaces/APICommandObject.html
+++ b/docs/interfaces/APICommandObject.html
@@ -1,7 +1,7 @@
APICommandObject | commandbot Interface APICommandObject
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/ChatCommandInit.html b/docs/interfaces/ChatCommandInit.html
index 7e7be0b..fcbdbcf 100644
--- a/docs/interfaces/ChatCommandInit.html
+++ b/docs/interfaces/ChatCommandInit.html
@@ -1,29 +1,29 @@
ChatCommandInit | commandbot Interface ChatCommandInit
Intialization options of chat command
- Hierarchy
- PermissionGuildCommandInit
- ChatCommandInit
Index
Properties
Optional aliases
+Hierarchy
- PermissionGuildCommandInit
- ChatCommandInit
Index
Properties
Optional aliases
Different string that can be used with prefix to invoke the command
-Optional announce
+Optional announce
Whether to send a built-in success message when the command has completed (if no other response is defined)
-Optional default_
+Optional default_
Discord API default permission
-Optional description
+Optional description
Command description
-Optional dm
+Optional dm
Whether this command should be callable using private messages with bot
-Optional function
+Optional function
Command function (will be executed when calling a command)
-Optional guilds
+Optional guilds
List of Guild IDs in which the command can be called
-name
+name
Command name
-Optional parameters
+Optional parameters
List of object defining all parameters of the command
-Optional permissions
+Optional permissions
Object with permissions' options and resolvables
-Optional slash
+Optional slash
Whether this command should be registered as a slash command
-Optional usage
+Optional usage
Command usage (if undefined, the usage will be automatically generated using parameters)
-Optional visible
+Optional visible
Whether this command is visible in the help message
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/ChatCommandObject.html b/docs/interfaces/ChatCommandObject.html
index f5af9b2..bb19d02 100644
--- a/docs/interfaces/ChatCommandObject.html
+++ b/docs/interfaces/ChatCommandObject.html
@@ -1,13 +1,13 @@
ChatCommandObject | commandbot Interface ChatCommandObject
Discord CHAT_INPUT command object
- Hierarchy
- APICommandObject
- ChatCommandObject
Index
Properties
default_
+Hierarchy
- APICommandObject
- ChatCommandObject
Index
Properties
default_
Discord API default permission
-description
+description
Command description
-name
+name
Command name
-Optional options
+Optional options
Command options/parameters
-type
+type
Command type (forced to 1)
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/ChatCommandOptionObject.html b/docs/interfaces/ChatCommandOptionObject.html
index 3364f5a..c54d167 100644
--- a/docs/interfaces/ChatCommandOptionObject.html
+++ b/docs/interfaces/ChatCommandOptionObject.html
@@ -1,16 +1,16 @@
ChatCommandOptionObject | commandbot Interface ChatCommandOptionObject
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/CommandPermission.html b/docs/interfaces/CommandPermission.html
index 70a730d..da7534e 100644
--- a/docs/interfaces/CommandPermission.html
+++ b/docs/interfaces/CommandPermission.html
@@ -1,3 +1,3 @@
CommandPermission | commandbot Interface CommandPermission
Generated using TypeDoc
\ No newline at end of file
+
Generated using TypeDoc
Command permissions initialization object
-Whether to check if the caller has all defined permissions or at least one of them (applies only if the command uses Discord.js permission system)
-Resolvable (Discord.js permission resolvables) or custom function that returns boolean value
Generated using TypeDoc
Initialization options of context menu interactions
-Whether to send a built-in success message when the command has completed (if no other response is defined)
-Context menu target type
-Discord API default permission
-Whether this command should be callable using private messages with bot
-Command function (will be executed when calling a command)
-List of Guild IDs in which the command can be called
-Command name
-Object with permissions' options and resolvables
Generated using TypeDoc
Context menu command object
-Discord API default permission
-Command name
-Generated using TypeDoc
Generated using TypeDoc
Initialization options of base executable command
-Whether to send a built-in success message when the command has completed (if no other response is defined)
-Discord API default permission
-Command function (will be executed when calling a command)
-Command name
Generated using TypeDoc
Initialization options of base guild-scoped command
-Whether to send a built-in success message when the command has completed (if no other response is defined)
-Discord API default permission
-Whether this command should be callable using private messages with bot
-Command function (will be executed when calling a command)
-List of Guild IDs in which the command can be called
-Command name
Generated using TypeDoc
All properties used to customize the appearance of a help message
-Text below the title
-Color of a message
-Description of the "help" command
-Whether help message is enabled
-Title field
-Usage of the "help" command
-Whether the "help" command should be visible in the help message
Generated using TypeDoc
Main object initialization options
-Discord API application ID
-Separator used to split user input to a list of InputParameters (applies to prefix interactions)
-Additional ClientOptions for Discord.js Client object
-Separator used to split subcommands when using prefix interactions
-Prefix used as a way to trigger the bot using messages in all guilds by default
Generated using TypeDoc
Generated using TypeDoc
Properties required to build a Parameter object
-List of value choices
Generated using TypeDoc
Initialization options of base command with attached permissions
-Whether to send a built-in success message when the command has completed (if no other response is defined)
-Discord API default permission
-Command function (will be executed when calling a command)
-Command name
-Object with permissions' options and resolvables
Generated using TypeDoc
Initialization options of base guild-scoped command with attached permisisions
-Whether to send a built-in success message when the command has completed (if no other response is defined)
-Discord API default permission
-Whether this command should be callable using private messages with bot
-Command function (will be executed when calling a command)
-List of Guild IDs in which the command can be called
-Command name
-Object with permissions' options and resolvables
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Intialization options of subcommand group
-Discord API default permission
-Command description
-Command name
Generated using TypeDoc
API representation of subcommand group
-Discord API default permission
-Command name
-Generated using TypeDoc
Generated using TypeDoc
Subcommand initialization options
-Whether to send a built-in success message when the command has completed (if no other response is defined)
-Discord API default permission
-Command description
-Command function (will be executed when calling a command)
-Command name
-List of object defining all parameters of the command
-Object with permissions' options and resolvables
-Command usage (if undefined, the usage will be automatically generated using parameters)
Generated using TypeDoc
Configuration of a system message
-Color of a message
-Text below the title
-Time (in ms) after a message of this type gets deleted
Whether to display detailed informations in the message
-Whether this type of message is enabled
-Footer text
-Whether to show current time and date in a footer
-Title field
Generated using TypeDoc
System message data definition
-A Command instance
-Error object
-Phrase received from a Discord channel
-User who used the bot
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Discord application command types CHAT_INPUT - chat interaction (prefix or slash commands) USER - context menu interaction for user MESSAGE - context menu interaction for message
-Types of command bases
-Base command type selector
-Acceptable CHAT_INPUT command option types (read more here)
-Child command initializer selector
-Child command resolvables
-Child command types
-Child command type selector
-Command function definition
If function returns (also after resolving a Promise):
It is possible to manually send replies directly from the command function using the interaction property from InputManager argument. If you are using slash commands don't forget to use the CommandInteraction.prototype.editReply method instead of the reply method since a reply is already deferred when a command function gets called (read more here) If you try to create a new reply, you app will throw an error that will result a crash.
If you manually reply to a slash command interaction and return void from the command function, a SUCCESS message will not be sent or reply will not get deleted (if you want to disable SUCCESS messages on prefix interactions set announceSuccess property to false).
If command function throws an error, it will automatically get caught and your bot will send an ERROR message. The app will not crash.
-All types that can be returned from a command function
-Command initializer selector
-Discord permission types
-Command types
-Command type selector
-Context menu command types
Input parameter value resolvable selector
-Types of system messages
-ObjectID.prototype.toObject() return type selector
-Types of Discord objects (IDs contained in an ObjectID wrapper)
All parameter resolvables
-Parameter type values
Permission checking methods
ALL - uses Permissions.prototype.has method
ANY - uses Permissions.prototype.any method
-Prefix scope types
-TargetID.prototype.toObject() return type selector*
-Types of Discord context menu targets (IDs contained in a TargetID wrapper)
Generated using TypeDoc
Application instance
-