Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Desvelao committed Nov 16, 2024
1 parent 4076df2 commit 8413628
Show file tree
Hide file tree
Showing 33 changed files with 4,646 additions and 5,484 deletions.
65 changes: 33 additions & 32 deletions Aghanim.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,36 +26,37 @@ <h1 class="page-title">Source: Aghanim.js</h1>

<section>
<article>
<pre class="prettyprint source linenums"><code>const Eris = require('eris') /* eslint import/no-cycle : "off" */
const Client = require('./Client');
const Command = require('./Command');
const Category = require('./Category');
const Component = require('./Component');
const Logger = require('./Logger')
const CommandRequirementsCreators = require('./requirements')

/**
* Aghanim module to create a Command Client for {@link https://abal.moe/Eris/docs/getting-started Eris} using nodejs!
* @module aghanim
* @returns {Client} Command client class
*/

module.exports = Client;
/** @prop {Client} Client - Command client class*/
module.exports.Client = Client;
/** @prop {Command} Command - Command class*/
module.exports.Command = Command;
/** @prop {Category} Category - Category class*/
module.exports.Category = Category;
/** @prop {Component} Component - Component class*/
module.exports.Component = Component;
/** @prop {Eris} Component - See {@link https://abal.moe/Eris/docs/getting-started Eris} */
module.exports.Eris = Eris;
/** @prop {Logger} Component See {@link https://github.com/Geo1088/another-logger another-logger} */
module.exports.Logger = Logger;
/** @prop {CommandRequirementsCreators} CommandRequirementsCreators See {@link https://desvelao.github.com/aghanim/CommandRequirements CommandRequirements} */
module.exports.CommandRequirementsCreators = CommandRequirementsCreators;

<pre class="prettyprint source linenums"><code>const Eris = require('eris'); /* eslint import/no-cycle : "off" */
const Client = require('./Client');
const Command = require('./Command');
const Category = require('./Category');
const Component = require('./Component');
const Logger = require('./Logger');
const CommandRequirementsCreators = require('./requirements');

/**
* Aghanim module to create a Command Client for {@link https://abal.moe/Eris/docs/getting-started Eris} using NodeJS!
* @module aghanim
* @returns {Client} Command client class
*/

module.exports = Client;
/** @prop {Client} Client - Command client class*/
module.exports.Client = Client;
/** @prop {Command} Command - Command class*/
module.exports.Command = Command;
/** @prop {Category} Category - Category class*/
module.exports.Category = Category;
/** @prop {Component} Component - Component class*/
module.exports.Component = Component;
/** @prop {Eris} Component - See {@link https://abal.moe/Eris/docs/getting-started Eris} */
module.exports.Eris = Eris;
/** @prop {Logger} Component See {@link https://github.com/Geo1088/another-logger another-logger} */
module.exports.Logger = Logger;
/** @prop {CommandRequirementsCreators} CommandRequirementsCreators See {@link https://desvelao.github.com/aghanim/CommandRequirements CommandRequirements} */
module.exports.CommandRequirementsCreators = CommandRequirementsCreators;
/** @prop {constants} constants Constants */
module.exports.constants = require('./constants');
</code></pre>
</article>
</section>
Expand All @@ -66,13 +67,13 @@ <h1 class="page-title">Source: Aghanim.js</h1>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-aghanim.html">aghanim</a></li></ul><h3>Classes</h3><ul><li><a href="Category.html">Category</a></li><li><a href="Client.html">Client</a></li><li><a href="Command.html">Command</a></li><li><a href="Component.html">Component</a></li></ul><h3>Events</h3><ul><li><a href="Client.html#event:aghanim:command:error">aghanim:command:error</a></li><li><a href="Client.html#event:aghanim:command:executed">aghanim:command:executed</a></li><li><a href="Client.html#event:aghanim:command:prereq">aghanim:command:prereq</a></li><li><a href="Client.html#event:aghanim:command:prerun">aghanim:command:prerun</a></li><li><a href="Client.html#event:aghanim:component:error">aghanim:component:error</a></li><li><a href="Client.html#event:aghanim:error">aghanim:error</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-1getting-started.html">Getting Started</a></li><li><a href="tutorial-2create-bot.html">Create a bot</a></li><li><a href="tutorial-3command.html">Create Commands/Subcommands</a></li><li><a href="tutorial-4components.html">Create Components</a></li><li><a href="tutorial-5categories.html">Create a category</a></li><li><a href="tutorial-6command-requirements.html">Command requirements</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Logger">Logger</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-aghanim.html">aghanim</a></li></ul><h3>Classes</h3><ul><li><a href="Category.html">Category</a></li><li><a href="Client.html">Client</a></li><li><a href="Command.html">Command</a></li><li><a href="Component.html">Component</a></li></ul><h3>Events</h3><ul><li><a href="Client.html#event:aghanim:command-interaction:error">aghanim:command-interaction:error</a></li><li><a href="Client.html#event:aghanim:command-interaction:executed">aghanim:command-interaction:executed</a></li><li><a href="Client.html#event:aghanim:command-interaction:executing">aghanim:command-interaction:executing</a></li><li><a href="Client.html#event:aghanim:command-interaction:triggered">aghanim:command-interaction:triggered</a></li><li><a href="Client.html#event:aghanim:command-interaction:triggered-not-found">aghanim:command-interaction:triggered-not-found</a></li><li><a href="Client.html#event:aghanim:command:error">aghanim:command:error</a></li><li><a href="Client.html#event:aghanim:command:executed">aghanim:command:executed</a></li><li><a href="Client.html#event:aghanim:command:prereq">aghanim:command:prereq</a></li><li><a href="Client.html#event:aghanim:command:prerun">aghanim:command:prerun</a></li><li><a href="Client.html#event:aghanim:component:error">aghanim:component:error</a></li><li><a href="Client.html#event:aghanim:error">aghanim:error</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-1getting-started.html">Getting started</a></li><li><a href="tutorial-2create-bot.html">Create a bot</a></li><li><a href="tutorial-3command.html">Create commands</a></li><li><a href="tutorial-4components.html">Create components</a></li><li><a href="tutorial-5categories.html">Create command categories</a></li><li><a href="tutorial-6command-requirements.html">Command requirements</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Logger">Logger</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.0</a>
</footer>

<script> prettyPrint(); </script>
Expand Down
4 changes: 2 additions & 2 deletions Category.html
Original file line number Diff line number Diff line change
Expand Up @@ -367,13 +367,13 @@ <h6>Properties</h6>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-aghanim.html">aghanim</a></li></ul><h3>Classes</h3><ul><li><a href="Category.html">Category</a></li><li><a href="Client.html">Client</a></li><li><a href="Command.html">Command</a></li><li><a href="Component.html">Component</a></li></ul><h3>Events</h3><ul><li><a href="Client.html#event:aghanim:command:error">aghanim:command:error</a></li><li><a href="Client.html#event:aghanim:command:executed">aghanim:command:executed</a></li><li><a href="Client.html#event:aghanim:command:prereq">aghanim:command:prereq</a></li><li><a href="Client.html#event:aghanim:command:prerun">aghanim:command:prerun</a></li><li><a href="Client.html#event:aghanim:component:error">aghanim:component:error</a></li><li><a href="Client.html#event:aghanim:error">aghanim:error</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-1getting-started.html">Getting Started</a></li><li><a href="tutorial-2create-bot.html">Create a bot</a></li><li><a href="tutorial-3command.html">Create Commands/Subcommands</a></li><li><a href="tutorial-4components.html">Create Components</a></li><li><a href="tutorial-5categories.html">Create a category</a></li><li><a href="tutorial-6command-requirements.html">Command requirements</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Logger">Logger</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-aghanim.html">aghanim</a></li></ul><h3>Classes</h3><ul><li><a href="Category.html">Category</a></li><li><a href="Client.html">Client</a></li><li><a href="Command.html">Command</a></li><li><a href="Component.html">Component</a></li></ul><h3>Events</h3><ul><li><a href="Client.html#event:aghanim:command-interaction:error">aghanim:command-interaction:error</a></li><li><a href="Client.html#event:aghanim:command-interaction:executed">aghanim:command-interaction:executed</a></li><li><a href="Client.html#event:aghanim:command-interaction:executing">aghanim:command-interaction:executing</a></li><li><a href="Client.html#event:aghanim:command-interaction:triggered">aghanim:command-interaction:triggered</a></li><li><a href="Client.html#event:aghanim:command-interaction:triggered-not-found">aghanim:command-interaction:triggered-not-found</a></li><li><a href="Client.html#event:aghanim:command:error">aghanim:command:error</a></li><li><a href="Client.html#event:aghanim:command:executed">aghanim:command:executed</a></li><li><a href="Client.html#event:aghanim:command:prereq">aghanim:command:prereq</a></li><li><a href="Client.html#event:aghanim:command:prerun">aghanim:command:prerun</a></li><li><a href="Client.html#event:aghanim:component:error">aghanim:component:error</a></li><li><a href="Client.html#event:aghanim:error">aghanim:error</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-1getting-started.html">Getting started</a></li><li><a href="tutorial-2create-bot.html">Create a bot</a></li><li><a href="tutorial-3command.html">Create commands</a></li><li><a href="tutorial-4components.html">Create components</a></li><li><a href="tutorial-5categories.html">Create command categories</a></li><li><a href="tutorial-6command-requirements.html">Command requirements</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Logger">Logger</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.0</a>
</footer>

<script> prettyPrint(); </script>
Expand Down
54 changes: 29 additions & 25 deletions Category.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,29 +26,33 @@ <h1 class="page-title">Source: Category.js</h1>

<section>
<article>
<pre class="prettyprint source linenums"><code>/** Class representing a category of commands. */
class Category {
/**
* Create a category.
* @param {string} name - The name of category.
* @param {string} [help = `Help for ${this.name} category`] - Help description
* @param {object} options - Help description
* @param {object} [options.hide = false] - Hide when use default help command
*/
constructor(name, help, options = {}) {
if (!name) { throw new Error('Name is required') }
this.name = name
this.help = help || `Help for ${this.name} category`
this.hide = options.hide || false
for (const opt in options) { /* eslint no-restricted-syntax : "off" */
if (!this.hasOwnProperty(opt)) { /* eslint no-prototype-builtins : "off" */
this[opt] = options[opt]
}
}
}
}

module.exports = Category
<pre class="prettyprint source linenums"><code>/** Class representing a category of commands. */
class Category {
/**
* Create a category.
* @param {string} name - The name of category.
* @param {string} [help = `Help for ${this.name} category`] - Help description
* @param {object} options - Help description
* @param {object} [options.hide = false] - Hide when use default help command
*/
constructor(name, help, options = {}) {
if (!name) {
throw new Error('Name is required');
}
this.name = name;
this.help = help || `Help for ${this.name} category`;
this.hide = options.hide || false;
for (const opt in options) {
/* eslint no-restricted-syntax : "off" */
if (!this.hasOwnProperty(opt)) {
/* eslint no-prototype-builtins : "off" */
this[opt] = options[opt];
}
}
}
}

module.exports = Category;
</code></pre>
</article>
</section>
Expand All @@ -59,13 +63,13 @@ <h1 class="page-title">Source: Category.js</h1>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-aghanim.html">aghanim</a></li></ul><h3>Classes</h3><ul><li><a href="Category.html">Category</a></li><li><a href="Client.html">Client</a></li><li><a href="Command.html">Command</a></li><li><a href="Component.html">Component</a></li></ul><h3>Events</h3><ul><li><a href="Client.html#event:aghanim:command:error">aghanim:command:error</a></li><li><a href="Client.html#event:aghanim:command:executed">aghanim:command:executed</a></li><li><a href="Client.html#event:aghanim:command:prereq">aghanim:command:prereq</a></li><li><a href="Client.html#event:aghanim:command:prerun">aghanim:command:prerun</a></li><li><a href="Client.html#event:aghanim:component:error">aghanim:component:error</a></li><li><a href="Client.html#event:aghanim:error">aghanim:error</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-1getting-started.html">Getting Started</a></li><li><a href="tutorial-2create-bot.html">Create a bot</a></li><li><a href="tutorial-3command.html">Create Commands/Subcommands</a></li><li><a href="tutorial-4components.html">Create Components</a></li><li><a href="tutorial-5categories.html">Create a category</a></li><li><a href="tutorial-6command-requirements.html">Command requirements</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Logger">Logger</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-aghanim.html">aghanim</a></li></ul><h3>Classes</h3><ul><li><a href="Category.html">Category</a></li><li><a href="Client.html">Client</a></li><li><a href="Command.html">Command</a></li><li><a href="Component.html">Component</a></li></ul><h3>Events</h3><ul><li><a href="Client.html#event:aghanim:command-interaction:error">aghanim:command-interaction:error</a></li><li><a href="Client.html#event:aghanim:command-interaction:executed">aghanim:command-interaction:executed</a></li><li><a href="Client.html#event:aghanim:command-interaction:executing">aghanim:command-interaction:executing</a></li><li><a href="Client.html#event:aghanim:command-interaction:triggered">aghanim:command-interaction:triggered</a></li><li><a href="Client.html#event:aghanim:command-interaction:triggered-not-found">aghanim:command-interaction:triggered-not-found</a></li><li><a href="Client.html#event:aghanim:command:error">aghanim:command:error</a></li><li><a href="Client.html#event:aghanim:command:executed">aghanim:command:executed</a></li><li><a href="Client.html#event:aghanim:command:prereq">aghanim:command:prereq</a></li><li><a href="Client.html#event:aghanim:command:prerun">aghanim:command:prerun</a></li><li><a href="Client.html#event:aghanim:component:error">aghanim:component:error</a></li><li><a href="Client.html#event:aghanim:error">aghanim:error</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-1getting-started.html">Getting started</a></li><li><a href="tutorial-2create-bot.html">Create a bot</a></li><li><a href="tutorial-3command.html">Create commands</a></li><li><a href="tutorial-4components.html">Create components</a></li><li><a href="tutorial-5categories.html">Create command categories</a></li><li><a href="tutorial-6command-requirements.html">Command requirements</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Logger">Logger</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.0</a>
</footer>

<script> prettyPrint(); </script>
Expand Down
Loading

0 comments on commit 8413628

Please sign in to comment.