From 950f448543213d54f7f4ac22e381cb1493fcc281 Mon Sep 17 00:00:00 2001 From: Isaac Date: Mon, 17 May 2021 18:13:55 +0100 Subject: [PATCH] Improve JSDoc types --- src/banner.js | 3 +-- src/index.js | 3 ++- src/modules/commands/command.js | 2 +- src/modules/commands/manager.js | 2 +- src/modules/listeners/listener.js | 5 +++++ src/modules/listeners/loader.js | 2 +- src/modules/plugins/manager.js | 2 +- src/modules/plugins/plugin.js | 2 +- src/modules/tickets/archives.js | 2 +- src/modules/tickets/manager.js | 2 +- 10 files changed, 15 insertions(+), 10 deletions(-) diff --git a/src/banner.js b/src/banner.js index f9a948b..37c3dff 100644 --- a/src/banner.js +++ b/src/banner.js @@ -23,6 +23,5 @@ module.exports = () => { `)); console.log(leeks.colours.cyanBright(`Discord Tickets bot v${version} by eartharoid`)); console.log(leeks.colours.cyanBright(homepage + '\n')); - console.log(leeks.colours.cyanBright(link('Sponsor this project', 'https://go.eartharoid.me/sponsor-dsctickets'))); - console.log('\n\n'); + console.log(leeks.colours.cyanBright(link('Sponsor this project', 'https://go.eartharoid.me/sponsor-dsctickets') + '\n')); }; \ No newline at end of file diff --git a/src/index.js b/src/index.js index 2486a5c..4528317 100644 --- a/src/index.js +++ b/src/index.js @@ -104,7 +104,8 @@ const { } = require('discord.js'); /** - * The bot client + * The Discord client + * @typedef {Bot} Bot * @extends {Client} */ class Bot extends Client { diff --git a/src/modules/commands/command.js b/src/modules/commands/command.js index 764a36f..c106498 100644 --- a/src/modules/commands/command.js +++ b/src/modules/commands/command.js @@ -14,7 +14,7 @@ module.exports = class Command { */ /** * Create a new Command - * @param {Client} client - The Discord Client + * @param {import('../../').Bot} client - The Discord Client * @param {Object} data - Command data * @param {string} data.name - The name of the command (3-32) * @param {string} data.description - The description of the command (1-100) diff --git a/src/modules/commands/manager.js b/src/modules/commands/manager.js index 1f86739..4583899 100644 --- a/src/modules/commands/manager.js +++ b/src/modules/commands/manager.js @@ -13,7 +13,7 @@ const parseArgs = require('command-line-args'); module.exports = class CommandManager { /** * Create a CommandManager instance - * @param {Client} client + * @param {import('../..').Bot} client */ constructor(client) { /** The Discord Client */ diff --git a/src/modules/listeners/listener.js b/src/modules/listeners/listener.js index 54836de..a596099 100644 --- a/src/modules/listeners/listener.js +++ b/src/modules/listeners/listener.js @@ -1,5 +1,10 @@ module.exports = class EventListener { + /** + * + * @param {import("../..").Bot} client + * @param {*} data + */ constructor(client, data) { this.client = client; this.event = data.event; diff --git a/src/modules/listeners/loader.js b/src/modules/listeners/loader.js index 4aecca9..a6e61f3 100644 --- a/src/modules/listeners/loader.js +++ b/src/modules/listeners/loader.js @@ -7,7 +7,7 @@ const { path } = require('../../utils/fs'); module.exports = class ListenerLoader { /** * Create a ListenerLoader instance - * @param {Client} client + * @param {import('../..').Bot} client */ constructor(client) { /** The Discord Client */ diff --git a/src/modules/plugins/manager.js b/src/modules/plugins/manager.js index b9fcef3..d53a433 100644 --- a/src/modules/plugins/manager.js +++ b/src/modules/plugins/manager.js @@ -9,7 +9,7 @@ const Plugin = require('./plugin'); module.exports = class PluginManager { /** * Create a PluginManager instance - * @param {Client} client + * @param {import('../..').Bot} client */ constructor(client) { /** The Discord Client */ diff --git a/src/modules/plugins/plugin.js b/src/modules/plugins/plugin.js index 4b077fd..e251dc4 100644 --- a/src/modules/plugins/plugin.js +++ b/src/modules/plugins/plugin.js @@ -11,7 +11,7 @@ const { path } = require('../../utils/fs'); module.exports = class Plugin { /** * Create a new Plugin - * @param {Client} client The Discord Client + * @param {import('../..').Bot} client The Discord Client * @param {String} id The plugin ID * @param {Object} options Plugin options * @param {String} options.name A human-friendly name (can be different to the name in package.json) diff --git a/src/modules/tickets/archives.js b/src/modules/tickets/archives.js index 24ec65e..5594f6a 100644 --- a/src/modules/tickets/archives.js +++ b/src/modules/tickets/archives.js @@ -4,7 +4,7 @@ const { int2hex } = require('../../utils'); module.exports = class TicketArchives { /** * Create a TicketArchives instance - * @param {Client} client + * @param {import('../..').Bot} client */ constructor(client) { diff --git a/src/modules/tickets/manager.js b/src/modules/tickets/manager.js index b7982b7..2fe7d4d 100644 --- a/src/modules/tickets/manager.js +++ b/src/modules/tickets/manager.js @@ -7,7 +7,7 @@ const { footer } = require('../../utils/discord'); module.exports = class TicketManager extends EventEmitter { /** * Create a TicketManager instance - * @param {Client} client + * @param {import('../..').Bot} client */ constructor(client) { super();