[ { "path": ".codeclimate.yml", "content": "engines:\n eslint:\n enabled: true\n channel: \"eslint-3\"\n config: .eslintrc\n duplication:\n enabled: false\n config:\n languages:\n - javascript\n fixme:\n enabled: true\nratings:\n paths:\n - \"**.js\"\nexclude_paths:\n- docs/*\n- examples/*\n" }, { "path": ".eslintrc.json", "content": "{\n\t\"parserOptions\": {\n\t\t\"ecmaVersion\": 2017\n\t},\n\t\"env\": {\n\t\t\"es6\": true,\n\t\t\"node\": true\n\t},\n\t\"ecmaFeatures\": {\n\t\t\"modules\": true\n\t},\n\t\"rules\": {\n\t\t\"no-console\": 0,\n\t\t\"no-control-regex\": 0,\n\t\t\"no-alert\": 1,\n\t\t\"no-else-return\": 1,\n\t\t\"no-redeclare\": 2,\n\t\t\"no-useless-escape\": 1,\n\t\t\"no-inner-declarations\": 0,\n\t\t\"array-bracket-spacing\": [\"warn\", \"never\"],\n\t\t\"brace-style\": [\"warn\", \"1tbs\", { \"allowSingleLine\": true }],\n\t\t\"no-trailing-spaces\": 1,\n\t\t\"space-before-function-paren\": [\"warn\", \"never\"],\n\t\t\"arrow-spacing\": 1,\n\t\t\"comma-spacing\": [\"warn\", { \"before\": false, \"after\": true }],\n\t\t\"indent\": [\"error\", \"tab\", { \"SwitchCase\": 1 }],\n\t\t\"require-jsdoc\": [\"warn\", { \"require\": { \"MethodDefinition\": true, \"ClassDeclaration\": true } }],\n\t\t\"valid-jsdoc\": [\"warn\", {\n\t\t\t\"prefer\": {\n\t\t\t\t\"arg\": \"param\",\n\t\t\t\t\"argument\": \"param\",\n\t\t\t\t\"constructor\": \"class\",\n\t\t\t\t\"return\": \"returns\",\n\t\t\t\t\"virtual\": \"abstract\"\n\t\t\t},\n\t\t\t\"preferType\": {\n\t\t\t\t\"boolean\": \"Boolean\",\n\t\t\t\t\"number\": \"Number\",\n\t\t\t\t\"object\": \"Object\",\n\t\t\t\t\"string\": \"String\"\n\t\t\t},\n\t\t\t\"requireReturn\": false,\n\t\t\t\"requireParamDescription\": true,\n\t\t\t\"requireReturnDescription\": true\n\t\t}]\n\t},\n\t\"extends\": \"eslint:recommended\"\n}\n" }, { "path": ".github/FUNDING.yml", "content": "# These are supported funding model platforms\n\ngithub: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]\npatreon: brussell98 # Replace with a single Patreon username\nopen_collective: # Replace with a single Open Collective username\nko_fi: # Replace with a single Ko-fi username\ntidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel\ncustom: # Replace with a single custom sponsorship URL\n" }, { "path": ".gitignore", "content": "*.tmp\n*.env\n.vscode\nnode_modules\nconfig.json\n.idea/\n" }, { "path": ".jsdoc.json", "content": "{\n\t\"tags\": {\n\t\t\"allowUnknownTags\": true,\n\t\t\"dictionaries\": [\"jsdoc\"]\n\t},\n\t\"source\": {\n\t\t\"include\": [\"lib/\"],\n\t\t\"includePattern\": \".js$\",\n\t\t\"excludePattern\": \"(node_modules/|docs)\"\n\t},\n\t\"plugins\": [\n\t\t\"plugins/markdown\"\n\t],\n\t\"templates\": {\n\t\t\"default\": {\n\t\t\t\"outputSourceFiles\": false,\n\t\t\t\"includeDate\": false\n\t\t},\n\t\t\"docdash\": {\n\t\t\t\"sort\": true\n\t\t},\n\t\t\"cleverLinks\": false,\n\t\t\"monospaceLinks\": true\n\t},\n\t\"opts\": {\n\t\t\"destination\": \"./docs/\",\n\t\t\"encoding\": \"utf8\",\n\t\t\"private\": true,\n\t\t\"recurse\": true,\n\t\t\"template\": \"./node_modules/docdash\"\n\t}\n}\n" }, { "path": ".npmignore", "content": "*.tmp\n*.env\n.vscode\nnode_modules\nconfig.json\n\n# npm ignore\ndocs\nexamples\n.jsdoc.json\n.codeclimate.yml\n" }, { "path": "LICENSE", "content": "The MIT License (MIT)\n\nCopyright (c) 2016 Brussell\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "README.md", "content": "# Mirai Bot Core\n\n\"Discord [![David](https://img.shields.io/david/brussell98/Mirai.svg?maxAge=2592000)](https://david-dm.org/brussell98/Mirai) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/brussell98/Mirai/master/LICENSE) [![Code Climate](https://codeclimate.com/github/brussell98/Mirai/badges/gpa.svg)](https://codeclimate.com/github/brussell98/Mirai)\n[![npm](https://img.shields.io/npm/v/mirai-bot-core.svg)](https://www.npmjs.com/package/mirai-bot-core)\n\nA powerful Discord bot core using [Eris](https://github.com/abalabahaha/eris/).\n\n#### [Documentation](http://brussell98.github.io/Mirai/index.html) | [Eris Docs](https://abal.moe/Eris/docs/index.html) | [Mirai Bot Website](http://mirai.brussell.me) | [Support me on Patreon](http://patreon.com/brussell98) | [Discord Server](https://discord.gg/rkWPSdu) | [Mirai Bot Combined Todo List](https://trello.com/b/Uw5wZLzJ)\n\nmirai-bot-core supports advanced application monitoring with **[sentry.io](http://sentry.io)** using raven. For more information [head over to the docs](http://brussell98.github.io/Mirai/Logger.html).\n\n## Installing\n\n```\nyarn add mirai-bot-core\n```\n\n```js\nconst Mirai = require('mirai-bot-core');\nconst bot = new Mirai(config);\n```\n\n## Abstract Classes\n\nAbstract classes are provided to ensure you have the required methods. They can be accessed like so:\n\n```js\nconst AbstractCommand = require('mirai-bot-core/lib/Base/AbstractCommand');\n\nclass PingCommand extends AbstractCommand {\n\tconstructor() {\n\t\tsuper();\n\t}\n}\n```\n" }, { "path": "docBeautify.js", "content": "const beautify_html = require('js-beautify').html;\nconst fs = require('fs');\n\nfs.readdir(__dirname + '/docs/', (error, files) => {\n\tif (error)\n\t\tthrow error;\n\n\tfiles.filter(f => f.endsWith('.html')).map((filename, i) => {\n\t\tfs.readFile(__dirname + '/docs/' + filename, 'utf8', (err, data) => {\n\t\t\tif (err)\n\t\t\t\tthrow err;\n\n\t\t\tfs.writeFile(__dirname + '/docs/' + filename, beautify_html(data, {\n\t\t\t\tbrace_style: 'collapse',\n\t\t\t\tindent_with_tabs: true,\n\t\t\t\tpreserve_newlines: false,\n\t\t\t\tend_with_newline: true\n\t\t\t}), e => {\n\t\t\t\tif (e)\n\t\t\t\t\tthrow e;\n\n\t\t\t\tif (i === files.length - 1) {\n\t\t\t\t\tconsole.log('HTML files beautified');\n\t\t\t\t\tprocess.exit(0);\n\t\t\t\t}\n\t\t\t});\n\t\t});\n\t});\n});\n" }, { "path": "docs/AbstractCommand.html", "content": "\n\n\n\n\t\n\tAbstractCommand - Documentation\n\t\n\t\n\t\n\t\n\t\n\n\n\n\t\n\t\n\t\n\t\n\t
\n\t\t

AbstractCommand

\n\t\t
\n\t\t\t
\n\t\t\t\t

AbstractCommand

\n\t\t\t\t
\n\t\t\t\t\t

A command managed by a CommandPlugin

\n\t\t\t\t
\n\t\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Constructor

\n\t\t\t\t\t

(abstract) new AbstractCommand()

\n\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t

Creates a new AbstractCommand

\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

Members

\n\t\t\t\t

(abstract) description :String

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

A description of the command

\n\t\t\t\t
\n\t\t\t\t
Type:
\n\t\t\t\t
    \n\t\t\t\t\t
  • \n\t\t\t\t\t\tString\n\t\t\t\t\t
    • \n\t\t\t\t
\n\t\t\t\t

(abstract) name :String

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

The name of the command

\n\t\t\t\t
\n\t\t\t\t
Type:
\n\t\t\t\t
    \n\t\t\t\t\t
  • \n\t\t\t\t\t\tString\n\t\t\t\t\t
    • \n\t\t\t\t
\n\t\t\t\t

Methods

\n\t\t\t\t

(private) _sendMessage(channel, content, optionsopt) → {Promise.<Message>}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeAttributesDescription
channel\n\t\t\t\t\t\t\t\tChannel\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The channel to create the message in

\n\t\t\t\t\t\t\t
content\n\t\t\t\t\t\t\t\tString | Object\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The content to be passed to Eris.Client#createMessage

\n\t\t\t\t\t\t\t
options\n\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t

Options for sending the message

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The sent message

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise.<Message>\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

awaitMessage(trigger, action, timeoutopt) → {Number}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Await a message, the trigger a function

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeAttributesDescription
trigger\n\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

A function that takes a Message and returns a Boolean

\n\t\t\t\t\t\t\t
action\n\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

A function to be executed when trigger returns true

\n\t\t\t\t\t\t\t
timeout\n\t\t\t\t\t\t\t\tNumber\n\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t

Delete the await after this many milliseconds

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The unique id of the await

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tNumber\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

destroy() → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Destroys/unloads the command

\n\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

Resolves with no value

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

escapeMarkdown(text) → {String}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Escape any discord markdown present in a string

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
text\n\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The text to escape

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The escaped text

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tString\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

load(parent) → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Loads the command

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
parent\n\t\t\t\t\t\t\t\tAbstractCommandPlugin\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The plugin managing this command

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

Resolves with this

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

sendMessage(message, content, optionsopt) → {Promise.<Message>}

\n\t\t\t\t
\n\t\t\t\t\t
See:
\n\t\t\t\t\t
\n\t\t\t\t\t\t\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Send a message to discord

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeAttributesDescription
message\n\t\t\t\t\t\t\t\tMessage\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The message to respond to

\n\t\t\t\t\t\t\t
content\n\t\t\t\t\t\t\t\tString | Object\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The content to be passed to Eris.Client#createMessage

\n\t\t\t\t\t\t\t
options\n\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t

Options for sending the message

\n\t\t\t\t\t\t\t\t
Properties
\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t
NameTypeAttributesDefaultDescription
deleteTrigger\n\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\tfalse\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t

Delete the message that triggered the command

\n\t\t\t\t\t\t\t\t\t\t\t
deleteAfter\n\t\t\t\t\t\t\t\t\t\t\t\tNumber\n\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t0\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t

Delete the created message after this many milliseconds

\n\t\t\t\t\t\t\t\t\t\t\t
DM\n\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\tfalse\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t

Send in a Direct Message

\n\t\t\t\t\t\t\t\t\t\t\t
file\n\t\t\t\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t

The file to be sent with the message. Format as shown in the Eris docs

\n\t\t\t\t\t\t\t\t\t\t\t
paginate\n\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t

Split the message at 2000 character intervals. Used to send log messages that would normally fail

\n\t\t\t\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The sent message, or nothing if pagination is true

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise.<Message>\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

userOnCooldown(userID, waitTime) → {Boolean}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Check if a user is on cooldown

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
userID\n\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The id of the user to check for

\n\t\t\t\t\t\t\t
waitTime\n\t\t\t\t\t\t\t\tNumber\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

If not on cooldown, put them on cooldown for this many milliseconds

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

If the user is still on cooldown

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tBoolean\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t
\n\t\t
\n\t
\n\t
\n\t\n\t\n\t\n\n\n\n" }, { "path": "docs/AbstractCommandPlugin.html", "content": "\n\n\n\n\t\n\tAbstractCommandPlugin - Documentation\n\t\n\t\n\t\n\t\n\t\n\n\n\n\t\n\t\n\t\n\t\n\t
\n\t\t

AbstractCommandPlugin

\n\t\t
\n\t\t\t
\n\t\t\t\t

AbstractCommandPlugin

\n\t\t\t\t
\n\t\t\t\t\t

A set of commands

\n\t\t\t\t
\n\t\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Constructor

\n\t\t\t\t\t

(abstract) new AbstractCommandPlugin()

\n\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t

Creates a new AbstractCommandPlugin

\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

Members

\n\t\t\t\t

(abstract) description :String

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

A description of the plugin

\n\t\t\t\t
\n\t\t\t\t
Type:
\n\t\t\t\t
    \n\t\t\t\t\t
  • \n\t\t\t\t\t\tString\n\t\t\t\t\t
    • \n\t\t\t\t
\n\t\t\t\t

(abstract) help :Array

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

An array containing, in this order: name, description, array of command names, array of command descriptions

\n\t\t\t\t
\n\t\t\t\t
Type:
\n\t\t\t\t
    \n\t\t\t\t\t
  • \n\t\t\t\t\t\tArray\n\t\t\t\t\t
    • \n\t\t\t\t
\n\t\t\t\t

(abstract) name :String

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

The name of the plugin

\n\t\t\t\t
\n\t\t\t\t
Type:
\n\t\t\t\t
    \n\t\t\t\t\t
  • \n\t\t\t\t\t\tString\n\t\t\t\t\t
    • \n\t\t\t\t
\n\t\t\t\t

Methods

\n\t\t\t\t

destroy() → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Destroys/unloads the plugin

\n\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

Resolves with no value

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

(abstract) handle()

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Handle a message

\n\t\t\t\t
\n\t\t\t\t

load(bot) → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Loads the plugin

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
bot\n\t\t\t\t\t\t\t\tBot\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The main client

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

Resolves with this

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t
\n\t\t
\n\t
\n\t
\n\t\n\t\n\t\n\n\n\n" }, { "path": "docs/AbstractEventPlugin.html", "content": "\n\n\n\n\t\n\tAbstractEventPlugin - Documentation\n\t\n\t\n\t\n\t\n\t\n\n\n\n\t\n\t\n\t\n\t\n\t
\n\t\t

AbstractEventPlugin

\n\t\t
\n\t\t\t
\n\t\t\t\t

AbstractEventPlugin

\n\t\t\t\t
\n\t\t\t\t\t

Handles events emitted from eris

\n\t\t\t\t
\n\t\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Constructor

\n\t\t\t\t\t

(abstract) new AbstractEventPlugin()

\n\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t

Creates a new AbstractEventPlugin

\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

Members

\n\t\t\t\t

(abstract) name :String

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

The name of the plugin

\n\t\t\t\t
\n\t\t\t\t
Type:
\n\t\t\t\t
    \n\t\t\t\t\t
  • \n\t\t\t\t\t\tString\n\t\t\t\t\t
    • \n\t\t\t\t
\n\t\t\t\t

Methods

\n\t\t\t\t

destroy() → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Destroys/unloads the plugin

\n\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

Resolves with no value

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

load(bot) → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Loads the plugin

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
bot\n\t\t\t\t\t\t\t\tBot\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The main client

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

Resolves with this

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t
\n\t\t
\n\t
\n\t
\n\t\n\t\n\t\n\n\n\n" }, { "path": "docs/AbstractMiddleware.html", "content": "\n\n\n\n\t\n\tAbstractMiddleware - Documentation\n\t\n\t\n\t\n\t\n\t\n\n\n\n\t\n\t\n\t\n\t\n\t
\n\t\t

AbstractMiddleware

\n\t\t
\n\t\t\t
\n\t\t\t\t

AbstractMiddleware

\n\t\t\t\t
\n\t\t\t\t\t

Manages external connections to and from the bot

\n\t\t\t\t
\n\t\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Constructor

\n\t\t\t\t\t

(abstract) new AbstractMiddleware()

\n\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t

Creates a new AbstractMiddleware

\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

Members

\n\t\t\t\t

(abstract) name :String

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

The name of the middleware

\n\t\t\t\t
\n\t\t\t\t
Type:
\n\t\t\t\t
    \n\t\t\t\t\t
  • \n\t\t\t\t\t\tString\n\t\t\t\t\t
    • \n\t\t\t\t
\n\t\t\t\t

Methods

\n\t\t\t\t

destroy() → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Destroys/unloads the middleware

\n\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

Resolves with no value

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

load(bot) → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Loads the middleware

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
bot\n\t\t\t\t\t\t\t\tBot\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The main client

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

Resolves with this

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t
\n\t\t
\n\t
\n\t
\n\t\n\t\n\t\n\n\n\n" }, { "path": "docs/Bot.html", "content": "\n\n\n\n\t\n\tBot - Documentation\n\t\n\t\n\t\n\t\n\t\n\n\n\n\t\n\t\n\t\n\t\n\t
\n\t\t

Bot

\n\t\t
\n\t\t\t
\n\t\t\t\t

Bot

\n\t\t\t\t
\n\t\t\t\t\t

Manages the connection to Discord and interaction between plugins

\n\t\t\t\t
\n\t\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Constructor

\n\t\t\t\t\t

new Bot(options, rLoggeropt, rChatHandleropt)

\n\t\t\t\t\t
\n\t\t\t\t\t\t
See:
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t
Properties:
\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t
NameTypeDescription
carbonBotsKey\n\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

The API key for carbon bot list

\n\t\t\t\t\t\t\t\t
discordBotsKey\n\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

The API key for bots.discord.pw

\n\t\t\t\t\t\t\t\t
discordBotsOrgKey\n\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

The API key for discordbots.org

\n\t\t\t\t\t\t\t\t
botsOnDiscordKey\n\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

The API key for bots.ondiscord.xyz

\n\t\t\t\t\t\t\t\t
logger\n\t\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

The logging wrapper

\n\t\t\t\t\t\t\t\t
chatHandler\n\t\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

The class handling chat messages

\n\t\t\t\t\t\t\t\t
blacklistedGuilds\n\t\t\t\t\t\t\t\t\tArray.<String>\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

Guilds that are banned from using the bot

\n\t\t\t\t\t\t\t\t
blacklistedUsers\n\t\t\t\t\t\t\t\t\tArray.<String>\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

Users that are banned from using the bot

\n\t\t\t\t\t\t\t\t
commandPlugins\n\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

The loaded command plugins

\n\t\t\t\t\t\t\t\t
eventPlugins\n\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

The loaded event plugins

\n\t\t\t\t\t\t\t\t
middleware\n\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

The loaded middleware

\n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t

Creates a new instance of Mirai

\n\t\t\t\t\t
\n\t\t\t\t\t
Parameters:
\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t
NameTypeAttributesDescription
options\n\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

An object defining the configuration for Mirai

\n\t\t\t\t\t\t\t\t\t
Properties
\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t
NameTypeAttributesDescription
token\n\t\t\t\t\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t

The token for your bot

\n\t\t\t\t\t\t\t\t\t\t\t\t
carbonBotsKey\n\t\t\t\t\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t

An API key for carbon bot list

\n\t\t\t\t\t\t\t\t\t\t\t\t
discordBotsKey\n\t\t\t\t\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t

An API key for bots.discord.pw

\n\t\t\t\t\t\t\t\t\t\t\t\t
discordBotsOrgKey\n\t\t\t\t\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t

An API key for discordbots.org

\n\t\t\t\t\t\t\t\t\t\t\t\t
botsOnDiscordKey\n\t\t\t\t\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t

An API key for bots.ondiscord.xyz

\n\t\t\t\t\t\t\t\t\t\t\t\t
blacklistedGuilds\n\t\t\t\t\t\t\t\t\t\t\t\t\tArray.<String>\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t

Guilds that are banned from using the bot

\n\t\t\t\t\t\t\t\t\t\t\t\t
blacklistedUsers\n\t\t\t\t\t\t\t\t\t\t\t\t\tArray.<String>\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t

Users that are banned from using the bot

\n\t\t\t\t\t\t\t\t\t\t\t\t
gracefulExit\n\t\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t

When SIGINT is received, destroy all plugins and middleware, and disconnect the bot

\n\t\t\t\t\t\t\t\t\t\t\t\t
eris\n\t\t\t\t\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t

The options to pass to the eris client. See the Eris docs

\n\t\t\t\t\t\t\t\t\t\t\t\t
logger\n\t\t\t\t\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t

The options to pass to the logger

\n\t\t\t\t\t\t\t\t\t\t\t\t
chatHandler\n\t\t\t\t\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t

The options to pass to the chatHandler

\n\t\t\t\t\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\t
rLogger\n\t\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t

A replacement Logger. Must implement log info debug warn and error. Is passed this and options.logger

\n\t\t\t\t\t\t\t\t
rChatHandler\n\t\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t

A replacement ChatHandler. Must implement run and stop. Is passed this and options.chatHandler

\n\t\t\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

Extends

\n\t\t\t\t
    \n\t\t\t\t\t
  • Eris.Client
    • \n\t\t\t\t
\n\t\t\t\t

Methods

\n\t\t\t\t

findMember(query, members) → (nullable) {Member}

\n\t\t\t\t
\n\t\t\t\t\t
See:
\n\t\t\t\t\t
\n\t\t\t\t\t\t\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Resolve a name or ID to a guild member

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
query\n\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The name or ID to match

\n\t\t\t\t\t\t\t
members\n\t\t\t\t\t\t\t\tCollection\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The Collection of guild members

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The member the was found

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tMember\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

findUser(query) → (nullable) {User}

\n\t\t\t\t
\n\t\t\t\t\t
See:
\n\t\t\t\t\t
\n\t\t\t\t\t\t\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Resolve a name or ID to a user

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
query\n\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The name or ID to match

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The user the was found

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tUser\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

(async) loadCommandPlugin(plugin) → {Promise}

\n\t\t\t\t
\n\t\t\t\t\t
See:
\n\t\t\t\t\t
\n\t\t\t\t\t\t\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
Example
\n\t\t\t\t

Loading a Command Plugin

\n\t\t\t\t
var funCommands = new FunCommandsPlugin();\nmirai.loadCommandPlugin(funCommands);
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
plugin\n\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The plugin to load. Must have a load method which is passed this

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The return value of plugin.load

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

(async) loadEventPlugin(plugin) → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
plugin\n\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The plugin to load. Must have a load method which is passed this

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The return value of plugin.load

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

(async) loadMiddleware(middleware) → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
middleware\n\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The middleware to load. Must have a load method which is passed this

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The return value of middleware.load

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

(async) reloadCommandPlugin(plugin) → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Reload a plugin by searching for a plugin with the same name and replacing it

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
plugin\n\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The plugin to load. Must have a load method which is passed this

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The return value of plugin.load

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

(async) reloadEventPlugin(plugin) → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Reload a plugin by searching for a plugin with the same name and replacing it

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
plugin\n\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The plugin to load. Must have a load method which is passed this

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The return value of plugin.load

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

(async) reloadMiddleware(middleware) → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Reload middleware by searching for middleware with the same name and replacing it

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
middleware\n\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The middleware to load. Must have a load method which is passed this

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The return value of middleware.load

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

(async) setAvatar(url) → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Sets the bot's avatar from a url

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
url\n\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

A direct link to an image

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

Resolves on completion

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

(async) updateBotsOnDiscord(keyopt) → {Promise}

\n\t\t\t\t
\n\t\t\t\t\t
See:
\n\t\t\t\t\t
\n\t\t\t\t\t\t\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Updates information on bots.ondiscord.xyz

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeAttributesDescription
key\n\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t

bots.ondiscord.xyz API key

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The axios request result or error

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

(async) updateCarbon(keyopt) → {Promise}

\n\t\t\t\t
\n\t\t\t\t\t
See:
\n\t\t\t\t\t
\n\t\t\t\t\t\t\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Updates information on carbonitex.net

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeAttributesDescription
key\n\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t

Carbon API key

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The axios request result or error

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

(async) updateDiscordBots(keyopt) → {Promise}

\n\t\t\t\t
\n\t\t\t\t\t
See:
\n\t\t\t\t\t
\n\t\t\t\t\t\t\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Updates information on bots.discord.pw

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeAttributesDescription
key\n\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t

bots.discord.pw API key

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The axios request result or error

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

(async) updateDiscordBotsOrg(keyopt) → {Promise}

\n\t\t\t\t
\n\t\t\t\t\t
See:
\n\t\t\t\t\t
\n\t\t\t\t\t\t\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Updates information on discordbots.org

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeAttributesDescription
key\n\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t

discordbots API key

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The axios request result or error

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t
\n\t\t
\n\t
\n\t
\n\t\n\t\n\t\n\n\n\n" }, { "path": "docs/ChatHandler.html", "content": "\n\n\n\n\t\n\tChatHandler - Documentation\n\t\n\t\n\t\n\t\n\t\n\n\n\n\t\n\t\n\t\n\t\n\t
\n\t\t

ChatHandler

\n\t\t
\n\t\t\t
\n\t\t\t\t

ChatHandler

\n\t\t\t\t
\n\t\t\t\t\t

Handles messages received by the client

\n\t\t\t\t
\n\t\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Constructor

\n\t\t\t\t\t

new ChatHandler(botopt, optionsopt)

\n\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t
Properties:
\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t
NameTypeDescription
bot\n\t\t\t\t\t\t\t\t\tBot\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

The bot

\n\t\t\t\t\t\t\t\t
awaits\n\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

The active awaits

\n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t

Creates a new ChatHandler

\n\t\t\t\t\t
\n\t\t\t\t\t
Parameters:
\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t
NameTypeAttributesDescription
bot\n\t\t\t\t\t\t\t\t\tBot\n\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t

The main client

\n\t\t\t\t\t\t\t\t
options\n\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t

The configuration to use

\n\t\t\t\t\t\t\t\t\t
Properties
\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t
NameTypeAttributesDefaultDescription
allowSelf\n\t\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\tfalse\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t

Allow messages from the bot to be handled

\n\t\t\t\t\t\t\t\t\t\t\t\t
allowBots\n\t\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\tfalse\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t

Allow messages from bots to be handled

\n\t\t\t\t\t\t\t\t\t\t\t\t
defaultHelpCommand\n\t\t\t\t\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t

Enable the default help command

\n\t\t\t\t\t\t\t\t\t\t\t\t\t
Properties
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t
NameTypeAttributesDefaultDescription
prefix\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"!\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

The prefix to use for the help command

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
before\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

The text to put as a header

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
after\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

The text to put as a footer

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
title\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

The text to put as a title (bolded)

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
style\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"extended\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

One of the following: basic, extended, embed

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

Methods

\n\t\t\t\t

awaitMessage(trigger, action, timeoutopt) → {Number}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Add an await, which will trigger under certain conditions

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeAttributesDescription
trigger\n\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

A function that takes a Message and returns a Boolean

\n\t\t\t\t\t\t\t
action\n\t\t\t\t\t\t\t\tfunction\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

A function to be executed when trigger returns true

\n\t\t\t\t\t\t\t
timeout\n\t\t\t\t\t\t\t\tNumber\n\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t

Delete the await after this many milliseconds

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The unique id of the await

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tNumber\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

getHelp(message) → {Promise}

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Generate and send a help message

\n\t\t\t\t
\n\t\t\t\t
Parameters:
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
NameTypeDescription
message\n\t\t\t\t\t\t\t\tMessage\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t

The message to respond to

\n\t\t\t\t\t\t\t
\n\t\t\t\t
Returns:
\n\t\t\t\t
\n\t\t\t\t\t

The sent message

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Type
\n\t\t\t\t\t
\n\t\t\t\t\t\tPromise\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

run()

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Starts listening for messages

\n\t\t\t\t
\n\t\t\t\t

stop()

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Stops listening for messages

\n\t\t\t\t
\n\t\t\t
\n\t\t
\n\t
\n\t
\n\t\n\t\n\t\n\n\n\n" }, { "path": "docs/Logger.html", "content": "\n\n\n\n\t\n\tLogger - Documentation\n\t\n\t\n\t\n\t\n\t\n\n\n\n\t\n\t\n\t\n\t\n\t
\n\t\t

Logger

\n\t\t
\n\t\t\t
\n\t\t\t\t

Logger

\n\t\t\t\t
\n\t\t\t\t\t

Displays text to the console. Also supports sentry

\n\t\t\t\t
\n\t\t\t
\n\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Constructor

\n\t\t\t\t\t

new Logger(optionsopt)

\n\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t
Properties:
\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t
NameTypeDescription
raven\n\t\t\t\t\t\t\t\t\tRavenClient\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t

The Raven client used for sentry, if enabled.

\n\t\t\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t

Creates a new Logger

\n\t\t\t\t\t
\n\t\t\t\t\t
Parameters:
\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t
NameTypeAttributesDescription
options\n\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t

The configuration for the logger

\n\t\t\t\t\t\t\t\t\t
Properties
\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t
NameTypeAttributesDefaultDescription
timestamps\n\t\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\tfalse\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t

Add a timestamp to each message logged

\n\t\t\t\t\t\t\t\t\t\t\t\t
levels\n\t\t\t\t\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t

An object deciding what log levels should display

\n\t\t\t\t\t\t\t\t\t\t\t\t\t
Properties
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t
NameTypeAttributesDefaultDescription
log\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\ttrue\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

Show log()

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
info\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\ttrue\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

Show info()

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
debug\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tfalse\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

Show debug()

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
warning\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\ttrue\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

Show warn()

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
error\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\ttrue\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

Show error()

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\t\t\t\t\t
raven\n\t\t\t\t\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t

Raven options. If falsy, raven will not be required.

\n\t\t\t\t\t\t\t\t\t\t\t\t\t
Properties
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t
NameTypeAttributesDefaultDescription
url\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tString\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

Your project's sentry.io url

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
config\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tObject\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

A custom raven config. For more info check their docs

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
info\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tfalse\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

Send info() messages to sentry

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
debug\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tfalse\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

Send debug() messages to sentry

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
warning\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tfalse\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

Send warn() messages to sentry. If an Error is passed in the arguments, that will be sent alone.

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
error\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tBoolean\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t <optional>
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t		\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\ttrue\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t

Send error() errors to sentry. If an Error is passed in the arguments, that will be sent alone.

\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t

Members

\n\t\t\t\t

timestamp :String

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

A formatted timestamp

\n\t\t\t\t
\n\t\t\t\t
Type:
\n\t\t\t\t
    \n\t\t\t\t\t
  • \n\t\t\t\t\t\tString\n\t\t\t\t\t
    • \n\t\t\t\t
\n\t\t\t\t

Methods

\n\t\t\t\t

debug()

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Log debugging information

\n\t\t\t\t
\n\t\t\t\t

error()

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Log an error

\n\t\t\t\t
\n\t\t\t\t

info()

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Log informal text

\n\t\t\t\t
\n\t\t\t\t

log()

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Log generic text

\n\t\t\t\t
\n\t\t\t\t

warn()

\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Log a warning

\n\t\t\t\t
\n\t\t\t
\n\t\t
\n\t
\n\t
\n\t\n\t\n\t\n\n\n\n" }, { "path": "docs/index.html", "content": "\n\n\n\n\t\n\tHome - Documentation\n\t\n\t\n\t\n\t\n\t\n\n\n\n\t\n\t\n\t\n\t\n\t
\n\t\t
\n\t\t\t
\n\t\t\t\t

Mirai Bot Core

\n\t\t\t\t

\"Discord \"David\" \"GitHub \"Code\n\t\t\t\t\t\"npm\"

\n\t\t\t\t

A powerful Discord bot core using Eris.

\n\t\t\t\t

Documentation | Eris Docs | Mirai Bot Website | Support me on Patreon | Discord Server | Mirai Bot Combined Todo List

\n\t\t\t\t

mirai-bot-core supports advanced application monitoring with sentry.io using raven. For more information head over to the docs.

\n\t\t\t\t

Installing

\n\t\t\t\t
yarn add mirai-bot-core
\n\t\t\t\t
const Mirai = require('mirai-bot-core');\nconst bot = new Mirai(config);
\n\t\t\t\t

Abstract Classes

\n\t\t\t\t

Abstract classes are provided to ensure you have the required methods. They can be accessed like so:

\n\t\t\t\t
const AbstractCommand = require('mirai-bot-core/lib/Base/AbstractCommand');\n\nclass PingCommand extends AbstractCommand {\n    constructor() {\n        super();\n    }\n}
\n\t\t\t
\n\t\t
\n\t
\n\t
\n\t\n\t\n\t\n\n\n\n" }, { "path": "docs/scripts/linenumber.js", "content": "/*global document */\n(function() {\n var source = document.getElementsByClassName('prettyprint source linenums');\n var i = 0;\n var lineNumber = 0;\n var lineId;\n var lines;\n var totalLines;\n var anchorHash;\n\n if (source && source[0]) {\n anchorHash = document.location.hash.substring(1);\n lines = source[0].getElementsByTagName('li');\n totalLines = lines.length;\n\n for (; i < totalLines; i++) {\n lineNumber++;\n lineId = 'line' + lineNumber;\n lines[i].id = lineId;\n if (lineId === anchorHash) {\n lines[i].className += ' selected';\n }\n }\n }\n})();\n" }, { "path": "docs/scripts/prettify/Apache-License-2.0.txt", "content": "\n Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n" }, { "path": "docs/scripts/prettify/lang-css.js", "content": "PR.registerLangHandler(PR.createSimpleLexer([[\"pln\",/^[\\t\\n\\f\\r ]+/,null,\" \\t\\r\\n\f\"]],[[\"str\",/^\"(?:[^\\n\\f\\r\"\\\\]|\\\\(?:\\r\\n?|\\n|\\f)|\\\\[\\S\\s])*\"/,null],[\"str\",/^'(?:[^\\n\\f\\r'\\\\]|\\\\(?:\\r\\n?|\\n|\\f)|\\\\[\\S\\s])*'/,null],[\"lang-css-str\",/^url\\(([^\"')]*)\\)/i],[\"kwd\",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\\w-]|$)/i,null],[\"lang-css-kw\",/^(-?(?:[_a-z]|\\\\[\\da-f]+ ?)(?:[\\w-]|\\\\\\\\[\\da-f]+ ?)*)\\s*:/i],[\"com\",/^\\/\\*[^*]*\\*+(?:[^*/][^*]*\\*+)*\\//],[\"com\",\n/^(?:<\\!--|--\\>)/],[\"lit\",/^(?:\\d+|\\d*\\.\\d+)(?:%|[a-z]+)?/i],[\"lit\",/^#[\\da-f]{3,6}/i],[\"pln\",/^-?(?:[_a-z]|\\\\[\\da-f]+ ?)(?:[\\w-]|\\\\\\\\[\\da-f]+ ?)*/i],[\"pun\",/^[^\\s\\w\"']+/]]),[\"css\"]);PR.registerLangHandler(PR.createSimpleLexer([],[[\"kwd\",/^-?(?:[_a-z]|\\\\[\\da-f]+ ?)(?:[\\w-]|\\\\\\\\[\\da-f]+ ?)*/i]]),[\"css-kw\"]);PR.registerLangHandler(PR.createSimpleLexer([],[[\"str\",/^[^\"')]+/]]),[\"css-str\"]);\n" }, { "path": "docs/scripts/prettify/prettify.js", "content": "var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;\n(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:\"0\"<=b&&b<=\"7\"?parseInt(a.substring(1),8):b===\"u\"||b===\"x\"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?\"\\\\x0\":\"\\\\x\")+a.toString(16);a=String.fromCharCode(a);if(a===\"\\\\\"||a===\"-\"||a===\"[\"||a===\"]\")a=\"\\\\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\\\u[\\dA-Fa-f]{4}|\\\\x[\\dA-Fa-f]{2}|\\\\[0-3][0-7]{0,2}|\\\\[0-7]{1,2}|\\\\[\\S\\s]|[^\\\\]/g),a=\n[],b=[],o=f[0]===\"^\",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push(\"-\"),b.push(e(i[1])));b.push(\"]\");return b.join(\"\")}function y(a){for(var f=a.source.match(/\\[(?:[^\\\\\\]]|\\\\[\\S\\s])*]|\\\\u[\\dA-Fa-f]{4}|\\\\x[\\dA-Fa-f]{2}|\\\\\\d+|\\\\[^\\dux]|\\(\\?[!:=]|[()^]|[^()[\\\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a===\"[\"?f[c]=h(j):a!==\"\\\\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return\"[\"+String.fromCharCode(a&-33,a|32)+\"]\"}));return f.join(\"\")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&\"lang-\"===b.substring(0,5))&&!(o&&typeof o[1]===\"string\"))c=!1,b=\"src\";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),\nl=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=\"\"+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\\S\\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push([\"str\",/^(?:'''(?:[^'\\\\]|\\\\[\\S\\s]|''?(?=[^']))*(?:'''|$)|\"\"\"(?:[^\"\\\\]|\\\\[\\S\\s]|\"\"?(?=[^\"]))*(?:\"\"\"|$)|'(?:[^'\\\\]|\\\\[\\S\\s])*(?:'|$)|\"(?:[^\"\\\\]|\\\\[\\S\\s])*(?:\"|$))/,q,\"'\\\"\"]):a.multiLineStrings?m.push([\"str\",/^(?:'(?:[^'\\\\]|\\\\[\\S\\s])*(?:'|$)|\"(?:[^\"\\\\]|\\\\[\\S\\s])*(?:\"|$)|`(?:[^\\\\`]|\\\\[\\S\\s])*(?:`|$))/,\nq,\"'\\\"`\"]):m.push([\"str\",/^(?:'(?:[^\\n\\r'\\\\]|\\\\.)*(?:'|$)|\"(?:[^\\n\\r\"\\\\]|\\\\.)*(?:\"|$))/,q,\"\\\"'\"]);a.verbatimStrings&&e.push([\"str\",/^@\"(?:[^\"]|\"\")*(?:\"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push([\"com\",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,\"#\"]):m.push([\"com\",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\\b|[^\\n\\r]*)/,q,\"#\"]),e.push([\"str\",/^<(?:(?:(?:\\.\\.\\/)*|\\/?)(?:[\\w-]+(?:\\/[\\w-]+)+)?[\\w-]+\\.h|[a-z]\\w*)>/,q])):m.push([\"com\",/^#[^\\n\\r]*/,\nq,\"#\"]));a.cStyleComments&&(e.push([\"com\",/^\\/\\/[^\\n\\r]*/,q]),e.push([\"com\",/^\\/\\*[\\S\\s]*?(?:\\*\\/|$)/,q]));a.regexLiterals&&e.push([\"lang-regex\",/^(?:^^\\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\\(|\\*|\\*=|\\+=|,|-=|->|\\/|\\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\\^=|\\^\\^|\\^\\^=|{|\\||\\|=|\\|\\||\\|\\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\\s*(\\/(?=[^*/])(?:[^/[\\\\]|\\\\[\\S\\s]|\\[(?:[^\\\\\\]]|\\\\[\\S\\s])*(?:]|$))+\\/)/]);(h=a.types)&&e.push([\"typ\",h]);a=(\"\"+a.keywords).replace(/^ | $/g,\n\"\");a.length&&e.push([\"kwd\",RegExp(\"^(?:\"+a.replace(/[\\s,]+/g,\"|\")+\")\\\\b\"),q]);m.push([\"pln\",/^\\s+/,q,\" \\r\\n\\t\\xa0\"]);e.push([\"lit\",/^@[$_a-z][\\w$@]*/i,q],[\"typ\",/^(?:[@_]?[A-Z]+[a-z][\\w$@]*|\\w+_t\\b)/,q],[\"pln\",/^[$_a-z][\\w$@]*/i,q],[\"lit\",/^(?:0x[\\da-f]+|(?:\\d(?:_\\d+)*\\d*(?:\\.\\d*)?|\\.\\d\\+)(?:e[+-]?\\d+)?)[a-z]*/i,q,\"0123456789\"],[\"pln\",/^\\\\[\\S\\s]?/,q],[\"pun\",/^.[^\\s\\w\"-$'./@\\\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if(\"BR\"===a.nodeName)h(a),\na.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}\nfor(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\\s)nocode(?:\\s|$)/,t=/\\r\\n?|\\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue(\"white-space\"));var p=l&&\"pre\"===l.substring(0,3);for(l=s.createElement(\"LI\");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn(\"cannot override language handler %s\",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){\"console\"in window&&console.log(w&&w.stack?w.stack:w)}}var v=[\"break,continue,do,else,for,if,return,while\"],w=[[v,\"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile\"],\n\"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof\"],F=[w,\"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where\"],G=[w,\"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient\"],\nH=[G,\"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var\"],w=[w,\"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN\"],I=[v,\"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None\"],\nJ=[v,\"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END\"],v=[v,\"case,done,elif,esac,eval,fi,function,in,local,set,then,until\"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\\d*)/,N=/\\S/,O=u({keywords:[F,H,w,\"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END\"+\nI,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,[\"default-code\"]);k(x([],[[\"pln\",/^[^]*(?:>|$)/],[\"com\",/^<\\!--[\\S\\s]*?(?:--\\>|$)/],[\"lang-\",/^<\\?([\\S\\s]+?)(?:\\?>|$)/],[\"lang-\",/^<%([\\S\\s]+?)(?:%>|$)/],[\"pun\",/^(?:<[%?]|[%?]>)/],[\"lang-\",/^]*>([\\S\\s]+?)<\\/xmp\\b[^>]*>/i],[\"lang-js\",/^]*>([\\S\\s]*?)(<\\/script\\b[^>]*>)/i],[\"lang-css\",/^]*>([\\S\\s]*?)(<\\/style\\b[^>]*>)/i],[\"lang-in.tag\",/^(<\\/?[a-z][^<>]*>)/i]]),\n[\"default-markup\",\"htm\",\"html\",\"mxml\",\"xhtml\",\"xml\",\"xsl\"]);k(x([[\"pln\",/^\\s+/,q,\" \\t\\r\\n\"],[\"atv\",/^(?:\"[^\"]*\"?|'[^']*'?)/,q,\"\\\"'\"]],[[\"tag\",/^^<\\/?[a-z](?:[\\w-.:]*\\w)?|\\/?>$/i],[\"atn\",/^(?!style[\\s=]|on)[a-z](?:[\\w:-]*\\w)?/i],[\"lang-uq.val\",/^=\\s*([^\\s\"'>]*(?:[^\\s\"'/>]|\\/(?=\\s)))/],[\"pun\",/^[/<->]+/],[\"lang-js\",/^on\\w+\\s*=\\s*\"([^\"]+)\"/i],[\"lang-js\",/^on\\w+\\s*=\\s*'([^']+)'/i],[\"lang-js\",/^on\\w+\\s*=\\s*([^\\s\"'>]+)/i],[\"lang-css\",/^style\\s*=\\s*\"([^\"]+)\"/i],[\"lang-css\",/^style\\s*=\\s*'([^']+)'/i],[\"lang-css\",\n/^style\\s*=\\s*([^\\s\"'>]+)/i]]),[\"in.tag\"]);k(x([],[[\"atv\",/^[\\S\\s]+/]]),[\"uq.val\"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),[\"c\",\"cc\",\"cpp\",\"cxx\",\"cyc\",\"m\"]);k(u({keywords:\"null,true,false\"}),[\"json\"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),[\"cs\"]);k(u({keywords:G,cStyleComments:!0}),[\"java\"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),[\"bsh\",\"csh\",\"sh\"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),\n[\"cv\",\"py\"]);k(u({keywords:\"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END\",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),[\"perl\",\"pl\",\"pm\"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),[\"rb\"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),[\"js\"]);k(u({keywords:\"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes\",\nhashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),[\"coffee\"]);k(x([],[[\"str\",/^[\\S\\s]+/]]),[\"regex\"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement(\"PRE\");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b=\n!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&\"CODE\"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName===\"pre\"||o.tagName===\"code\"||o.tagName===\"xmp\")&&o.className&&o.className.indexOf(\"prettyprint\")>=0){b=!0;break}b||((b=(b=n.className.match(/\\blinenums\\b(?::(\\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p ul {\n padding: 0 10px;\n}\n\nnav > ul > li > a {\n color: #ec4963;\n}\n\nnav ul ul {\n margin-bottom: 10px\n}\n\nnav ul ul + ul {\n margin-top: -10px;\n}\n\nnav ul ul a {\n color: hsl(207, 1%, 60%);\n border-left: 1px solid hsl(207, 10%, 86%);\n}\n\nnav ul ul a,\nnav ul ul a:active {\n padding-left: 20px\n}\n\nnav h2 {\n font-size: 12px;\n margin: 0;\n padding: 0;\n}\n\nnav > h2 > a {\n display: block;\n margin: 10px 0 -10px;\n color: #ec4963 !important;\n}\n\nfooter {\n color: hsl(0, 0%, 28%);\n margin-left: 250px;\n display: block;\n padding: 15px;\n font-style: italic;\n font-size: 90%;\n}\n\n.ancestors {\n color: #999\n}\n\n.ancestors a {\n color: #999 !important;\n}\n\n.clear {\n clear: both\n}\n\n.important {\n font-weight: bold;\n color: #950B02;\n}\n\n.yes-def {\n text-indent: -1000px\n}\n\n.type-signature {\n color: #c8d2ff\n}\n\n.type-signature:last-child {\n color: #eee;\n}\n\n.name, .signature {\n font-family: Consolas, Monaco, 'Andale Mono', monospace\n}\n\n.signature {\n color: #adbcff;\n}\n\n.details {\n margin-top: 6px;\n border-left: 2px solid #DDD;\n line-height: 20px;\n font-size: 14px;\n}\n\n.details dt {\n width: 120px;\n float: left;\n padding-left: 10px;\n}\n\n.details dd {\n margin-left: 70px;\n margin-top: 6px;\n margin-bottom: 6px;\n}\n\n.details ul {\n margin: 0\n}\n\n.details ul {\n list-style-type: none\n}\n\n.details pre.prettyprint {\n margin: 0\n}\n\n.details .object-value {\n padding-top: 0\n}\n\n.description {\n margin-bottom: 1em;\n margin-top: 1em;\n}\n\n.code-caption {\n font-style: italic;\n font-size: 107%;\n margin: 0;\n}\n\n.prettyprint {\n font-size: 14px;\n overflow: auto;\n}\n\n.prettyprint.source {\n width: inherit;\n line-height: 18px;\n display: block;\n background-color: #2d2d2d;\n color: #aeaeae;\n}\n\n.prettyprint code {\n line-height: 18px;\n display: block;\n background-color: #2d2d2d;\n color: #4D4E53;\n}\n\n.prettyprint > code {\n padding: 15px;\n}\n\n.prettyprint .linenums code {\n padding: 0 15px\n}\n\n.prettyprint .linenums li:first-of-type code {\n padding-top: 15px\n}\n\n.prettyprint code span.line {\n display: inline-block\n}\n\n.prettyprint.linenums {\n padding-left: 70px;\n -webkit-user-select: none;\n -moz-user-select: none;\n -ms-user-select: none;\n user-select: none;\n}\n\n.prettyprint.linenums ol {\n padding-left: 0\n}\n\n.prettyprint.linenums li {\n border-left: 3px #34446B solid;\n}\n\n.prettyprint.linenums li.selected, .prettyprint.linenums li.selected * {\n background-color: #34446B;\n}\n\n.prettyprint.linenums li * {\n -webkit-user-select: text;\n -moz-user-select: text;\n -ms-user-select: text;\n user-select: text;\n}\n\n.params, .props {\n border-spacing: 0;\n border: 1px solid #ddd;\n border-collapse: collapse;\n border-radius: 3px;\n box-shadow: 0 1px 3px rgba(0,0,0,0.1);\n width: 100%;\n font-size: 14px;\n margin: 1em 0;\n}\n\n.params .type {\n white-space: nowrap;\n}\n\n.params code {\n white-space: pre;\n}\n\n.params td, .params .name, .props .name, .name code {\n color: #4D4E53;\n font-family: Consolas, Monaco, 'Andale Mono', monospace;\n font-size: 100%;\n}\n\n.params td, .params th, .props td, .props th {\n margin: 0px;\n text-align: left;\n vertical-align: top;\n padding: 10px;\n display: table-cell;\n}\n\n.params td {\n border-top: 1px solid #eee\n}\n\n.params thead tr, .props thead tr {\n background-color: #fff;\n font-weight: bold;\n}\n\n.params .params thead tr, .props .props thead tr {\n background-color: #fff;\n font-weight: bold;\n}\n\n.params td.description > p:first-child, .props td.description > p:first-child {\n margin-top: 0;\n padding-top: 0;\n}\n\n.params td.description > p:last-child, .props td.description > p:last-child {\n margin-bottom: 0;\n padding-bottom: 0;\n}\n\nspan.param-type, .params td .param-type, .param-type dd {\n color: #475ab3;\n font-family: Consolas, Monaco, 'Andale Mono', monospace\n}\n\n.param-type dt, .param-type dd {\n display: inline-block\n}\n\n.param-type {\n margin: 14px 0;\n}\n\n.disabled {\n color: #454545\n}\n\n/* navicon button */\n.navicon-button {\n display: none;\n position: relative;\n padding: 2.0625rem 1.5rem;\n transition: 0.25s;\n cursor: pointer;\n -webkit-user-select: none;\n -moz-user-select: none;\n -ms-user-select: none;\n user-select: none;\n opacity: .8;\n}\n.navicon-button .navicon:before, .navicon-button .navicon:after {\n transition: 0.25s;\n}\n.navicon-button:hover {\n transition: 0.5s;\n opacity: 1;\n}\n.navicon-button:hover .navicon:before, .navicon-button:hover .navicon:after {\n transition: 0.25s;\n}\n.navicon-button:hover .navicon:before {\n top: .825rem;\n}\n.navicon-button:hover .navicon:after {\n top: -.825rem;\n}\n\n/* navicon */\n.navicon {\n position: relative;\n width: 2.5em;\n height: .3125rem;\n background: #000;\n transition: 0.3s;\n border-radius: 2.5rem;\n}\n.navicon:before, .navicon:after {\n display: block;\n content: \"\";\n height: .3125rem;\n width: 2.5rem;\n background: #000;\n position: absolute;\n z-index: -1;\n transition: 0.3s 0.25s;\n border-radius: 1rem;\n}\n.navicon:before {\n top: .625rem;\n}\n.navicon:after {\n top: -.625rem;\n}\n\n/* open */\n.nav-trigger:checked + label:not(.steps) .navicon:before,\n.nav-trigger:checked + label:not(.steps) .navicon:after {\n top: 0 !important;\n}\n\n.nav-trigger:checked + label .navicon:before,\n.nav-trigger:checked + label .navicon:after {\n transition: 0.5s;\n}\n\n/* Minus */\n.nav-trigger:checked + label {\n -webkit-transform: scale(0.75);\n transform: scale(0.75);\n}\n\n/* × and + */\n.nav-trigger:checked + label.plus .navicon,\n.nav-trigger:checked + label.x .navicon {\n background: transparent;\n}\n\n.nav-trigger:checked + label.plus .navicon:before,\n.nav-trigger:checked + label.x .navicon:before {\n -webkit-transform: rotate(-45deg);\n transform: rotate(-45deg);\n background: #FFF;\n}\n\n.nav-trigger:checked + label.plus .navicon:after,\n.nav-trigger:checked + label.x .navicon:after {\n -webkit-transform: rotate(45deg);\n transform: rotate(45deg);\n background: #FFF;\n}\n\n.nav-trigger:checked + label.plus {\n -webkit-transform: scale(0.75) rotate(45deg);\n transform: scale(0.75) rotate(45deg);\n}\n\n.nav-trigger:checked ~ nav {\n left: 0 !important;\n}\n\n.nav-trigger:checked ~ .overlay {\n display: block;\n}\n\n.nav-trigger {\n position: fixed;\n top: 0;\n clip: rect(0, 0, 0, 0);\n}\n\n.overlay {\n display: none;\n position: fixed;\n top: 0;\n bottom: 0;\n left: 0;\n right: 0;\n width: 100%;\n height: 100%;\n background: hsla(0, 0%, 0%, 0.5);\n z-index: 1;\n}\n\n@media only screen and (min-width: 320px) and (max-width: 680px) {\n body {\n overflow-x: hidden;\n }\n\n nav {\n background: #FFF;\n width: 250px;\n height: 100%;\n position: fixed;\n top: 0;\n right: 0;\n bottom: 0;\n left: -250px;\n z-index: 3;\n padding: 0 10px;\n transition: left 0.2s;\n }\n\n .navicon-button {\n display: inline-block;\n position: fixed;\n top: 1.5em;\n right: 0;\n z-index: 2;\n }\n\n #main {\n width: 100%;\n min-width: 360px;\n }\n\n #main h1.page-title {\n margin: 1em 0;\n }\n\n #main section {\n padding: 0;\n }\n\n footer {\n margin-left: 0;\n }\n}\n\n/** Add a '#' to static members */\n[data-type=\"member\"] a::before {\n content: '#';\n display: inline-block;\n margin-left: -14px;\n margin-right: 5px;\n}\n" }, { "path": "docs/styles/prettify.css", "content": "/*! Color themes for Google Code Prettify | MIT License | github.com/jmblog/color-themes-for-google-code-prettify */\n.prettyprint {\n background: #2d2d2d;\n font-family: Menlo, \"Bitstream Vera Sans Mono\", \"DejaVu Sans Mono\", Monaco, Consolas, monospace;\n border: 0 !important;\n}\n\n.pln {\n color: #cccccc;\n}\n\n/* Specify class=linenums on a pre to get line numbering */\nol.linenums {\n margin-top: 0;\n margin-bottom: 0;\n color: #999999;\n}\n\nli.L0,\nli.L1,\nli.L2,\nli.L3,\nli.L4,\nli.L5,\nli.L6,\nli.L7,\nli.L8,\nli.L9 {\n padding-left: 1em;\n background-color: #2d2d2d;\n list-style-type: decimal;\n}\n\n@media screen {\n\n /* string content */\n\n .str {\n color: #99cc99;\n }\n\n /* keyword */\n\n .kwd {\n color: #cc99cc;\n }\n\n /* comment */\n\n .com {\n color: #999999;\n }\n\n /* type name */\n\n .typ {\n color: #6699cc;\n }\n\n /* literal value */\n\n .lit {\n color: #f99157;\n }\n\n /* punctuation */\n\n .pun {\n color: #cccccc;\n }\n\n /* lisp open bracket */\n\n .opn {\n color: #cccccc;\n }\n\n /* lisp close bracket */\n\n .clo {\n color: #cccccc;\n }\n\n /* markup tag name */\n\n .tag {\n color: #f2777a;\n }\n\n /* markup attribute name */\n\n .atn {\n color: #f99157;\n }\n\n /* markup attribute value */\n\n .atv {\n color: #66cccc;\n }\n\n /* declaration */\n\n .dec {\n color: #f99157;\n }\n\n /* variable name */\n\n .var {\n color: #f2777a;\n }\n\n /* function name */\n\n .fun {\n color: #6699cc;\n }\n}\n" }, { "path": "examples/mongoose/MongoMiddle.js", "content": "/* eslint-disable require-jsdoc */\n\n// Middleware example\n// Allows plugins to access a Mongo database\n// Includes caching with options.mUseCache to reduce delay\n\nconst Mongoose = require('mongoose');\nconst Schema = Mongoose.Schema;\n\nvar exampleSchema = new Schema({\n\tid: String,\n\tuses: { type: Number }\n}, { collection: 'guildSettings' });\n\nclass MongoDBMiddleware {\n\tconstructor(options = { URI: 'mongodb://admin:pass@localhost:27017/example' }) {\n\t\tthis.URI = options.URI;\n\t\tthis.models = { examples: Mongoose.model('examples', exampleSchema) };\n\t\tthis.cache = { examples: { } };\n\t}\n\n\tget name() {\n\t\treturn 'MongoDatabase';\n\t}\n\n\tload(bot) {\n\t\treturn new Promise(resolve => {\n\t\t\tthis.bot = bot;\n\t\t\tMongoose.Promise = global.Promise;\n\t\t\tMongoose.connect(this.URI, { useNewUrlParser: true });\n\t\t\tMongoose.connection.on('error', this.bot.logger.error.bind(this.bot.logger, 'Mongoose error:'));\n\t\t\tMongoose.connection.once('open', () => this.bot.logger.info('Mongoose Connected'));\n\t\t\tMongoose.set('useCreateIndex', true);\n\t\t\treturn resolve(this);\n\t\t});\n\t}\n\n\tdestroy() {\n\t\treturn new Promise(resolve => {\n\t\t\tthis.bot = undefined;\n\t\t\tMongoose.disconnect();\n\t\t\tMongoose.connection.removeAllListeners('error');\n\t\t\tMongoose.connection.removeAllListeners('open');\n\t\t\treturn resolve();\n\t\t});\n\t}\n\n\tinvalidate(collection, id) {\n\t\tif (this.cache.hasOwnProperty(collection) && this.cache[collection].hasOwnProperty(id))\n\t\t\tdelete this.cache[collection][id];\n\t}\n\n\tfindOne(collection, conditions, projection, options = {}) {\n\t\tif (options.mUseCache === true && options.lean === true && !projection) {\n\t\t\tif (this.cache[collection].hasOwnProperty(conditions.id))\n\t\t\t\treturn Promise.resolve(this.cache[collection][conditions.id]);\n\n\t\t\treturn this.models[collection].findOne(conditions, projection, options).then(resp => {\n\t\t\t\tthis.cache[collection][conditions.id] = resp;\n\t\t\t\treturn resp;\n\t\t\t});\n\t\t}\n\t\treturn this.models[collection].findOne(conditions, projection, options);\n\t}\n\n\tupdate(collection, conditions, doc, options) {\n\t\tif (conditions.hasOwnProperty('id'))\n\t\t\tthis.invalidate(collection, conditions.id);\n\n\t\treturn this.models[collection].updateOne(conditions, doc, options);\n\t}\n\n\tremove(collection, conditions) {\n\t\tif (conditions.hasOwnProperty('id'))\n\t\t\tthis.invalidate(collection, conditions.id);\n\n\t\treturn this.models[collection].deleteOne(conditions);\n\t}\n}\n\nmodule.exports = MongoDBMiddleware;\n" }, { "path": "examples/mongoose/index.js", "content": "/* eslint-disable require-jsdoc */\nglobal.Promise = require(\"bluebird\");\n\nconst Mirai = require('mirai-bot-core');\nconst mirai = new Mirai({ /* config here */ });\nconst MongoDB = require('./MongoMiddle');\nconst AbstractCommandPlugin = require('mirai-bot-core/lib/Base/AbstractCommandPlugin');\n\nmirai.connect()\n\t.then(() => mirai.loadMiddleware(MongoDB))\n\t.then(() => mirai.loadCommandPlugin(MongoTest))\n\t.catch(e => mirai.logger.error('Error during setup:', e));\n\nclass MongoTest extends AbstractCommandPlugin {\n\tconstructor() {\n\t\tsuper();\n\t\tthis.prefix = 'mt ';\n\t}\n\n\tget name() {\n\t\treturn 'mongo test';\n\t}\n\n\tget description() {\n\t\treturn 'mongo test commands';\n\t}\n\n\tget database() {\n\t\tif (!this._databaseIndex)\n\t\t\tthis._databaseIndex = this.bot.middleware.findIndex(m => m.name === 'MongoDatabase');\n\t\treturn this.bot.middleware[this._databaseIndex];\n\t}\n\n\tload(bot) {\n\t\tsuper.load(bot);\n\t\treturn Promise.resolve(this);\n\t}\n\n\tdestroy() {\n\t\tsuper.destroy();\n\t\treturn Promise.resolve();\n\t}\n\n\thandle(message) {\n\t\tif (message.content === this.prefix + 'find')\n\t\t\tthis.database.findOne('examples', { id: message.author.id }, null, { mUseCache: true, lean: true }).then(doc => {\n\t\t\t\tconsole.log(doc);\n\t\t\t});\n\t\telse if (message.content === this.prefix + 'create')\n\t\t\tthis.database.models.examples.create({ id: message.author.id, uses: 0 }).then(() => {\n\t\t\t\tconsole.log('Created document');\n\t\t\t});\n\t\telse if (message.content === this.prefix + 'update')\n\t\t\tthis.database.update('examples', { id: message.author.id }, { $inc: { uses: 1 } }).then(() => {\n\t\t\t\tconsole.log('Increased uses by 1');\n\t\t\t});\n\t}\n}\n" }, { "path": "index.js", "content": "module.exports = require('./lib/Bot.js');\n" }, { "path": "lib/Base/AbstractCommand.js", "content": "/**\n * A command managed by a CommandPlugin\n * @abstract\n */\nclass AbstractCommand {\n\t/**\n\t * Creates a new AbstractCommand\n\t * @abstract\n\t */\n\tconstructor() {\n\t\tif (this.constructor === AbstractCommand)\n\t\t\tthrow new Error(\"Can't instantiate an abstract class!\");\n\t}\n\n\t/**\n\t * The name of the command\n\t * @type {String}\n\t * @abstract\n\t */\n\tget name() {\n\t\tthrow new Error('name must be overwritten');\n\t}\n\n\t/**\n\t * A description of the command\n\t * @type {String}\n\t * @abstract\n\t */\n\tget description() {\n\t\treturn '';\n\t}\n\n\t/**\n\t * Loads the command\n\t * @param {AbstractCommandPlugin} parent The plugin managing this command\n\t * @returns {Promise} Resolves with `this`\n\t */\n\tload(parent) {\n\t\tthis.parent = parent;\n\t\treturn Promise.resolve(this);\n\t}\n\n\t/**\n\t * Destroys/unloads the command\n\t * @returns {Promise} Resolves with no value\n\t */\n\tdestroy() {\n\t\tthis.parent = undefined;\n\t\treturn Promise.resolve();\n\t}\n\n\t/**\n\t * Send a message to discord\n\t * @param {Message} message The message to respond to\n\t * @param {String|Object} content The content to be passed to Eris.Client#createMessage\n\t * @param {Object} [options] Options for sending the message\n\t * @param {Boolean} [options.deleteTrigger=false] Delete the message that triggered the command\n\t * @param {Number} [options.deleteAfter=0] Delete the created message after this many milliseconds\n\t * @param {Boolean} [options.DM=false] Send in a Direct Message\n\t * @param {Object} [options.file] The file to be sent with the message. Format as shown in the Eris docs\n\t * @param {Boolean} [options.paginate] Split the message at 2000 character intervals. Used to send log messages that would normally fail\n\t * @returns {Promise} The sent message, or nothing if pagination is true\n\t * @see {@link http://eris.tachibana.erendale.abal.moe/Eris/docs/Client#function-createMessage|Eris.Client#createMessage}\n\t */\n\tsendMessage(message, content, options) {\n\t\tif (!message || (!content && !options))\n\t\t\treturn Promise.resolve();\n\n\t\toptions = options || { };\n\n\t\tif (options.deleteTrigger && message.channel.guild && message.channel.permissionsOf(this.parent.bot.user.id).has('manageMessages'))\n\t\t\tmessage.delete().catch(error => this.parent.logger.warn('Error deleting trigger:', error));\n\n\t\tif (typeof content !== 'object')\n\t\t\tcontent = { content };\n\n\t\tif (content.embed && !message.channel.permissionsOf(this.parent.bot.user.id).has('embedLinks'))\n\t\t\treturn Promise.resolve(this._sendMessage(message.channel, 'Unable to send message. I need the Embed Links permission', { }));\n\n\t\tif (options.file && !message.channel.permissionsOf(this.parent.bot.user.id).has('attachFiles'))\n\t\t\treturn Promise.resolve(this._sendMessage(message.channel, 'Unable to send message. I need the Attach Files permission', { }));\n\n\t\treturn (options.DM ? message.author.getDMChannel() : Promise.resolve(message.channel)).then(channel => {\n\t\t\tif (!options.paginate)\n\t\t\t\treturn this._sendMessage(channel, content, options);\n\n\t\t\tlet i = 0;\n\t\t\twhile (i < content.content.length) {\n\t\t\t\tlet _content = JSON.parse(JSON.stringify(content)); // Clone\n\t\t\t\t_content.content = content.content.slice(i, i + 2000);\n\t\t\t\tthis._sendMessage(channel, _content, options);\n\t\t\t\ti += 2000;\n\t\t\t\toptions.file = undefined;\n\t\t\t}\n\n\t\t\treturn Promise.resolve();\n\t\t}).catch(error => this.parent.logger.warn('Error getting DM channel:', error));\n\t}\n\n\t/**\n\t * @private\n\t * @param {Channel} channel The channel to create the message in\n\t * @param {String|Object} content The content to be passed to Eris.Client#createMessage\n\t * @param {Object} [options] Options for sending the message\n\t * @returns {Promise} The sent message\n\t */\n\t_sendMessage(channel, content, options) {\n\t\treturn channel.createMessage(content, options.file).then(message => {\n\t\t\tif (options.deleteAfter > 0)\n\t\t\t\tsetTimeout(() => {\n\t\t\t\t\tmessage.delete().catch(error => this.parent.logger.warn('Error deleting message (deleteAfter): ', error));\n\t\t\t\t}, options.deleteAfter);\n\n\t\t\treturn message;\n\t\t}).catch(error => this.parent.logger.warn('Error creating message:', error));\n\t}\n\n\t/**\n\t * Await a message, the trigger a function\n\t * @param {Function} trigger A function that takes a Message and returns a Boolean\n\t * @param {Function} action A function to be executed when `trigger` returns true\n\t * @param {Number} [timeout] Delete the await after this many milliseconds\n\t * @returns {Number} The unique id of the await\n\t */\n\tawaitMessage(trigger, action, timeout) {\n\t\treturn this.parent.bot.chatHandler.awaitMessage(trigger, action, timeout);\n\t}\n\n\t/**\n\t * Escape any discord markdown present in a string\n\t * @param {String} text The text to escape\n\t * @returns {String} The escaped text\n\t */\n\tescapeMarkdown(text) {\n\t\treturn text.replace(/([`*_~])/g, '\\\\$1');\n\t}\n\n\t/**\n\t * Check if a user is on cooldown\n\t * @param {String} userID The id of the user to check for\n\t * @param {Number} waitTime If not on cooldown, put them on cooldown for this many milliseconds\n\t * @returns {Boolean} If the user is still on cooldown\n\t */\n\tuserOnCooldown(userID, waitTime) {\n\t\tif (!this.cooldownUsers)\n\t\t\tthis.cooldownUsers = new Set();\n\n\t\tif (this.cooldownUsers.has(userID))\n\t\t\treturn true;\n\n\t\tthis.cooldownUsers.add(userID);\n\t\tsetTimeout(() => this.cooldownUsers.delete(userID), waitTime);\n\n\t\treturn false;\n\t}\n}\n\nmodule.exports = AbstractCommand;\n" }, { "path": "lib/Base/AbstractCommandPlugin.js", "content": "/**\n * A set of commands\n * @abstract\n */\nclass AbstractCommandPlugin {\n\t/**\n\t * Creates a new AbstractCommandPlugin\n\t * @abstract\n\t */\n\tconstructor() {\n\t\tif (this.constructor === AbstractCommandPlugin)\n\t\t\tthrow new Error(\"Can't instantiate an abstract class!\");\n\n\t\tthis.commands = {};\n\t}\n\n\t/**\n\t * An array containing, in this order: name, description, array of command names, array of command descriptions\n\t * @type {Array}\n\t * @abstract\n\t */\n\tget help() {\n\t\treturn [this.name, this.description, Object.keys(this.commands), Object.keys(this.commands).map(cmd => this.commands[cmd].description)];\n\t}\n\n\t/**\n\t * The name of the plugin\n\t * @type {String}\n\t * @abstract\n\t */\n\tget name() {\n\t\tthrow new Error('name must be overwritten');\n\t}\n\n\t/**\n\t * A description of the plugin\n\t * @type {String}\n\t * @abstract\n\t */\n\tget description() {\n\t\treturn '';\n\t}\n\n\t/**\n\t * Loads the plugin\n\t * @param {Bot} bot The main client\n\t * @returns {Promise} Resolves with `this`\n\t */\n\tload(bot) {\n\t\tthis.logger = bot.logger;\n\t\tthis.bot = bot;\n\t\treturn Promise.resolve(this);\n\t}\n\n\t/**\n\t * Destroys/unloads the plugin\n\t * @returns {Promise} Resolves with no value\n\t */\n\tdestroy() {\n\t\tthis.logger = undefined;\n\t\tthis.bot = undefined;\n\t\treturn Promise.resolve();\n\t}\n\n\t/**\n\t * Handle a message\n\t * @type {String}\n\t * @abstract\n\t */\n\thandle() {\n\t\tthrow new Error('handle must be overwritten');\n\t}\n}\n\nmodule.exports = AbstractCommandPlugin;\n" }, { "path": "lib/Base/AbstractEventPlugin.js", "content": "/**\n * Handles events emitted from eris\n * @abstract\n */\nclass AbstractEventPlugin {\n\t/**\n\t * Creates a new AbstractEventPlugin\n\t * @abstract\n\t */\n\tconstructor() {\n\t\tif (this.constructor === AbstractEventPlugin)\n\t\t\tthrow new Error(\"Can't instantiate an abstract class!\");\n\t}\n\n\t/**\n\t * The name of the plugin\n\t * @type {String}\n\t * @abstract\n\t */\n\tget name() {\n\t\tthrow new Error('name must be overwritten');\n\t}\n\n\t/**\n\t * Loads the plugin\n\t * @param {Bot} bot The main client\n\t * @returns {Promise} Resolves with `this`\n\t */\n\tload(bot) {\n\t\tthis.logger = bot.logger;\n\t\tthis.bot = bot;\n\t\treturn Promise.resolve(this);\n\t}\n\n\t/**\n\t * Destroys/unloads the plugin\n\t * @returns {Promise} Resolves with no value\n\t */\n\tdestroy() {\n\t\tthis.logger = undefined;\n\t\tthis.bot = undefined;\n\t\treturn Promise.resolve();\n\t}\n}\n\nmodule.exports = AbstractEventPlugin;\n" }, { "path": "lib/Base/AbstractMiddleware.js", "content": "/**\n * Manages external connections to and from the bot\n * @abstract\n */\nclass AbstractMiddleware {\n\t/**\n\t * Creates a new AbstractMiddleware\n\t * @abstract\n\t */\n\tconstructor() {\n\t\tif (this.constructor === AbstractMiddleware)\n\t\t\tthrow new Error(\"Can't instantiate an abstract class!\");\n\t}\n\n\t/**\n\t * The name of the middleware\n\t * @type {String}\n\t * @abstract\n\t */\n\tget name() {\n\t\tthrow new Error('name must be overwritten');\n\t}\n\n\t/**\n\t * Loads the middleware\n\t * @param {Bot} bot The main client\n\t * @returns {Promise} Resolves with `this`\n\t */\n\tload(bot) {\n\t\tthis.logger = bot.logger;\n\t\tthis.bot = bot;\n\t\treturn Promise.resolve(this);\n\t}\n\n\t/**\n\t * Destroys/unloads the middleware\n\t * @returns {Promise} Resolves with no value\n\t */\n\tdestroy() {\n\t\tthis.logger = undefined;\n\t\tthis.bot = undefined;\n\t\treturn Promise.resolve();\n\t}\n}\n\nmodule.exports = AbstractMiddleware;\n" }, { "path": "lib/Bot.js", "content": "const Logger = require('./Logger.js');\nconst ChatHandler = require('./ChatHandler.js');\nconst Eris = require('eris');\nconst axios = require('axios');\n\nlet Promise;\ntry {\n\tPromise = require(\"bluebird\");\n} catch(err) {\n\tPromise = global.Promise;\n}\n\n/**\n * Manages the connection to Discord and interaction between plugins\n * @extends Eris.Client\n * @prop {String} carbonBotsKey The API key for carbon bot list\n * @prop {String} discordBotsKey The API key for bots.discord.pw\n * @prop {String} discordBotsOrgKey The API key for discordbots.org\n * @prop {String} botsOnDiscordKey The API key for bots.ondiscord.xyz\n * @prop {Function} logger The logging wrapper\n * @prop {Function} chatHandler The class handling chat messages\n * @prop {Array} blacklistedGuilds Guilds that are banned from using the bot\n * @prop {Array} blacklistedUsers Users that are banned from using the bot\n * @prop {Object} commandPlugins The loaded command plugins\n * @prop {Object} eventPlugins The loaded event plugins\n * @prop {Object} middleware The loaded middleware\n * @see {@link https://abal.moe/Eris/docs/Client|Eris.Client}\n */\nclass Bot extends Eris.Client {\n\t/**\n\t * Creates a new instance of Mirai\n\t * @param {Object} options An object defining the configuration for Mirai\n\t * @param {String} options.token The token for your bot\n\t * @param {String} [options.carbonBotsKey] An API key for carbon bot list\n\t * @param {String} [options.discordBotsKey] An API key for bots.discord.pw\n\t * @param {String} [options.discordBotsOrgKey] An API key for discordbots.org\n\t * @param {String} [options.botsOnDiscordKey] An API key for bots.ondiscord.xyz\n\t * @param {Array} [options.blacklistedGuilds] Guilds that are banned from using the bot\n\t * @param {Array} [options.blacklistedUsers] Users that are banned from using the bot\n\t * @param {Boolean} [options.gracefulExit] When SIGINT is received, destroy all plugins and middleware, and disconnect the bot\n\t * @param {Object} [options.eris] The options to pass to the eris client. See {@link https://abal.moe/Eris/docs/Client|the Eris docs}\n\t * @param {Object} [options.logger] The options to pass to the logger\n\t * @param {Object} [options.chatHandler] The options to pass to the chatHandler\n\t * @param {Function} [rLogger] A replacement Logger. Must implement `log` `info` `debug` `warn` and `error`. Is passed `this` and `options.logger`\n\t * @param {Function} [rChatHandler] A replacement ChatHandler. Must implement `run` and `stop`. Is passed `this` and `options.chatHandler`\n\t * @example Create a new instance of Mirai\n\t * const Mirai = require('mirai-bot-core');\n\t * var config = require('./config.json');\n\t * var mirai = new Mirai(config);\n\t */\n\tconstructor(options = { }, rLogger, rChatHandler) {\n\t\tsuper(options.token, options.eris);\n\n\t\tthis.carbonBotsKey = options.carbonBotsKey;\n\t\tthis.discordBotsKey = options.discordBotsKey;\n\t\tthis.discordBotsOrgKey = options.discordBotsOrgKey;\n\t\tthis.botsOnDiscordKey = options.botsOnDiscordKey;\n\n\t\tthis.logger = rLogger ? new rLogger(this, options.logger) : new Logger(options.logger);\n\t\tthis.chatHandler = rChatHandler ? new rChatHandler(this, options.chatHandler) : new ChatHandler(this, options.chatHandler);\n\t\tthis.blacklistedGuilds = options.blacklistedGuilds || [];\n\t\tthis.blacklistedUsers = options.blacklistedUsers || [];\n\t\tthis.commandPlugins = { };\n\t\tthis.eventPlugins = { };\n\t\tthis.middleware = { };\n\n\t\tthis.once('ready', () => {\n\t\t\tthis.chatHandler.run();\n\t\t\treturn this.logger.info('Mirai: Connected to Discord');\n\t\t});\n\t\tthis.on('error', (error, shard) =>\n\t\t\terror && this.logger.error(`Mirai: ${shard !== undefined ? `Shard ${shard} error` : 'Error'}:`, error));\n\t\tthis.on('disconnected', () => this.logger.warn('Mirai: Disconnected from Discord'));\n\t\tthis.on('shardReady', shard => this.logger.info(`Mirai: Shard ${shard} ready`));\n\t\tthis.on('shardDisconnect', (error, shard) => error && this.logger.warn(`Mirai: Shard ${shard} disconnected with error:`, error.message));\n\t\tthis.on('shardResume', shard => this.logger.info(`Mirai: Shard ${shard} resumed`));\n\n\t\tif (this.blacklistedGuilds.length !== 0) {\n\t\t\tthis.on('guildCreate', async guild => {\n\t\t\t\tif (this.blacklistedGuilds.includes(guild.id)) {\n\t\t\t\t\tawait guild.leave();\n\t\t\t\t\treturn this.logger.info('Mirai: Left blacklisted guild', guild.name);\n\t\t\t\t}\n\t\t\t});\n\t\t}\n\n\t\tif (options.gracefulExit === true) {\n\t\t\tprocess.on('SIGINT', () => {\n\t\t\t\tthis.logger.info('SIGINT detected, shutting down');\n\t\t\t\tconst destroyAll = Object.values(this.commandPlugins).map(p => p.destroy())\n\t\t\t\t\t.concat(Object.values(this.eventPlugins).map(p => p.destroy()), Object.values(this.middleware).map(m => m.destroy()));\n\n\t\t\t\tthis.disconnect({ reconnect: false });\n\t\t\t\tPromise.all(destroyAll).then(() => process.exit(0)).catch(error => {\n\t\t\t\t\tthis.logger.error(error);\n\t\t\t\t\tprocess.exit(1);\n\t\t\t\t});\n\t\t\t});\n\t\t}\n\t}\n\n\t/**\n\t * @param {Function} plugin The plugin to load. Must have a `load` method which is passed `this`\n\t * @see {@link AbstractCommandPlugin}\n\t * @example Loading a Command Plugin\n\t * var funCommands = new FunCommandsPlugin();\n\t * mirai.loadCommandPlugin(funCommands);\n\t * @returns {Promise} The return value of `plugin.load`\n\t * @async\n\t */\n\tasync loadCommandPlugin(plugin) {\n\t\tif (!plugin.name || !!this.commandPlugins[plugin.name])\n\t\t\tthrow new Error('Plugin must have a unique name');\n\n\t\tconst result = await plugin.load(this);\n\t\tthis.commandPlugins[plugin.name] = plugin;\n\n\t\treturn result;\n\t}\n\n\t/**\n\t * Reload a plugin by searching for a plugin with the same name and replacing it\n\t * @param {Function} plugin The plugin to load. Must have a `load` method which is passed `this`\n\t * @returns {Promise} The return value of `plugin.load`\n\t * @async\n\t */\n\tasync reloadCommandPlugin(plugin) {\n\t\tif (!plugin.name)\n\t\t\tthrow new Error('Plugin must have a name');\n\n\t\tif (!this.commandPlugins[plugin.name])\n\t\t\tthrow new Error(`No command plugin with name ${plugin.name} is loaded`);\n\n\t\tawait this.commandPlugins[plugin.name].destroy();\n\t\tconst result = await plugin.load(this);\n\t\tthis.commandPlugins[plugin.name] = plugin;\n\n\t\treturn result;\n\t}\n\n\t/**\n\t * @param {Function} plugin The plugin to load. Must have a `load` method which is passed `this`\n\t * @returns {Promise} The return value of `plugin.load`\n\t * @async\n\t */\n\tasync loadEventPlugin(plugin) {\n\t\tif (!plugin.name || !!this.eventPlugins[plugin.name])\n\t\t\tthrow new Error('Plugin must have a unique name');\n\n\t\tconst result = await plugin.load(this);\n\t\tthis.eventPlugins[plugin.name] = plugin;\n\n\t\treturn result;\n\t}\n\n\t/**\n\t * Reload a plugin by searching for a plugin with the same name and replacing it\n\t * @param {Function} plugin The plugin to load. Must have a `load` method which is passed `this`\n\t * @returns {Promise} The return value of `plugin.load`\n\t * @async\n\t */\n\tasync reloadEventPlugin(plugin) {\n\t\tif (!plugin.name)\n\t\t\tthrow new Error('Plugin must have a name');\n\n\t\tif (!this.eventPlugins[plugin.name])\n\t\t\tthrow new Error(`No event plugin with name ${plugin.name} is loaded`);\n\n\t\tawait this.eventPlugins[plugin.name].destroy();\n\t\tconst result = await plugin.load(this);\n\t\tthis.eventPlugins[plugin.name] = plugin;\n\n\t\treturn result;\n\t}\n\n\t/**\n\t * @param {Function} middleware The middleware to load. Must have a `load` method which is passed `this`\n\t * @returns {Promise} The return value of `middleware.load`\n\t * @async\n\t */\n\tasync loadMiddleware(middleware) {\n\t\tif (!middleware.name || !!this.middleware[middleware.name])\n\t\t\tthrow new Error('Middleware must have a unique name');\n\n\t\tconst result = await middleware.load(this);\n\t\tthis.middleware[middleware.name] = middleware;\n\n\t\treturn result;\n\t}\n\n\t/**\n\t * Reload middleware by searching for middleware with the same name and replacing it\n\t * @param {Function} middleware The middleware to load. Must have a `load` method which is passed `this`\n\t * @returns {Promise} The return value of `middleware.load`\n\t * @async\n\t */\n\tasync reloadMiddleware(middleware) {\n\t\tif (!middleware.name)\n\t\t\tthrow new Error('Middleware must have a name');\n\n\t\tif (!this.middleware[middleware.name])\n\t\t\tthrow new Error(`No middleware with name ${middleware.name} is loaded`);\n\n\t\tawait this.middleware[middleware.name].destroy();\n\t\tconst result = await middleware.load(this);\n\t\tthis.middleware[middleware.name] = middleware;\n\n\t\treturn result;\n\t}\n\n\t/**\n\t * Updates information on carbonitex.net\n\t * @param {String} [key] Carbon API key\n\t * @returns {Promise} The axios request result or error\n\t * @see {@link https://github.com/mzabriskie/axios/blob/master/README.md#response-schema|Axios response}\n\t * @async\n\t */\n\tasync updateCarbon(key) {\n\t\ttry {\n\t\t\tconst response = await axios.post('https://www.carbonitex.net/discord/data/botdata.php', {\n\t\t\t\tkey: key || this.carbonBotsKey,\n\t\t\t\tservercount: this.guilds.size\n\t\t\t});\n\n\t\t\tthis.logger.debug(`Updated carbonitex.net guild count to ${this.guilds.size}. Response: ${response.status}`);\n\t\t\treturn response;\n\t\t} catch (error) {\n\t\t\tif (error.response)\n\t\t\t\tthis.logger.warn(`Response status ${error.response.status} from carbonitex.net. Data: ${error.response.data}`);\n\t\t\telse\n\t\t\t\tthis.logger.error('Error during axios request:', error.stack);\n\n\t\t\treturn error;\n\t\t}\n\t}\n\n\t/**\n\t * Updates information on bots.discord.pw\n\t * @param {String} [key] bots.discord.pw API key\n\t * @returns {Promise} The axios request result or error\n\t * @see {@link https://github.com/mzabriskie/axios/blob/master/README.md#response-schema|Axios response}\n\t * @async\n\t */\n\tasync updateDiscordBots(key) {\n\t\ttry {\n\t\t\tconst response = await axios.post(`https://bots.discord.pw/api/bots/${this.user.id}/stats`, { server_count: this.guilds.size }, {\n\t\t\t\theaders: { 'Authorization': key || this.discordBotsKey }\n\t\t\t});\n\n\t\t\tthis.logger.debug(`Updated bots.discord.pw guild count to ${this.guilds.size}. Response: ${response.status}`);\n\t\t\treturn response;\n\t\t} catch (error) {\n\t\t\tif (error.response)\n\t\t\t\tthis.logger.warn(`Response status ${error.response.status} from bots.discord.pw. Data: ${error.response.data}`);\n\t\t\telse\n\t\t\t\tthis.logger.error('Error during axios request:', error.stack);\n\n\t\t\treturn error;\n\t\t}\n\t}\n\n\t/**\n\t * Updates information on discordbots.org\n\t * @param {String} [key] discordbots API key\n\t * @returns {Promise} The axios request result or error\n\t * @see {@link https://github.com/mzabriskie/axios/blob/master/README.md#response-schema|Axios response}\n\t * @async\n\t */\n\tasync updateDiscordBotsOrg(key) {\n\t\ttry {\n\t\t\tconst response = await axios.post(`https://discordbots.org/api/bots/${this.user.id}/stats`, { server_count: this.guilds.size }, {\n\t\t\t\theaders: { 'Authorization': key || this.discordBotsOrgKey }\n\t\t\t});\n\n\t\t\tthis.logger.debug(`Updated discordbots.org guild count to ${this.guilds.size}. Response: ${response.status}`);\n\t\t\treturn response;\n\t\t} catch (error) {\n\t\t\tif (error.response)\n\t\t\t\tthis.logger.warn(`Response status ${error.response.status} from discordbots.org. Data: ${error.response.data}`);\n\t\t\telse\n\t\t\t\tthis.logger.error('Error during axios request:', error.stack);\n\n\t\t\treturn error;\n\t\t}\n\t}\n\n\t/**\n\t * Updates information on bots.ondiscord.xyz\n\t * @param {String} [key] bots.ondiscord.xyz API key\n\t * @returns {Promise} The axios request result or error\n\t * @see {@link https://github.com/mzabriskie/axios/blob/master/README.md#response-schema|Axios response}\n\t * @async\n\t */\n\tasync updateBotsOnDiscord(key) {\n\t\ttry {\n\t\t\tconst response = await axios.post(`https://bots.ondiscord.xyz/bot-api/bots/${this.user.id}/guilds`, { guildCount: this.guilds.size }, {\n\t\t\t\theaders: { 'Authorization': key || this.botsOnDiscordKey }\n\t\t\t});\n\n\t\t\tthis.logger.debug(`Updated bots.ondiscord.xyz guild count to ${this.guilds.size}. Response: ${response.status}`);\n\t\t\treturn response;\n\t\t} catch (error) {\n\t\t\tif (error.response)\n\t\t\t\tthis.logger.warn(`Response status ${error.response.status} from bots.ondiscord.xyz. Data: ${error.response.data}`);\n\t\t\telse\n\t\t\t\tthis.logger.error('Error during axios request:', error.stack);\n\n\t\t\treturn error;\n\t\t}\n\t}\n\n\t/**\n\t * Sets the bot's avatar from a url\n\t * @param {String} url A direct link to an image\n\t * @returns {Promise} Resolves on completion\n\t * @async\n\t */\n\tasync setAvatar(url) {\n\t\ttry {\n\t\t\tconst response = await axios.get(url, {\n\t\t\t\theaders: { 'Accept': 'image/*' },\n\t\t\t\tresponseType: 'arraybuffer'\n\t\t\t});\n\n\t\t\tawait this.editSelf({avatar: `data:${response.headers['content-type']};base64,${response.data.toString('base64')}`});\n\n\t\t\treturn this.logger.debug('Updated avatar from ' + url);\n\t\t} catch (error) {\n\t\t\tif (error.response)\n\t\t\t\tthis.logger.warn('Failed to fetch avatar:', error.response.data || error.response.status);\n\t\t\telse\n\t\t\t\tthis.logger.warn('Failed to update avatar from ' + url, error);\n\n\t\t\tthrow error;\n\t\t}\n\t}\n\n\t/**\n\t * Resolve a name or ID to a user\n\t * @param {String} query The name or ID to match\n\t * @returns {User?} The user the was found\n\t * @see {@link https://abal.moe/Eris/docs/User|Eris.User}\n\t */\n\tfindUser(query) {\n\t\tquery = query.toLowerCase().trim();\n\n\t\tif (/^[0-9]{16,19}$/.test(query)) { // If query looks like an ID try to get by ID\n\t\t\tconst user = this.users.get(query);\n\t\t\tif (user)\n\t\t\t\treturn user;\n\t\t}\n\n\t\tlet result = this.users.find(user => user.username.toLowerCase() === query);\n\t\tif (!result)\n\t\t\tresult = this.users.find(user => user.username.toLowerCase().includes(query));\n\t\treturn result || null;\n\t}\n\n\t/**\n\t * Resolve a name or ID to a guild member\n\t * @param {String} query The name or ID to match\n\t * @param {Collection} members The Collection of guild members\n\t * @returns {Member?} The member the was found\n\t * @see {@link https://abal.moe/Eris/docs/Member|Eris.Member}\n\t */\n\tfindMember(query, members) {\n\t\tquery = query.toLowerCase().trim();\n\n\t\tif (/^[0-9]{16,19}$/.test(query)) { // If query looks like an ID try to get by ID\n\t\t\tconst member = members.get(query);\n\t\t\tif (member)\n\t\t\t\treturn member;\n\t\t}\n\n\t\tlet result = members.find(member => member.user.username.toLowerCase() === query);\n\t\tif (!result) result = members.find(member => member.nick && member.nick.toLowerCase() === query);\n\t\tif (!result) result = members.find(member => member.user.username.toLowerCase().includes(query));\n\t\tif (!result) result = members.find(member => member.nick && member.nick.toLowerCase().includes(query));\n\t\treturn result || null;\n\t}\n}\n\nmodule.exports = Bot;\n" }, { "path": "lib/ChatHandler.js", "content": "/**\n * Handles messages received by the client\n * @prop {Bot} bot The bot\n * @prop {Object} awaits The active awaits\n */\nclass ChatHandler {\n\t/**\n\t * Creates a new ChatHandler\n\t * @param {Bot} [bot] The main client\n\t * @param {Object} [options] The configuration to use\n\t * @param {Boolean} [options.allowSelf=false] Allow messages from the bot to be handled\n\t * @param {Boolean} [options.allowBots=false] Allow messages from bots to be handled\n\t * @param {Object} [options.defaultHelpCommand] Enable the default help command\n\t * @param {String} [options.defaultHelpCommand.prefix=\"!\"] The prefix to use for the help command\n\t * @param {String} [options.defaultHelpCommand.before] The text to put as a header\n\t * @param {String} [options.defaultHelpCommand.after] The text to put as a footer\n\t * @param {String} [options.defaultHelpCommand.title] The text to put as a title (bolded)\n\t * @param {String} [options.defaultHelpCommand.style=\"extended\"] One of the following: basic, extended, embed\n\t */\n\tconstructor(bot, options = { }) {\n\t\tthis.bot = bot;\n\n\t\tthis.allowSelf = !!options.allowSelf;\n\t\tthis.allowBots = !!options.allowBots;\n\t\tthis.awaits = { };\n\t\tthis._nextAwaitId = 0;\n\t\tthis.defaultHelpCommand = options.defaultHelpCommand !== undefined;\n\n\t\tif (this.defaultHelpCommand === true) {\n\t\t\tthis.help = {\n\t\t\t\tprefix: options.defaultHelpCommand.prefix || '!',\n\t\t\t\tbefore: options.defaultHelpCommand.before,\n\t\t\t\tafter: options.defaultHelpCommand.after,\n\t\t\t\ttitle: options.defaultHelpCommand.title,\n\t\t\t\tstyle: options.defaultHelpCommand.style\n\t\t\t};\n\t\t}\n\n\t\tthis.messageHandler = message => {\n\t\t\tif ((message.author.id === this.bot.user.id && this.allowSelf === false) ||\n\t\t\t\t(message.author.bot && this.allowBots === false) ||\n\t\t\t\t(message.channel.guild && this.bot.blacklistedGuilds.includes(message.channel.guild.id)) ||\n\t\t\t\tthis.bot.blacklistedUsers.includes(message.author.id))\n\t\t\t\treturn;\n\n\t\t\tif (this.defaultHelpCommand && message.content === this.help.prefix + 'help')\n\t\t\t\tthis.getHelp(message);\n\n\t\t\tObject.values(this.bot.commandPlugins).forEach(plugin => plugin.handle(message));\n\n\t\t\tfor (let id in this.awaits) {\n\t\t\t\tif (this.awaits[id].trigger(message)) {\n\t\t\t\t\tthis.awaits[id].action(message);\n\t\t\t\t\tdelete this.awaits[id];\n\t\t\t\t}\n\t\t\t}\n\t\t};\n\t}\n\n\t/** Starts listening for messages */\n\trun() {\n\t\tthis.bot.on('messageCreate', this.messageHandler);\n\t}\n\n\t/** Stops listening for messages */\n\tstop() {\n\t\tthis.bot.removeListener('messageCreate', this.messageHandler);\n\t}\n\n\t/**\n\t * Generate and send a help message\n\t * @param {Message} message The message to respond to\n\t * @returns {Promise} The sent message\n\t */\n\tgetHelp(message) {\n\t\tconst help = Object.values(this.bot.commandPlugins).map(plugin => plugin.help).filter(help => help);\n\t\tswitch (this.help.style) {\n\t\t\tcase 'basic':\n\t\t\t\treturn message.channel.createMessage(\n\t\t\t\t\t`${this.help.title ? `**${this.help.title}**\\n` : ''}${this.help.before ? this.help.before + '\\n' : ''}\\n${\n\t\t\t\t\t\thelp.filter(h => h).map(h => `__${h[0]}__: ${h[2].join(', ')}`).join('\\n')\n\t\t\t\t\t}${this.help.after ? '\\n\\n' + this.help.after : ''}`\n\t\t\t\t).catch(error => this.bot.logger.error('Error sending help message:', error));\n\t\t\tcase 'embed':\n\t\t\t\treturn message.channel.createMessage({ embed: {\n\t\t\t\t\ttitle: this.help.title || this.bot.user.username + ' Command List',\n\t\t\t\t\tdescription: this.help.before || null,\n\t\t\t\t\tfields: help.filter(h => h).map(h => h[2].map((cmd, i) => {\n\t\t\t\t\t\treturn { name: cmd, value: h[3][i] || '\\u200B', inline: true };\n\t\t\t\t\t})).reduce((a, b) => a.concat(b)),\n\t\t\t\t\tfooter: this.help.after ? { text: this.help.after } : null\n\t\t\t\t} }).catch(error => this.bot.logger.error('Error sending help message:', error));\n\t\t\tdefault: // style: extended\n\t\t\t\treturn message.channel.createMessage(\n\t\t\t\t\t`${this.help.title ? `**${this.help.title}**\\n` : ''}${this.help.before ? this.help.before + '\\n' : ''}\\n${help.filter(h => h).map(h => {\n\t\t\t\t\t\treturn `**${h[0]}**: ${h[1]}\\n\\t${h[2].map((cmd, i) => cmd + ': ' + h[3][i]).join('\\n\\t')}`\n\t\t\t\t\t}).join('\\n\\n')}${this.help.after ? '\\n\\n' + this.help.after : ''}`\n\t\t\t\t).catch(error => this.bot.logger.error('Error sending help message:', error));\n\t\t}\n\t}\n\n\t/**\n\t * Add an await, which will trigger under certain conditions\n\t * @param {Function} trigger A function that takes a Message and returns a Boolean\n\t * @param {Function} action A function to be executed when `trigger` returns true\n\t * @param {Number} [timeout] Delete the await after this many milliseconds\n\t * @returns {Number} The unique id of the await\n\t */\n\tawaitMessage(trigger, action, timeout) {\n\t\tif (typeof trigger !== 'function' || typeof action !== 'function')\n\t\t\treturn new Error('Trigger and action must be functions');\n\n\t\tlet id = this._nextAwaitId++;\n\t\tthis.awaits[id] = { trigger, action };\n\n\t\tif (timeout)\n\t\t\tsetTimeout(() => { delete this.awaits[id]; }, timeout);\n\n\t\treturn id;\n\t}\n}\n\nmodule.exports = ChatHandler;\n" }, { "path": "lib/Logger.js", "content": "const chalk = new (require('chalk')).constructor({enabled: true});\n\n/**\n * Displays text to the console. Also supports sentry\n * @prop {RavenClient} raven The Raven client used for sentry, if enabled.\n */\nclass Logger {\n\t/**\n\t * Creates a new Logger\n\t * @param {Object} [options] The configuration for the logger\n\t * @param {Boolean} [options.timestamps=false] Add a timestamp to each message logged\n\t * @param {Object} [options.levels] An object deciding what log levels should display\n\t * @param {Boolean} [options.levels.log=true] Show `log()`\n\t * @param {Boolean} [options.levels.info=true] Show `info()`\n\t * @param {Boolean} [options.levels.debug=false] Show `debug()`\n\t * @param {Boolean} [options.levels.warning=true] Show `warn()`\n\t * @param {Boolean} [options.levels.error=true] Show `error()`\n\t * @param {Object} [options.raven] Raven options. If falsy, raven will not be required.\n\t * @param {String} options.raven.url Your project's sentry.io url\n\t * @param {Object} [options.raven.config] A custom raven config. For more info check {@link https://docs.sentry.io/clients/node/config/|their docs}\n\t * @param {Boolean} [options.raven.info=false] Send `info()` messages to sentry\n\t * @param {Boolean} [options.raven.debug=false] Send `debug()` messages to sentry\n\t * @param {Boolean} [options.raven.warning=false] Send `warn()` messages to sentry. If an {@link Error} is passed in the arguments, that will be sent alone.\n\t * @param {Boolean} [options.raven.error=true] Send `error()` errors to sentry. If an {@link Error} is passed in the arguments, that will be sent alone.\n\t */\n\tconstructor(options = { }) {\n\t\tthis.timestamps = !!options.timestamps;\n\t\tthis.levels = {\n\t\t\t'log': options.levels && options.levels.log !== undefined ? options.levels.log : true,\n\t\t\t'info': options.levels && options.levels.info !== undefined ? options.levels.info : true,\n\t\t\t'debug': options.levels && options.levels.debug !== undefined ? options.levels.debug : false,\n\t\t\t'warning': options.levels && options.levels.warning !== undefined ? options.levels.warning : true,\n\t\t\t'error': options.levels && options.levels.error !== undefined ? options.levels.error : true\n\t\t};\n\n\t\tif (options.raven) {\n\t\t\tthis.raven = require('raven');\n\t\t\tthis.raven.disableConsoleAlerts();\n\t\t\tthis.raven.config(options.raven.url, options.raven.config || {\n\t\t\t\trelease: (require('./package.json')).version,\n\t\t\t\tautoBreadcrumbs: { 'http': true },\n\t\t\t\tcaptureUnhandledRejections: true\n\t\t\t}).install();\n\n\t\t\tthis.ravenLevels = {\n\t\t\t\t'info': options.raven.info !== undefined ? options.raven.info : false,\n\t\t\t\t'debug': options.raven.debug !== undefined ? options.raven.debug : false,\n\t\t\t\t'warning': options.raven.warning !== undefined ? options.raven.warning : false,\n\t\t\t\t'error': options.raven.error !== undefined ? options.raven.error : true\n\t\t\t};\n\t\t}\n\t}\n\n\t/**\n\t * A formatted timestamp\n\t * @type {String}\n\t */\n\tget timestamp() {\n\t\treturn this.timestamps ? `[${new Date().toLocaleString()}] ` : '';\n\t}\n\n\t/** Log generic text */\n\tlog() {\n\t\tif (this.levels.log)\n\t\t\tconsole.log(this.timestamp + Array.prototype.join.call(arguments, ' '));\n\t}\n\n\t/** Log informal text */\n\tinfo() {\n\t\tif (this.levels.info)\n\t\t\tconsole.info(this.timestamp + chalk.cyan(...arguments));\n\n\t\tif (this.ravenLevels && this.ravenLevels.info)\n\t\t\tthis.raven.captureMessage(Array.prototype.join.call(arguments, ' '), { level: 'info' });\n\t}\n\n\t/** Log debugging information */\n\tdebug() {\n\t\tif (this.levels.debug)\n\t\t\tconsole.log(this.timestamp + chalk.gray(...arguments));\n\n\t\tif (this.ravenLevels && this.ravenLevels.debug)\n\t\t\tthis.raven.captureMessage(Array.prototype.join.call(arguments, ' '), { level: 'debug' });\n\t}\n\n\t/** Log a warning */\n\twarn() {\n\t\tif (this.levels.warning)\n\t\t\tconsole.warn(this.timestamp + chalk.yellow(...arguments));\n\n\t\tif (this.ravenLevels && this.ravenLevels.warning)\n\t\t\tthis.raven.captureMessage(Array.prototype.find.call(arguments, a => a instanceof Error) || Array.prototype.join.call(arguments, ' '),\n\t\t\t\t{ level: 'warning' });\n\t}\n\n\t/** Log an error */\n\terror() {\n\t\tif (this.levels.error)\n\t\t\tconsole.error(this.timestamp + chalk.red([...arguments].map(e => e instanceof Error ? e.stack : e).join(' ')));\n\n\t\tif (this.ravenLevels && this.ravenLevels.error)\n\t\t\tthis.raven.captureException(Array.prototype.find.call(arguments, a => a instanceof Error) || Array.prototype.join.call(arguments, ' '));\n\t}\n}\n\nmodule.exports = Logger;\n" }, { "path": "package.json", "content": "{\n\t\"name\": \"mirai-bot-core\",\n\t\"version\": \"4.4.4\",\n\t\"description\": \"A Discord bot core allowing easy plugging in of modules\",\n\t\"author\": \"brussell98\",\n\t\"main\": \"index.js\",\n\t\"keywords\": [\n\t\t\"discord\",\n\t\t\"bot\",\n\t\t\"core\",\n\t\t\"framework\",\n\t\t\"eris\",\n\t\t\"es6\",\n\t\t\"plugins\",\n\t\t\"middleware\",\n\t\t\"modules\",\n\t\t\"mirai\"\n\t],\n\t\"homepage\": \"https://github.com/brussell98/Mirai#readme\",\n\t\"repository\": {\n\t\t\"type\": \"git\",\n\t\t\"url\": \"git+https://github.com/brussell98/Mirai.git\"\n\t},\n\t\"bugs\": {\n\t\t\"url\": \"https://github.com/brussell98/Mirai/issues\"\n\t},\n\t\"engines\": {\n\t\t\"node\": \">=8.0.0\"\n\t},\n\t\"scripts\": {\n\t\t\"start\": \"node index.js\",\n\t\t\"docs\": \"node_modules/.bin/jsdoc README.md --configure .jsdoc.json --verbose && node docBeautify.js\"\n\t},\n\t\"license\": \"MIT\",\n\t\"dependencies\": {\n\t\t\"axios\": \"^0.19.0\",\n\t\t\"chalk\": \"^2.4.2\",\n\t\t\"eris\": \"^0.13.3\"\n\t},\n\t\"optionalDependencies\": {\n\t\t\"bluebird\": \"^3.5.5\",\n\t\t\"bufferutil\": \"^4.0.1\",\n\t\t\"eventemitter3\": \"^3.1.2\",\n\t\t\"raven\": \"^2.6.4\",\n\t\t\"utf-8-validate\": \"^5.0.2\"\n\t},\n\t\"devDependencies\": {\n\t\t\"docdash\": \"https://github.com/brussell98/docdash.git\",\n\t\t\"eslint\": \"*\",\n\t\t\"js-beautify\": \"^1.10.0\",\n\t\t\"jsdoc\": \"^3.6.2\"\n\t}\n}\n" } ]