removed jsdoc that docgen cannot recognize

Author: StavZ

src/API/getServerInfo.js

@@ -35,12 +35,7 @@ module.exports = async function (repeats) {
     });
   });
 };
-/**
- * Gets hypixel's ping
- * @param {number} amount Amount of times to ping
- * @param {net.Socket} cli Socket connected to hypixel
- * @returns {number}
- */
+// eslint-disable-next-line require-jsdoc
 async function getPing(amount, cli) {
   let pingSum = 0;
   for (let i = 0; i < amount; i++) {
@@ -49,11 +44,8 @@ async function getPing(amount, cli) {
   cli.destroy();
   return Math.round(pingSum / amount);
 }
-/**
- * Pings hypixel
- * @param {net.Socket} cli Client socket, connected to hypixel.
- * @returns {number} Ping
- */
+
+// eslint-disable-next-line require-jsdoc
 async function ping(cli) {
   await cli.write(packetsToSend[2]);
   const time = Date.now();
@@ -63,12 +55,8 @@ async function ping(cli) {
     });
   });
 }
-/**
- * Parses the MOTD & Server status
- * @param {string} stringJson Parseable JSON string
- * @param {number} ping Ping of the server
- * @returns {Object} Object
- */
+
+// eslint-disable-next-line require-jsdoc
 function parseData(stringJson, ping) {
   try {
     return new ServerInfo(JSON.parse(stringJson), ping);

src/Private/rateLimit.js

@@ -3,7 +3,7 @@
 const Errors = require('../Errors');
 
 /* eslint-disable require-jsdoc */
-module.exports = class RateLimit {
+class RateLimit {
   constructor() {
     this.initialized = 0;
   }
@@ -48,30 +48,10 @@ module.exports = class RateLimit {
   }
 
   init(keyInfo, options, client) {
-    /**
-     * Rate limit Options
-     * @type {RLOptions}
-     */
     this.options = options;
-    /**
-     * Requests in past min
-     * @type {number}
-     */
     this.requests = 0;
-    /**
-     * Cooldown
-     * @type {number}
-     */
     this.cooldownTime = 300000 / this.options.keyLimit; // Initial value
-    /**
-     * Request Queue ( Array of timestamps )
-     * @type {number[]}
-     */
     this.requestQueue = [];
-    /**
-     * Client
-     * @type {Client}
-     */
     this.client = client;
     return keyInfo
       .then((info) => {
@@ -89,7 +69,8 @@ module.exports = class RateLimit {
       });
     // Still make the requests per min possible
   }
-};
+}
+module.exports = RateLimit;
 /**
  * @typedef {Object} RLOptions
  * @property {number} keyLimit Max request of key per min

src/Private/requests.js

@@ -4,13 +4,11 @@ const externalFetch = require('node-fetch');
 const BASE_URL = 'https://api.hypixel.net';
 const Errors = require('../Errors');
 const Cache = require('./defaultCache');
+const Client = require('../Client.js');
 
-module.exports = class Requests {
+class Requests {
   constructor(client, cache) {
     if (cache && !this.validateCustomCache()) throw new Error(Errors.INVALID_CACHE_HANDLER);
-    /**
-     * @type {Cache}
-     */
     this.cached = cache || new Cache();
     this.client = client;
   }
@@ -62,4 +60,6 @@ module.exports = class Requests {
   validateCustomCache(cache) {
     return !!(cache.set && cache.get && cache.delete && cache.keys);
   }
-};
+}
+
+module.exports = Requests;

src/index.js

@@ -39,7 +39,7 @@ module.exports = {
   Product: require('./structures/SkyBlock/Bazzar/Product.js'),
   Order: require('./structures/SkyBlock/Bazzar/Order.js'),
 
-  /** Skyblock News */
+  /* Skyblock News */
   SkyblockNews: require('./structures/SkyBlock/News/SkyblockNews'),
 
   /* Booster */
@@ -71,8 +71,8 @@ module.exports = {
   /* Leaderboards */
   Leaderboard: require('./structures/Leaderboard.js'),
 
-  /** Server Info */
-  ServerInfo: require('./structures/ServerInfo'),
+  /* Server Info */
+  ServerInfo: require('./structures/ServerInfo.js'),
 
   /* Errors */
   Errors: require('./Errors.js'),

src/structures/Boosters/Booster.js

@@ -74,11 +74,7 @@ class Booster {
   }
 }
 
-/**
- * Parses the type of the booster
- * @param {Object} data Data
- * @returns {string} Type of booster
- */
+// eslint-disable-next-line require-jsdoc
 function parseType(data) {
   if (data.stacked === true) return 'STACKED';
   if (!data.stacked) return 'QUEUED';

src/structures/Guild/Guild.js

@@ -170,33 +170,21 @@ class Guild {
     return this.members.find((member) => member.rank === 'Guild Master' || member.rank === 'GUILDMASTER');
   }
 }
-/**
- * @param {object} data
- * @return {GuildMember[]}
- */
+// eslint-disable-next-line require-jsdoc
 function members(data) {
   return data.members.length ? data.members.map((m) => new GuildMember(m)) : [];
 }
-/**
- * @param {object} data
- * @return {GuildRank[]}
- */
+// eslint-disable-next-line require-jsdoc
 function ranks(data) {
   return data.ranks && data.ranks.length ? data.ranks.map((r) => new GuildRank(r)).sort((a, b) => a.priority - b.priority) : [];
 }
-/**
- * @param {object} data
- * @return {number}
- */
+// eslint-disable-next-line require-jsdoc
 function totalWeeklyGexp(data) {
   return members(data)
     .map((m) => m.weeklyExperience)
     .reduce((acc, cur) => acc + cur);
 }
-/**
- * @param {Object} data
- * @return {Array}
- */
+// eslint-disable-next-line require-jsdoc
 function calculateExpHistory(data) {
   const finalObj = {};
   for (const day of Object.keys(data.members[0].expHistory)) {
@@ -208,11 +196,7 @@ function calculateExpHistory(data) {
   }
   return parseHistory(finalObj);
 }
-/**
- * Calculates and returns the exp after daily limit
- * @param {number} exp Experience
- * @return {number}
- */
+// eslint-disable-next-line require-jsdoc
 function expLimit(exp) {
   return exp > 2e5 ? (exp > 7e5 ? 2.5e5 + Math.round(exp * 0.03) : 2e5 + Math.round((exp - 2e5) / 10)) : exp;
 }

src/structures/MiniGames/Arcade.js

@@ -526,11 +526,7 @@ class ZombiesStats {
     this.zombieKills = data[`zombie_kills_zombies${type}`] || 0;
   }
 }
-/**
- * Parses Kills in Zombie and return it as an object
- * @param {Object} data data from API
- * @returns {Object}
- */
+// eslint-disable-next-line require-jsdoc
 function parseZombiesKills(data) {
   const matches = Array.from(Object.keys(data))
     .map((x) => x.match(/^([A-z]+)_zombie_kills_zombies$/))

src/structures/MiniGames/ArenaBrawl.js

@@ -23,11 +23,7 @@ class ArenaBrawl {
     };
   }
 }
-/**
- * @param {object} data
- * @param {string} mode
- * @return {{kills:number,deaths:number,KDRatio:number,wins:number,losses:number,WLRatio:number}}
- */
+// eslint-disable-next-line require-jsdoc
 function generateModeStats(data, mode) {
   return {
     kills: data[`kills_${mode}`] || 0,

src/structures/MiniGames/BedWars.js

@@ -202,10 +202,7 @@ class BedWars {
     this.castle = generateStatsForMode(data, 'castle');
   }
 }
-/**
- * @param {number} level
- * @return {string}
- */
+// eslint-disable-next-line require-jsdoc
 function getBedWarsPrestige(level) {
   // eslint-disable-next-line max-len
   if (level >= 5000) return 'Eternal';
@@ -271,10 +268,7 @@ const XP_PER_PRESTIGE = 96 * 5000 + EASY_LEVELS_XP;
 const LEVELS_PER_PRESTIGE = 100;
 const HIGHEST_PRESTIGE = 10;
 
-/**
- * @param {number} level
- * @return {number}
- */
+// eslint-disable-next-line require-jsdoc
 function getExpForLevel(level) {
   if (level === 0) return 0;
   const respectedLevel = getLevelRespectingPrestige(level);
@@ -291,21 +285,15 @@ function getExpForLevel(level) {
   }
   return 5000;
 }
-/**
- * @param {number} level
- * @return {number}
- */
+// eslint-disable-next-line require-jsdoc
 function getLevelRespectingPrestige(level) {
   if (level > HIGHEST_PRESTIGE * LEVELS_PER_PRESTIGE) {
     return level - HIGHEST_PRESTIGE * LEVELS_PER_PRESTIGE;
   } else {
     return level % LEVELS_PER_PRESTIGE;
   }
 }
-/**
- * @param {number} exp
- * @return {number}
- */
+// eslint-disable-next-line require-jsdoc
 function getLevelForExp(exp) {
   const prestiges = Math.floor(exp / XP_PER_PRESTIGE);
   let level = prestiges * LEVELS_PER_PRESTIGE;

src/structures/MiniGames/BlitzSurvivalGames.js

@@ -87,10 +87,7 @@ class BlitzSurvivalGames {
     this.kitStats = generateKitStats(data);
   }
 }
-/**
- * @param {object} data
- * @return {object}
- */
+// eslint-disable-next-line require-jsdoc
 function generateKitStats(data) {
   const stats = [];
   for (let i = 0; i < kits.length; i++) {