Improve JSDoc types

This commit is contained in:
Isaac 2021-05-17 18:13:55 +01:00
parent 448a1e793f
commit 950f448543
No known key found for this signature in database
GPG Key ID: F6812DBC6719B4E3
10 changed files with 15 additions and 10 deletions

View File

@ -23,6 +23,5 @@ module.exports = () => {
`)); `));
console.log(leeks.colours.cyanBright(`Discord Tickets bot v${version} by eartharoid`)); console.log(leeks.colours.cyanBright(`Discord Tickets bot v${version} by eartharoid`));
console.log(leeks.colours.cyanBright(homepage + '\n')); console.log(leeks.colours.cyanBright(homepage + '\n'));
console.log(leeks.colours.cyanBright(link('Sponsor this project', 'https://go.eartharoid.me/sponsor-dsctickets'))); console.log(leeks.colours.cyanBright(link('Sponsor this project', 'https://go.eartharoid.me/sponsor-dsctickets') + '\n'));
console.log('\n\n');
}; };

View File

@ -104,7 +104,8 @@ const {
} = require('discord.js'); } = require('discord.js');
/** /**
* The bot client * The Discord client
* @typedef {Bot} Bot
* @extends {Client} * @extends {Client}
*/ */
class Bot extends Client { class Bot extends Client {

View File

@ -14,7 +14,7 @@ module.exports = class Command {
*/ */
/** /**
* Create a new Command * Create a new Command
* @param {Client} client - The Discord Client * @param {import('../../').Bot} client - The Discord Client
* @param {Object} data - Command data * @param {Object} data - Command data
* @param {string} data.name - The name of the command (3-32) * @param {string} data.name - The name of the command (3-32)
* @param {string} data.description - The description of the command (1-100) * @param {string} data.description - The description of the command (1-100)

View File

@ -13,7 +13,7 @@ const parseArgs = require('command-line-args');
module.exports = class CommandManager { module.exports = class CommandManager {
/** /**
* Create a CommandManager instance * Create a CommandManager instance
* @param {Client} client * @param {import('../..').Bot} client
*/ */
constructor(client) { constructor(client) {
/** The Discord Client */ /** The Discord Client */

View File

@ -1,5 +1,10 @@
module.exports = class EventListener { module.exports = class EventListener {
/**
*
* @param {import("../..").Bot} client
* @param {*} data
*/
constructor(client, data) { constructor(client, data) {
this.client = client; this.client = client;
this.event = data.event; this.event = data.event;

View File

@ -7,7 +7,7 @@ const { path } = require('../../utils/fs');
module.exports = class ListenerLoader { module.exports = class ListenerLoader {
/** /**
* Create a ListenerLoader instance * Create a ListenerLoader instance
* @param {Client} client * @param {import('../..').Bot} client
*/ */
constructor(client) { constructor(client) {
/** The Discord Client */ /** The Discord Client */

View File

@ -9,7 +9,7 @@ const Plugin = require('./plugin');
module.exports = class PluginManager { module.exports = class PluginManager {
/** /**
* Create a PluginManager instance * Create a PluginManager instance
* @param {Client} client * @param {import('../..').Bot} client
*/ */
constructor(client) { constructor(client) {
/** The Discord Client */ /** The Discord Client */

View File

@ -11,7 +11,7 @@ const { path } = require('../../utils/fs');
module.exports = class Plugin { module.exports = class Plugin {
/** /**
* Create a new 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 {String} id The plugin ID
* @param {Object} options Plugin options * @param {Object} options Plugin options
* @param {String} options.name A human-friendly name (can be different to the name in package.json) * @param {String} options.name A human-friendly name (can be different to the name in package.json)

View File

@ -4,7 +4,7 @@ const { int2hex } = require('../../utils');
module.exports = class TicketArchives { module.exports = class TicketArchives {
/** /**
* Create a TicketArchives instance * Create a TicketArchives instance
* @param {Client} client * @param {import('../..').Bot} client
*/ */
constructor(client) { constructor(client) {

View File

@ -7,7 +7,7 @@ const { footer } = require('../../utils/discord');
module.exports = class TicketManager extends EventEmitter { module.exports = class TicketManager extends EventEmitter {
/** /**
* Create a TicketManager instance * Create a TicketManager instance
* @param {Client} client * @param {import('../..').Bot} client
*/ */
constructor(client) { constructor(client) {
super(); super();