remove jsdoc

Hypixel-API-Reborn · Aug 22, 2024 · c3fac33 · c3fac33
1 parent 39eccc1
commit c3fac33
Show file tree

Hide file tree

Showing 65 changed files with 17 additions and 468 deletions.
diff --git a/src/structures/APIIncident.ts b/src/structures/APIIncident.ts
@@ -1,7 +1,5 @@
 const regex = /https:\/\/status.hypixel.net\/incidents\/([a-z0-9]+)/;
-/**
- * API incident class
- */
+
 class APIIncident {
  link: string | null;
  start: Date | null;

diff --git a/src/structures/APIStatus.ts b/src/structures/APIStatus.ts
@@ -1,7 +1,5 @@
 import APIIncident from './APIIncident';
-/**
- * API status class
- */
+
 class APIStatus {
  sourceUrl: string | null;
  title: string | null;

diff --git a/src/structures/Boosters/Booster.ts b/src/structures/Boosters/Booster.ts
@@ -6,9 +6,6 @@ function parseType(data: Record<string, any>): 'STACKED' | 'QUEUED' | 'ACTIVE' {
  return 'ACTIVE';
 }
 
-/**
- * Booster class
- */
 class Booster {
  purchaser: string;
  amount: number;

diff --git a/src/structures/Game.ts b/src/structures/Game.ts
@@ -111,9 +111,6 @@ export type GameID =
  | -5
  | -6;
 
-/**
- * Game class
- */
 class Game {
  game: GameID | GameCode;
  id: GameID | null;

diff --git a/src/structures/GameCounts.ts b/src/structures/GameCounts.ts
@@ -1,9 +1,6 @@
 import { recursive, removeSnakeCaseString } from '../utils/removeSnakeCase';
 import Constants from '../utils/Constants';
 
-/**
- * GameCounts class
- */
 class GameCounts {
  [x: string]: object | number;
  constructor(data: Record<string, any>) {

diff --git a/src/structures/Guild/GuildMember.ts b/src/structures/Guild/GuildMember.ts
@@ -23,11 +23,7 @@ class GuildMember {
  this.expHistory = parseHistory(data.expHistory);
  this.weeklyExperience = xpCheck ? Object.values(data.expHistory).reduce((pV: any, cV: any) => pV + cV, 0) : null;
  }
- /**
- * UUID
- * @return {string}
- */
- toString() {
+ toString(): string {
  return this.uuid;
  }
 }

diff --git a/src/structures/House.ts b/src/structures/House.ts
@@ -1,6 +1,3 @@
-/**
- * House class
- */
 class House {
  name: string;
  uuid: string;

diff --git a/src/structures/ItemBytes.ts b/src/structures/ItemBytes.ts
@@ -1,8 +1,5 @@
 import { decode } from '../utils/SkyblockUtils';
 
-/**
- * Item Bytes class
- */
 class ItemBytes {
  bytesBuffer: Buffer;
  constructor(data: Record<string, any>) {

diff --git a/src/structures/Leaderboard.ts b/src/structures/Leaderboard.ts
@@ -1,6 +1,3 @@
-/**
- * Leaderboard class
- */
 class Leaderboard {
  name: string | null;
  title: string;

diff --git a/src/structures/MiniGames/Arcade.ts b/src/structures/MiniGames/Arcade.ts
@@ -11,9 +11,6 @@ function parseZombiesKills(data: Record<string, any>): Record<string, number> {
  // From entries might be broken
  return Object.fromEntries(matches.map((x: any) => [removeSnakeCaseString(x[1]), data[x[0]] || 0]));
 }
-/**
- * Zombies - Stats by Map + Difficulty
- */
 class ZombiesStats {
  bestRound: number;
  deaths: number;
@@ -44,9 +41,6 @@ class ZombiesStats {
  }
 }
 
-/**
- * Zombies - Overall stats
- */
 class Zombies {
  overall: ZombiesStats;
  deadEnd: ZombiesStats;
@@ -74,9 +68,6 @@ class Zombies {
  }
 }
 
-/**
- * Dropper stats by map
- */
 class DropperMap {
  bestTime: number;
  completions: number;
@@ -86,9 +77,6 @@ class DropperMap {
  }
 }
 
-/**
- * Blocking Dead class
- */
 class BlockingDead {
  wins: number;
  kills: number;
@@ -99,9 +87,6 @@ class BlockingDead {
  this.headshots = data.headshots_dayone || 0;
  }
 }
-/**
- * Bounty Hunters class
- */
 class BountyHunters {
  wins: number;
  kills: number;
@@ -120,9 +105,6 @@ class BountyHunters {
  this.swordKills = data.sword_kills_oneinthequiver || 0;
  }
 }
-/**
- * Capture The Wool class
- */
 class CaptureTheWool {
  wins: number;
  losses: number;
@@ -151,9 +133,6 @@ class CaptureTheWool {
  this.longestGame = data.woolhunt_longest_game || 0;
  }
 }
-/**
- * Dragon Wars class
- */
 class DragonWars {
  wins: number;
  kills: number;
@@ -162,9 +141,6 @@ class DragonWars {
  this.kills = data.kills_dragonwars2 || 0;
  }
 }
-/**
- * Dropper class
- */
 class Dropper {
  wins: number;
  fails: number;
@@ -188,9 +164,6 @@ class Dropper {
  });
  }
 }
-/**
- * Ender Spleef class
- */
 class EnderSpleef {
  wins: number;
  kills: number;
@@ -209,9 +182,6 @@ class EnderSpleef {
  this.totalPowerUpActivations = this.bigShotActivations + this.tripleShotActivations;
  }
 }
-/**
- * Farm Hunt class
- */
 class FarmHunt {
  wins: number;
  winsAsAnimal: number;
@@ -240,9 +210,6 @@ class FarmHunt {
  this.poop = (data.poop_collected_farm_hunt || 0) + (data.poop_collected || 0);
  }
 }
-/**
- * Football class
- */
 class Football {
  wins: number;
  goals: number;
@@ -255,9 +222,6 @@ class Football {
  this.powerKicks = data.powerkicks_soccer || 0;
  }
 }
-/**
- * Galxy Wars
- */
 class GalaxyWars {
  wins: number;
  kills: number;
@@ -278,9 +242,6 @@ class GalaxyWars {
  this.defenderKills = data.sw_empire_kills || 0;
  }
 }
-/**
- * Party Popper Stats (Sub gamemode of Hide and Seek)
- */
 class PartyPopper {
  winsAsSeeker: number;
  winsAsHider: number;
@@ -291,9 +252,6 @@ class PartyPopper {
  this.wins = this.winsAsSeeker + this.winsAsHider;
  }
 }
-/**
- * Prop Hunt Stats (Sub gamemode of Hide and Seek)
- */
 class PropHunt {
  winsAsSeeker: number;
  winsAsHider: number;
@@ -304,9 +262,6 @@ class PropHunt {
  this.wins = this.winsAsSeeker + this.winsAsHider;
  }
 }
-/**
- * Hide And Seek Stats
- */
 class HideAndSeek {
  partyPopper: PartyPopper;
  propHunt: PropHunt;
@@ -319,9 +274,6 @@ class HideAndSeek {
  this.winsAsHider = data.hider_wins_hide_and_seek || 0;
  }
 }
-/**
- * Hide And Seek Stats
- */
 class HoleInTheWall {
  wins: number;
  rounds: number;
@@ -336,9 +288,6 @@ class HoleInTheWall {
  this.scoreRecordOverall = this.scoreRecordFinals + this.scoreRecordNormal;
  }
 }
-/**
- * Hypixel Says Stats
- */
 class HypixelSays {
  wins: number;
  rounds: number;
@@ -351,9 +300,6 @@ class HypixelSays {
  this.topScore = data.top_score_simon_says || 0;
  }
 }
-/**
- * Mini Walls class
- */
 class MiniWalls {
  kit: string;
  wins: number;
@@ -380,9 +326,6 @@ class MiniWalls {
  this.bowAccuracy = divide(this.arrowsHit, this.arrowsShot);
  }
 }
-/**
- * Party Games class
- */
 class PartyGames {
  wins: number;
  roundWins: number;
@@ -393,9 +336,6 @@ class PartyGames {
  this.stars = data.total_stars_party || 0;
  }
 }
-/**
- * Pixel Party Game Mode
- */
 class PixelPartyGameMode {
  wins: number;
  gamesPlayed: number;
@@ -412,9 +352,6 @@ class PixelPartyGameMode {
  this.powerUpsCollected = data?.[`power_ups_collected_${modeName}`] || 0;
  }
 }
-/**
- * Party Games class
- */
 class PixelParty {
  wins: number;
  gamesPlayed: number;
@@ -441,9 +378,6 @@ class PixelParty {
  this.colorBlind = data.pixelparty || {};
  }
 }
-/**
- * Throw Out class
- */
 class ThrowOut {
  wins: number;
  kills: number;
@@ -456,9 +390,6 @@ class ThrowOut {
  this.KDRatio = divide(this.kills, this.deaths);
  }
 }
-/**
- * Arcade class
- */
 class Arcade {
  coins: number;
  weeklyCoins: number;

diff --git a/src/structures/MiniGames/ArenaBrawl.ts b/src/structures/MiniGames/ArenaBrawl.ts
@@ -25,9 +25,6 @@ class ArenaBrawlMode {
  }
 }
 
-/**
- * ArenaBrawl class
- */
 class ArenaBrawl {
  coins: number;
  coinsSpent: number;
@@ -39,50 +36,14 @@ class ArenaBrawl {
  '2v2': ArenaBrawlMode;
  '4v4': ArenaBrawlMode;
  constructor(data: Record<string, any>) {
- /**
- * Coins
- * @type {number}
- */
  this.coins = data.coins || 0;
- /**
- * Coins Spent
- * @type {number}
- */
  this.coinsSpent = data.coins_spent || 0;
- /**
- * Wins
- * @type {number}
- */
  this.wins = data.wins || 0;
- /**
- * Keys
- * @type {number}
- */
  this.keys = data.keys || 0;
- /**
- * Chests
- * @type {number}
- */
  this.chests = data.magical_chest || 0;
- /**
- * Rune
- * @type {string}
- */
  this.rune = data.active_rune || '';
- /**
- * ArenaBrawl mode stats
- * @type {ArenaBrawlMode}
- */
  this['1v1'] = new ArenaBrawlMode(data, '1v1');
- /**
- * ArenaBrawl mode stats
- * @type {ArenaBrawlMode}
- */
  this['2v2'] = new ArenaBrawlMode(data, '2v2');
- /**
- * ArenaBrawl mode stats
- * @type {ArenaBrawlMode}
- */
  this['4v4'] = new ArenaBrawlMode(data, '4v4');
  }
 }

diff --git a/src/structures/MiniGames/BedWars.ts b/src/structures/MiniGames/BedWars.ts
@@ -374,9 +374,7 @@ function generateStatsForPractice(data: Record<string, any>): BedWarsPracticeSta
  }
  };
 }
-/**
- * BedWars class
- */
+
 class BedWars {
  tokens: number;
  level: number;

diff --git a/src/structures/MiniGames/BlitzSurvivalGames.ts b/src/structures/MiniGames/BlitzSurvivalGames.ts
@@ -43,9 +43,6 @@ class BlitzSGKit {
  }
 }
 
-/**
- * Blitz SG class
- */
 class BlitzSurvivalGames {
  coins: number;
  kills: number;