\r\n DiscordBot is a node.js module that allows you to build a Discord Bot easily \r\n Easy to use, the important thing is to read our documentation\r\n
\r\n
\r\n \r\n
\r\n
\r\n \r\n \r\n \r\n \r\n \r\n
\r\n
\r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n
\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n\r\n\r\n# Welcome!\r\n\r\nWelcome to the DiscordBot v2 documentation.\r\n\r\n# About\r\n\r\nDiscord is an extend of discord.js.\r\n *discord.js is a powerful [Node.js](https://nodejs.org) module that allows you to easily interact with the\r\n[Discord API](https://discord.com/developers/docs/intro).*\r\n\r\n- *Object-oriented*\r\n- *Predictable abstractions*\r\n- *Performant*\r\n- *100% coverage of the Discord API*\r\n\r\n# Installation\r\n\r\n**Node.js 12.0.0 or newer is required.** \r\n``` sh\r\nnpm i @devartsite/discordbot\r\n```\r\n\r\n# Basic example\r\n``` js\r\nconst { DiscordBot, Command } = require('@devartsite/discordbot')\r\n\r\nconst client = new DiscordBot({\r\n ggid: 'my guild id',\r\n gcid: 'my channel id',\r\n dev: 'my name',\r\n prefix: '&prefix'\r\n})\r\n\r\nconst myCommand = new Command(client, {\r\n alias: ['ping'],\r\n name: ':blue_circle: Ping',\r\n description: [\r\n ':arrow_right: ``ping`` Respond Pong!!.'\r\n ],\r\n group: 'ping',\r\n script: async function (message) {\r\n message.channel.send('Pong!!')\r\n }\r\n})\r\n\r\nclient.login('my token').then(() => {\r\n console.log('Bot started and ready')\r\n}).catch(console.error)\r\n```\r\n - By default DiscordBot integrates a [Help Module](https://github.com/DevArtSite/DiscordBot/tree/master/modules/Help)\r\n\r\n\r\n# Module implementation\r\n```sh\r\nDiscordBot-project\r\n├── modules\r\n│ ├── index.js\r\n│ ├── commands.js\r\n│ ├── methods.js\r\n│ ├── responses.js\r\n│ └── events.js\r\n└── index.js\r\n```\r\n\r\n# Links\r\n\r\n- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website))\r\n- [discord.js Website](https://discord.js.org/) ([source](https://github.com/discordjs/website))\r\n- [discord.js Documentation](https://discord.js.org/#/docs/main/master/general/welcome)\r\n\r\n\r\n# Help\r\n\r\nIf you don't understand something in the documentation, you are experiencing problems, or you just need a gentle\r\nnudge in the right direction, please don't hesitate to join our official [Discord.js Server](https://discord.gg/bRCvFy9).","path":"docs/general/welcome.md"},"updating":{"name":"Updating your code","type":"md","content":"# Nothing yet","path":"docs/general/updating.md"},"faq":{"name":"FAQ","type":"md","content":"# Frequently Asked Questions\r\n\r\nnothing yet","path":"docs/general/faq.md"}}},"examples":{"name":"Examples","files":{"ping":{"name":"Ping","type":"js","content":"const { DiscordBot, Command } = require('@devartsite/discordbot')\r\n\r\nconst client = new DiscordBot({\r\n ggid: 'my guild id',\r\n gcid: 'my channel id',\r\n dev: 'my name',\r\n prefix: '&prefix'\r\n})\r\n\r\nconst myCommand = new Command(client, {\r\n alias: ['ping'],\r\n name: ':blue_circle: Ping',\r\n description: [':arrow_right: ``ping`` Respond Pong!!.'],\r\n group: 'ping',\r\n script: async function (message) {\r\n return message.channel.send('Pong!!')\r\n }\r\n})\r\n\r\nclient.login('my token').then(() => {\r\n console.log('Bot started and ready')\r\n}).catch(console.error)\r\n","path":"docs/examples/ping.js"}}}},"classes":[{"name":"ClientDiscordBot","description":"Represents the Discord bot in logged in client’s.","extends":[[["Client"]]],"construct":{"name":"ClientDiscordBot","params":[{"name":"options","description":"The data of client","type":[[["ClientDiscordBotOptions"]]]}]},"props":[{"name":"ggid","description":"The ggid (global guild id) is the id of the developer’s guild","readonly":true,"type":[[["Snowflake"]]],"meta":{"line":23,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"gcid","description":"The gcid (global channel id) is the id of the developer’s channel on developer’s guild","readonly":true,"type":[[["Snowflake"]]],"meta":{"line":30,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"dev","description":"The dev is the name of the main developer","type":[[["string"]]],"meta":{"line":36,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"prefix","description":"The prefix is a character string to recognize a command of a message","type":[[["string"]]],"meta":{"line":42,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"dbname","description":"The dbname is a name of mongo database","readonly":true,"type":[[["string"]]],"meta":{"line":49,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"customHelp","description":"The customHelp is an object containing the title and custom description for the help command","type":[[["HelpEmbedOptions"]]],"meta":{"line":55,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"useDefaultModule","description":"Default module selection enabled when client login","readonly":true,"type":[[["Array","<"],["string",">"]],[["boolean"]]],"meta":{"line":63,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"commands","description":"Commands collection of client","readonly":true,"type":[[["Commands"]]],"meta":{"line":70,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"modules","description":"Modules collection of client","readonly":true,"type":[[["Modules"]]],"meta":{"line":77,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"dbOptions","description":"Mongodb options","access":"private","readonly":true,"type":[[["Object"]]],"meta":{"line":85,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"db","description":"Mongodb connection","access":"private","readonly":true,"type":[[["MongooseConnection"]]],"meta":{"line":96,"file":"ClientDiscordBot.js","path":"structures"}}],"methods":[{"name":"MessageEmbed","description":"The MessageEmbed class","examples":["client.MessageEmbed({ title: 'My cool title', description: 'My awsome description' })"],"params":[{"name":"data","description":"Whether to skip the cache check and request the API","optional":true,"default":"{}","type":[[["EmbedData"]]]}],"returns":[[["MessageEmbed"]]],"meta":{"line":110,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"connect","description":"The mongoDb connection function","access":"private","async":true,"returns":[[["MongooseConnection"]]],"meta":{"line":133,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"login","description":"Logs the client in, establishing a websocket connection to Discord.","examples":["client.login('my token');"],"params":[{"name":"token","description":"Token of the account to log in with","optional":true,"type":[[["string"]]]}],"async":true,"returns":{"types":[[["Promise","<"],["string",">"]]],"description":"Token of the account used"},"meta":{"line":150,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"handleError","description":"Handle error, emit","params":[{"name":"error","description":"Error","optional":true,"type":[[["Error"]]]}],"meta":{"line":162,"file":"ClientDiscordBot.js","path":"structures"}}],"events":[{"name":"error","description":"Emitted for general errors information.","params":[{"name":"error","description":"The error","type":[[["Error"]]]}],"meta":{"line":165,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"command","description":"Emitted whenever a command is executed.","params":[{"name":"command","description":"The guild that has become unavailable","type":[[["CommandMessage"]]]}],"meta":{"line":84,"file":"CommandMessage.js","path":"structures"}}],"meta":{"line":16,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"Command","description":"Represents the command.","construct":{"name":"Command","params":[{"name":"module","description":"Should be Module if is command from module or Client if is a command out of module context","optional":true,"type":[[["ClientDiscordBot"]],[["Module"]]]},{"name":"data","description":"Data for command","optional":true,"type":[[["CommandOptions"]]]}]},"props":[{"name":"client","description":"The instance of DicordBot client","readonly":true,"type":[[["ClientDiscordBot"]]],"meta":{"line":14,"file":"Command.js","path":"structures"}},{"name":"module","description":"The instance of Module","readonly":true,"type":[[["Module"]]],"meta":{"line":21,"file":"Command.js","path":"structures"}},{"name":"id","description":"The id of this command","readonly":true,"type":[[["Snowflake"]]],"meta":{"line":28,"file":"Command.js","path":"structures"}},{"name":"name","description":"The name of command","readonly":true,"type":[[["string"]]],"meta":{"line":35,"file":"Command.js","path":"structures"}},{"name":"description","description":"The description of command","readonly":true,"type":[[["string"]]],"meta":{"line":42,"file":"Command.js","path":"structures"}},{"name":"alias","description":"The alias array","readonly":true,"type":[[["Array","<"],["string",">"]]],"meta":{"line":49,"file":"Command.js","path":"structures"}},{"name":"group","description":"The group name of command","readonly":true,"type":[[["string"]]],"meta":{"line":56,"file":"Command.js","path":"structures"}},{"name":"script","description":"The script function of command","readonly":true,"type":[[["CommandScriptFunction"]]],"meta":{"line":63,"file":"Command.js","path":"structures"}},{"name":"autodelete","description":"The status of this command","readonly":true,"type":[[["boolean"]]],"meta":{"line":70,"file":"Command.js","path":"structures"}},{"name":"messages","description":"The COllection messages of this command","readonly":true,"type":[[["Collection","<"],["CommandMessage",">"]]],"meta":{"line":77,"file":"Command.js","path":"structures"}}],"methods":[{"name":"execute","description":"Execute script command","access":"private","params":[{"name":"message","description":"Instance of CommandMessage","optional":true,"type":[[["CommandMessage"]]]},{"name":"args","description":"Arguments","optional":true,"type":[[["Array","<"],["string",">"]]]}],"async":true,"meta":{"line":89,"file":"Command.js","path":"structures"}},{"name":"push","description":"Push this command to client & module commands collection if available","access":"private","meta":{"line":97,"file":"Command.js","path":"structures"}}],"meta":{"line":8,"file":"Command.js","path":"structures"}},{"name":"CommandMessage","description":"Represents the Message with command properties.","extends":[[["Message"]]],"props":[{"name":"responses","description":"The responses Collection of this message if this message is a command request","type":[[["Collection","<"],["CommandMessage",">"]]],"meta":{"line":15,"file":"CommandMessage.js","path":"structures"}},{"name":"request","description":"The request of this message if this message is a command response","type":[[["CommandMessage"]]],"meta":{"line":21,"file":"CommandMessage.js","path":"structures"}},{"name":"isCommandResponse","description":"Check if message is a commmand response","type":[[["boolean"]]],"meta":{"line":30,"file":"CommandMessage.js","path":"structures"}},{"name":"isCommandRequest","description":"Check if message is a commmand request","type":[[["boolean"]]],"meta":{"line":38,"file":"CommandMessage.js","path":"structures"}},{"name":"prefixed","description":"Check if message content contain client prefix","type":[[["boolean"]]],"meta":{"line":46,"file":"CommandMessage.js","path":"structures"}},{"name":"args","description":"Get arguments from content message","type":[[["Array","<"],["string",">"]]],"meta":{"line":54,"file":"CommandMessage.js","path":"structures"}},{"name":"command","description":"Get Command message from current message or request message","type":[[["Command"]]],"meta":{"line":62,"file":"CommandMessage.js","path":"structures"}}],"methods":[{"name":"execute","description":"The execution of command script if this message is command","access":"private","async":true,"returns":[[["Promise","<"],["void",">"]]],"meta":{"line":77,"file":"CommandMessage.js","path":"structures"}},{"name":"reply","description":"Replies to the message.\rSet request properties to the returned CommandMessage\rSet this response properties with the returned CommandMessage","examples":["// Reply to a message\rmessage.reply('Hey, I\\'m a reply!')\r .then(() => console.log(`Sent a reply to ${message.author.username}`))\r .catch(console.error)"],"params":[{"name":"content","description":"The content for the message","optional":true,"default":"''","type":[[["StringResolvable"]],[["APIMessage"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]],[["MessageAdditions"]]]}],"async":true,"returns":[[["Promise","<("],["CommandMessage","|"],["Array","<"],["CommandMessage",">)>"]]],"meta":{"line":105,"file":"CommandMessage.js","path":"structures"}},{"name":"replyEmbed","description":"Replies embed to the message.\rSet request properties to the returned CommandMessage\rSet this response properties with the returned CommandMessage","examples":["// Reply embed to a message\rconst embed = client.MessageEmbed({ title: 'My cool title', description: 'My awsome description' })\r .addField('field name', 'field value')\rmessage.reply(embed)\r .then(() => console.log(`Sent a reply embed to ${message.author.username}`))\r .catch(console.error)"],"params":[{"name":"embed","description":"The embed for the message","optional":true,"type":[[["MessageEmbed"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]],[["MessageAdditions"]]]}],"async":true,"returns":[[["Promise","<("],["CommandMessage","|"],["Array","<"],["CommandMessage",">)>"]]],"meta":{"line":127,"file":"CommandMessage.js","path":"structures"}}],"meta":{"line":8,"file":"CommandMessage.js","path":"structures"}},{"name":"Commands","description":"Represents the Commands Collection.","extends":[[["Collection"]]],"props":[{"name":"client","description":"The instance of ClientDicordBot client","readonly":true,"type":[[["ClientDiscordBot"]]],"meta":{"line":15,"file":"Commands.js","path":"structures"}}],"methods":[{"name":"groups","description":"Groups commands by group","returns":[[["Object","<"],["Array","<"],["Command",">>"]]],"meta":{"line":22,"file":"Commands.js","path":"structures"}}],"meta":{"line":7,"file":"Commands.js","path":"structures"}},{"name":"Module","description":"Represents the Module.","props":[{"name":"client","description":"The instance of ClientDicordBot client","readonly":true,"type":[[["ClientDiscordBot"]]],"meta":{"line":16,"file":"Module.js","path":"structures"}},{"name":"id","description":"The id of this module","readonly":true,"type":[[["Snowflake"]]],"meta":{"line":23,"file":"Module.js","path":"structures"}},{"name":"name","description":"The name of this module","readonly":true,"type":[[["string"]]],"meta":{"line":30,"file":"Module.js","path":"structures"}},{"name":"path","description":"The path of this module","readonly":true,"type":[[["string"]]],"meta":{"line":37,"file":"Module.js","path":"structures"}},{"name":"author","description":"The author of this module","readonly":true,"type":[[["string"]]],"meta":{"line":44,"file":"Module.js","path":"structures"}},{"name":"disable","description":"The status of this module","readonly":true,"type":[[["boolean"]]],"meta":{"line":51,"file":"Module.js","path":"structures"}},{"name":"autostart","description":"Determines whether the module should be integrated into the bot when it login","readonly":true,"type":[[["boolean"]]],"meta":{"line":58,"file":"Module.js","path":"structures"}},{"name":"script","description":"The main script of this module","readonly":true,"type":[[["ModuleScriptFunction"]]],"meta":{"line":64,"file":"Module.js","path":"structures"}},{"name":"methods","description":"The methods of this module","readonly":true,"type":[[["ModuleMethods"]]],"meta":{"line":71,"file":"Module.js","path":"structures"}},{"name":"_commands","description":"Commands by inclusion of this module","readonly":true,"type":[[["Array","<"],["Command",">"]]],"meta":{"line":78,"file":"Module.js","path":"structures"}},{"name":"_events","description":"Events by inclusion of this module","readonly":true,"type":[[["ModuleEventsObject"]]],"meta":{"line":85,"file":"Module.js","path":"structures"}},{"name":"responses","description":"Commands by inclusion of this module","readonly":true,"type":[[["Object","<("],["Object","|"],["string","|"],["*",")>"]]],"meta":{"line":92,"file":"Module.js","path":"structures"}},{"name":"commands","description":"The commands Collection of this module","readonly":true,"type":[[["Commands"]]],"meta":{"line":99,"file":"Module.js","path":"structures"}}],"methods":[{"name":"existFile","description":"Check if the file or folder exists","access":"private","params":[{"name":"name","description":"Name of file/folder","optional":true,"type":[[["String"]]]}],"returns":[[["Boolean"]]],"meta":{"line":110,"file":"Module.js","path":"structures"}},{"name":"run","description":"Run the main script of this module","async":true,"returns":{"types":[[["Promise","<"],["ModuleScriptFunction",">"]]],"description":"ModuleScriptFunction"},"meta":{"line":118,"file":"Module.js","path":"structures"}}],"meta":{"line":10,"file":"Module.js","path":"structures"}},{"name":"ModuleMethods","description":"Represents the methods of module.","construct":{"name":"ModuleMethods","description":"The instance of ModuleMethods"},"props":[{"name":"client","description":"The instance of ClientDicordBot client","readonly":true,"type":[[["ClientDiscordBot"]]],"meta":{"line":19,"file":"ModuleMethods.js","path":"structures"}},{"name":"module","description":"The id of this module","readonly":true,"type":[[["Module"]]],"meta":{"line":26,"file":"ModuleMethods.js","path":"structures"}}],"meta":{"line":13,"file":"ModuleMethods.js","path":"structures"}},{"name":"Modules","description":"Represents the DiscordBot modules Collection.","extends":[[["Collection"]]],"props":[{"name":"client","description":"The instance of ClientDicordBot client","readonly":true,"type":[[["ClientDicordBot"]]],"meta":{"line":21,"file":"Modules.js","path":"structures"}},{"name":"modulesPath","description":"The string path to custom modules folder","readonly":true,"type":[[["resolvedPath"]]],"meta":{"line":28,"file":"Modules.js","path":"structures"}},{"name":"defaultPath","description":"The string path to default modules folder","access":"private","readonly":true,"type":[[["resolvedPath"]]],"meta":{"line":36,"file":"Modules.js","path":"structures"}}],"methods":[{"name":"load","description":"Instantiates all new modules in the module folder","access":"private","params":[{"name":"modulesPath","description":"Resolved path to module folder","optional":true,"type":[[["resolvedPath"]]]}],"async":true,"meta":{"line":44,"file":"Modules.js","path":"structures"}},{"name":"instanciate","description":"Instantiate a new module","params":[{"name":"path","description":"Resolved path to module folder","optional":true,"type":[[["resolvedPath"]]]},{"name":"name","description":"Name of module","optional":true,"type":[[["string"]]]}],"async":true,"meta":{"line":57,"file":"Modules.js","path":"structures"}},{"name":"isDefaultEnabled","description":"Test if it is a default module and should be enabled","access":"private","params":[{"name":"path","description":"Resolved path to default module folder","optional":true,"type":[[["resolvedPath"]]]},{"name":"name","description":"Name of module","optional":true,"type":[[["string"]]]}],"returns":[[["boolean"]]],"meta":{"line":77,"file":"Modules.js","path":"structures"}},{"name":"init","description":"Call default and custom module instantiation when client login","access":"private","async":true,"meta":{"line":95,"file":"Modules.js","path":"structures"}},{"name":"start","description":"Runs the main scripts of all modules when client login","access":"private","async":true,"meta":{"line":104,"file":"Modules.js","path":"structures"}}],"meta":{"line":12,"file":"Modules.js","path":"structures"}}],"interfaces":[],"typedefs":[{"name":"ClientDiscordBotOptions","description":"DiscordBot Options.","type":[[["Object"]]],"props":[{"name":"ggid","description":"Id of the developer’s guild","optional":true,"type":[[["Snowflake"]]]},{"name":"gcid","description":"Id of the developer’s channel on developer’s guild","optional":true,"type":[[["Snowflake"]]]},{"name":"dev","description":"Name of the main developer","optional":true,"type":[[["string"]]]},{"name":"prefix","description":"Character string to recognize a command of a message","optional":true,"type":[[["string"]]]},{"name":"dbname","description":"Name of mongo database","optional":true,"type":[[["string"]]]},{"name":"useDefaultModule","description":"Default module selection enabled","optional":true,"type":[[["Array"]],[["boolean"]]]},{"name":"customHelp","description":"Custom data for help embed","optional":true,"type":[[["HelpEmbedOptions"]]]}],"meta":{"line":176,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"HelpEmbedOptions","description":"HelpEmbedOptions Options.","type":[[["Object"]]],"props":[{"name":"title","description":"Title embed of command","optional":true,"type":[[["TitleHelpFunction"]]]},{"name":"description","description":"Description embed of Help command","optional":true,"type":[[["DescriptionHelpFunction"]]]},{"name":"contentlimited","description":"Content description if the real description of command","optional":true,"type":[[["ContentHelpLimited"]]]},{"name":"emojis","optional":true,"type":[[["EmojisHelp"]]]}],"meta":{"line":188,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"TitleHelpFunction","description":"TitleHelpFunction function.","type":[[["function"]]],"params":[{"name":"tag","description":"Client user tag","optional":true,"default":"ClientDiscordBot.user.tag","type":[[["string"]]]},{"name":"group","description":"Command group name","optional":true,"default":"Command.group|undefined","type":[[["string"]]]}],"meta":{"line":197,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"DescriptionHelpFunction","description":"DescriptionHelpFunction function.","type":[[["function"]]],"params":[{"name":"prefix","description":"Client prefix","optional":true,"default":"ClientDiscordBot.prefix","type":[[["string"]]]}],"meta":{"line":204,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"ContentHelpLimited","description":"ContentLimited is content description if the real description of command is too long to be displayed.","type":[[["string"]]],"meta":{"line":210,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"EmojisHelp","description":"EmojisHelp function.","type":[[["Object"]]],"params":[{"name":"title","optional":true,"default":"':regional_indicator_h: '","type":[[["string"]]]},{"name":"alias","optional":true,"default":"':regional_indicator_a: '","type":[[["string"]]]}],"meta":{"line":215,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"EmbedData","description":"Data MessageEmbed.","type":[[["Object"]]],"props":[{"name":"title","description":"The title of embed","optional":true,"type":[[["string"]]]},{"name":"description","description":"The description of embed","optional":true,"type":[[["string"]]]},{"name":"color","description":"The color of the embed","optional":true,"default":"RANDOM","type":[[["ColorResolvable"]]]},{"name":"url","description":"The URL of the thumbnail","optional":true,"default":"client.user.displayAvatarURL()","type":[[["string"]]]},{"name":"timestamp","description":"The timestamp or date","optional":true,"default":"Date.now()","type":[[["Date"]],[["number"]]]},{"name":"footer","description":"The footer of this embed","optional":true,"type":[[["EmbedDataFooter"]]]}],"meta":{"line":222,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"EmbedDataFooter","description":"Data MessageEmbed Footer.","type":[[["Object"]]],"props":[{"name":"text","description":"text The text of the footer","optional":true,"type":[[["string"]]]},{"name":"iconUrl","description":"The icon URL of the footer","optional":true,"type":[[["string"]]]}],"meta":{"line":233,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"ColorResolvable","description":"Can be a number, hex string, an RGB array like:","see":["{@link https://discord.js.org/#/docs/main/stable/typedef/ColorResolvable}"],"type":[[["string"]],[["number"]],[["Array","<"],["number",">"]]],"meta":{"line":240,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"Snowflake","description":"A Twitter snowflake, except the epoch is 2015-01-01T00:00:00.000Z","see":["{@link https://discord.js.org/#/docs/main/stable/typedef/Snowflake}"],"type":[[["string"]]],"meta":{"line":246,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"MongooseConnection","description":"Mongodb connection","see":["{@link https://mongoosejs.com/docs/api/connection.html#connection_Connection}"],"type":[[["Object"]]],"meta":{"line":252,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"Collection","description":"A Map with additional utility methods. This is used throughout discord.js rather than Arrays for anything that has an ID, for significantly improved performance and ease-of-use.","see":["{@link https://discord.js.org/#/docs/collection/master/class/Collection}"],"type":[[["Object"]]],"meta":{"line":258,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"Message","description":"Represents a message on Discord.","see":["{@link https://discord.js.org/#/docs/main/stable/class/Message}"],"type":[[["Object"]]],"meta":{"line":264,"file":"ClientDiscordBot.js","path":"structures"}},{"name":"CommandOptions","description":"Command Options.","see":["{@link https://discord.js.org/#/docs/main/stable/typedef/Snowflake}"],"type":[[["Object"]]],"props":[{"name":"id","description":"The id of this command","optional":true,"type":[[["Snowflake"]]]},{"name":"name","description":"The name of command","optional":true,"type":[[["string"]]]},{"name":"description","description":"The description of command","optional":true,"type":[[["string"]]]},{"name":"alias","description":"The alias array","optional":true,"type":[[["Array"]]]},{"name":"group","description":"The group name of command","optional":true,"type":[[["string"]]]},{"name":"script","description":"The script main function of command","optional":true,"type":[[["function"]]]},{"name":"autodelete","description":"The status of this command","optional":true,"type":[[["boolean"]]]}],"meta":{"line":107,"file":"Command.js","path":"structures"}},{"name":"CommandScriptFunction","description":"Main function of a command\r```js\r// In this function \"this\" can be used end return the instance of the command\rasync function () { }\r// or\rfunction () { }\r\r// In this function \"this\" cannot be used and return that: {}, an object unusable\rasyn () => { }\r// or\r() => { }\r```\r- In this function \"this\" is the instance of the command","see":["{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function}"],"type":[[["function"]]],"meta":{"line":120,"file":"Command.js","path":"structures"}},{"name":"StringResolvable","description":"Data that can be resolved to give a string. This can be:\r* A string\r* An array (joined with a new line delimiter to give a string)\r* Any value","see":["{@link https://discord.js.org/#/docs/main/stable/typedef/StringResolvable}"],"type":[[["string"]],[["Array"]],["*"]],"meta":{"line":138,"file":"CommandMessage.js","path":"structures"}},{"name":"APIMessage","description":"Represents a message to be sent to the API.","see":["{@link https://discord.js.org/#/docs/main/stable/class/APIMessage}"],"type":[[["Object"]]],"meta":{"line":147,"file":"CommandMessage.js","path":"structures"}},{"name":"MessageOptions","description":"Options provided when sending or editing a message.","see":["{@link https://discord.js.org/#/docs/main/stable/typedef/MessageOptions}"],"type":[[["Object"]]],"meta":{"line":153,"file":"CommandMessage.js","path":"structures"}},{"name":"MessageAdditions","description":"Additional items that can be sent with a message.","see":["{@link https://discord.js.org/#/docs/main/stable/typedef/MessageAdditions}"],"type":[[["MessageEmbed"]],[["MessageAttachment"]],[["Array","<("],["MessageEmbed","|"],["MessageAttachment",")>"]]],"meta":{"line":159,"file":"CommandMessage.js","path":"structures"}},{"name":"MessageEmbed","description":"Represents an embed in a message (image/video preview, rich embed, etc.)","see":["{@link https://discord.js.org/#/docs/main/stable/class/MessageEmbed}"],"type":[[["Object"]]],"meta":{"line":165,"file":"CommandMessage.js","path":"structures"}},{"name":"ModuleScriptFunction","description":"Main function of a {@link Module}\r```js\r// In this function \"this\" can be used end return the instance of the {@link Module}\rasync function () { }\r// or\rfunction () { }\r// In this function \"this\" cannot be used and return that: {}, an object unusable\rasyn () => { }\r// or\r() => { }\r```\r- In this function \"this\" is the {@link Module} instance","see":["{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function}"],"type":[[["function"]]],"meta":{"line":130,"file":"Module.js","path":"structures"}},{"name":"ModuleEventsObject","description":"The ModuleEventsObject is object which lists the functions to associate to the available event\r```js\rModuleEventsObject = {\r ready: function () {\r // do stuff\r }\r}\r```","see":["{@link https://discord.js.org/#/docs/main/stable/class/Client?scrollTo=e-ready}"],"type":[[["Object","<"],["ModuleEventFunction",">"]]],"meta":{"line":147,"file":"Module.js","path":"structures"}},{"name":"ModuleEventFunction","description":"The ModuleEventFunction is a function\r- To access to the module you need to use that in your function\r```js\rconst module = this.modules.find(({ name }) => name === 'My module name')\r```\r- In this function \"this\" is the {@link ClientDiscordBot} instance\r```js\r// In this function \"this\" can be used\rasync function () { }\rfunction () { }\r// In this function \"this\" cannot be used\rasync () => { }\r() => { }\r```","see":["{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function}"],"type":[[["function"]]],"meta":{"line":160,"file":"Module.js","path":"structures"}},{"name":"resolvedPath","description":"Path resolved with \"resolve\" function from node.js module \"path\"","see":["{@link https://nodejs.org/api/path.html#path_path_resolve_paths}"],"type":[[["string"]]],"meta":{"line":114,"file":"Modules.js","path":"structures"}}],"externals":[]}
![\"npm\"](\"https://nodei.co/npm/@devartsite/discordbot.png?mini=true\")
\r\n![\"npm](\"https://img.shields.io/npm/v/@devartsite/discordbot.svg\")
\r\n ![\"GitHub](\"https://img.shields.io/github/package-json/v/devartsite/discordbot\")
![\"Standard](\"https://img.shields.io/badge/code_style-standard-brightgreen.svg\"){kind=icon}
\r\n ![\"GitHub](\"https://img.shields.io/github/languages/top/devartsite/discordbot\")
![\"GitHub](\"https://img.shields.io/github/languages/code-size/devartsite/discordbot\")
![\"GitHub](\"https://img.shields.io/github/repo-size/devartsite/discordbot\")
![\"Libraries.io](\"https://img.shields.io/librariesio/release/npm/@devartsite/discordbot\")
![\"npm\"](\"https://img.shields.io/npm/dw/@devartsite/discordbot\")
![\"GitHub](\"https://img.shields.io/github/commit-activity/m/devartsite/discordbot?style=plastic\")
![\"npm](\"https://img.shields.io/npm/collaborators/@devartsite/discordbot\")
![\"NPM\"](\"https://img.shields.io/npm/l/@devartsite/discordbot\")
![\"discord\"](\"https://img.shields.io/discord/592890801575690259\")
![\"GitHub](\"https://img.shields.io/github/issues/devartsite/discordbot\")
![\"Twitter](\"https://img.shields.io/twitter/follow/devartsite?style=plastic\")
![\"GitHub](\"https://img.shields.io/github/followers/devartsite?style=plastic\")
![\"GitHub](\"https://img.shields.io/github/stars/devartsite/discordbot?style=plastic\")
![\"GitHub](\"https://img.shields.io/github/watchers/devartsite/discordbot?style=plastic\")
![\"GitHub](\"https://img.shields.io/github/forks/devartsite/discordbot?style=plastic\")