hypixel-api-reborn 11.3.4 → 12.0.0-0

package/src/API/skyblock/getFireSales.js

@@ -1,7 +0,0 @@
-module.exports = async function () {
-  const FireSale = require('../../structures/SkyBlock/Static/FireSale');
-  // eslint-disable-next-line no-underscore-dangle
-  const res = await this._makeRequest('/skyblock/firesales');
-  if (res.raw) return res;
-  return res.sales.length ? res.sales.map((sale) => new FireSale(sale)) : [];
-};

package/src/API/skyblock/getGarden.js

@@ -1,11 +0,0 @@
-module.exports = async function (profileId) {
-  const SkyblockGarden = require('../../structures/SkyBlock/SkyblockGarden');
-  let res;
-  try {
-    // eslint-disable-next-line no-underscore-dangle
-    res = await this._makeRequest(`/skyblock/garden?profile=${profileId}`).catch();
-    // eslint-disable-next-line no-unused-vars, no-empty
-  } catch (e) {}
-  if (res?.raw) return res;
-  return new SkyblockGarden(res);
-};

package/src/API/skyblock/getGovernment.js

@@ -1,7 +0,0 @@
-module.exports = async function () {
-  const GovernmentData = require('../../structures/SkyBlock/Static/Government.js');
-  // eslint-disable-next-line no-underscore-dangle
-  const res = await this._makeRequest('/resources/skyblock/election');
-  if (res.raw) return res;
-  return new GovernmentData(res);
-};

package/src/API/skyblock/getMember.js

@@ -1,35 +0,0 @@
-const Errors = require('../../Errors');
-const toUuid = require('../../utils/toUuid');
-const getPlayer = require('../getPlayer');
-module.exports = async function (query, options = { fetchPlayer: false, getMuseum: false, getGarden: false }) {
-  const SkyblockMember = require('../../structures/SkyBlock/SkyblockMember');
-  const getSkyblockMuseum = require('./getMuseum');
-  const getSkyblockGarden = require('./getGarden');
-  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
-  query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
-  // eslint-disable-next-line no-underscore-dangle
-  const res = await this._makeRequest(`/skyblock/profiles?uuid=${query}`);
-  if (res.raw) return res;
-  if (!res.profiles || !res.profiles.length) throw new Error(Errors.NO_SKYBLOCK_PROFILES);
-  const player = options.fetchPlayer ? await getPlayer.call(this, query, options) : null;
-  const memberByProfileName = new Map();
-  for (const profile of res.profiles) {
-    profile.members[query].player = player;
-    memberByProfileName.set(
-      profile.cute_name,
-      new SkyblockMember({
-        uuid: query,
-        profileId: profile.profile_id,
-        profileName: profile.cute_name,
-        gameMode: profile.game_mode || null,
-        m: profile.members[query],
-        banking: profile.banking,
-        communityUpgrades: profile.community_upgrades,
-        museum: options.getMuseum ? await getSkyblockMuseum.call(this, query, profile.profile_id) : null,
-        garden: options.getGarden ? await getSkyblockGarden.call(this, profile.profile_id) : null,
-        selected: profile.selected
-      })
-    );
-  }
-  return memberByProfileName;
-};

package/src/API/skyblock/getMuseum.js

@@ -1,15 +0,0 @@
-const Errors = require('../../Errors');
-const toUuid = require('../../utils/toUuid');
-module.exports = async function (query, profileId) {
-  const SkyblockMuseum = require('../../structures/SkyBlock/SkyblockMuseum');
-  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
-  query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
-  // eslint-disable-next-line no-underscore-dangle
-  const res = await this._makeRequest(`/skyblock/museum?uuid=${query}&profile=${profileId}`);
-  if (res.raw) return res;
-  return new SkyblockMuseum({
-    uuid: query,
-    m: res,
-    profileId: profileId
-  });
-};

package/src/API/skyblock/getNews.js

@@ -1,7 +0,0 @@
-const SkyblockNews = require('../../structures/SkyBlock/News/SkyblockNews');
-module.exports = async function () {
-  // eslint-disable-next-line no-underscore-dangle
-  const res = await this._makeRequest('/skyblock/news');
-  if (res.raw) return res;
-  return res.items.map((i) => new SkyblockNews(i));
-};

package/src/API/skyblock/getProfiles.js

@@ -1,49 +0,0 @@
-const Errors = require('../../Errors');
-const toUuid = require('../../utils/toUuid');
-const getPlayer = require('../getPlayer');
-module.exports = async function (query, options = { fetchPlayer: false, getMuseum: false, getGarden: false }) {
-  const SkyblockProfile = require('../../structures/SkyBlock/SkyblockProfile');
-  const getSkyblockMuseum = require('./getMuseum');
-  const getSkyblockGarden = require('./getGarden');
-  if (!query) throw new Error(Errors.NO_NICKNAME_UUID);
-  query = await toUuid(query, this.options.mojangCacheTime, this.options.useThirdPartyAPI);
-  // eslint-disable-next-line no-underscore-dangle
-  const res = await this._makeRequest(`/skyblock/profiles?uuid=${query}`);
-  if (res.raw) return res;
-  if (!res.profiles || !res.profiles.length) throw new Error(Errors.NO_SKYBLOCK_PROFILES);
-  const players = new Map();
-  if (options.fetchPlayer) {
-    const uniqueUuids = [...new Set(res.profiles.map((profile) => Object.keys(profile.members)).flat())];
-    await Promise.all(
-      uniqueUuids.map(async (uuid) => {
-        const player = await getPlayer.call(this, uuid, options);
-        players.set(uuid, player);
-      })
-    );
-  }
-
-  const profiles = [];
-  for (let i = 0; i < res.profiles.length; i++) {
-    if (options.fetchPlayer) {
-      for (const memberUuid of Object.keys(res.profiles[i].members)) {
-        res.profiles[i].members[memberUuid].player = players.get(memberUuid);
-      }
-    }
-
-    profiles.push({
-      uuid: query,
-      profileId: res.profiles[i].profile_id,
-      profileName: res.profiles[i].cute_name,
-      gameMode: res.profiles[i].game_mode || null,
-      m: res.profiles[i].members[query],
-      banking: res.profiles[i].banking,
-      communityUpgrades: res.profiles[i].community_upgrades,
-      museum: options.getMuseum ? await getSkyblockMuseum.call(this, query, res.profiles[i].profile_id) : null,
-      garden: options.getGarden ? await getSkyblockGarden.call(this, res.profiles[i].profile_id) : null,
-      selected: res.profiles[i].selected,
-      members: res.profiles[i].members
-    });
-  }
-
-  return profiles.map((p) => new SkyblockProfile(p));
-};

package/src/Client.js

@@ -1,547 +0,0 @@
-const rateLimit = new (require('./Private/rateLimit'))();
-const validate = new (require('./Private/validate'))();
-const updater = new (require('./Private/updater'))();
-const Requests = require('./Private/requests');
-const EventEmitter = require('events');
-const Errors = require('./Errors');
-const API = require('./API/index');
-const clients = [];
-
-/* eslint-disable */
-const Player = require('./structures/Player');
-const Guild = require('./structures/Guild/Guild');
-const WatchdogStats = require('./structures/Watchdog/Stats');
-const Booster = require('./structures/Boosters/Booster');
-const SkyblockProfile = require('./structures/SkyBlock/SkyblockProfile');
-const SkyblockMember = require('./structures/SkyBlock/SkyblockMember');
-const SkyblockMuseum = require('./structures/SkyBlock/SkyblockMuseum');
-const SkyblockGarden = require('./structures/SkyBlock/SkyblockGarden');
-const APIStatus = require('./structures/APIStatus');
-const Leaderboard = require('./structures/Leaderboard');
-const ServerInfo = require('./structures/ServerInfo');
-const RecentGame = require('./structures/RecentGame');
-const Status = require('./structures/Status');
-const Auction = require('./structures/SkyBlock/Auctions/Auction');
-const AuctionInfo = require('./structures/SkyBlock/Auctions/AuctionInfo');
-const PartialAuction = require('./structures/SkyBlock/Auctions/PartialAuction');
-const Product = require('./structures/SkyBlock/Bazzar/Product');
-const BingoData = require('./structures/SkyBlock/Static/BingoData');
-const PlayerBingo = require('./structures/SkyBlock/PlayerBingo');
-const GovernmentData = require('./structures/SkyBlock/Static/Government');
-const FireSale = require('./structures/SkyBlock/Static/FireSale');
-const SkyblockNews = require('./structures/SkyBlock/News/SkyblockNews');
-const GameCounts = require('./structures/GameCounts');
-const House = require('./structures/House.js');
-/* eslint-enable */
-
-/**
- * Client class
- */
-class Client extends EventEmitter {
-  /**
-   * @param {string} key API key
-   * @param {ClientOptions} [options={}] Client options
-   */
-  constructor(key, options = {}) {
-    super();
-    this.requests = new Requests(this, options.cacheHandler);
-    // eslint-disable-next-line no-console
-    if (options && !options.silent) this.on('warn', console.warn);
-    // Test to check for multiple instances of client
-    if (clients.find((x) => x.key === key)) {
-      this.emit('warn', Errors.MULTIPLE_INSTANCES);
-      return clients.find((x) => x.key === key);
-    }
-    validate.validateNodeVersion();
-    this.key = validate.validateKey(key);
-    this.options = validate.parseOptions(options);
-    validate.validateOptions(this.options);
-
-    for (const func in API) {
-      Client.prototype[func] = (...args) => {
-        const lastArg = args[args.length - 1];
-        return API[func].apply(
-          {
-            // eslint-disable-next-line no-underscore-dangle
-            _makeRequest: this._makeRequest.bind(this, validate.cacheSuboptions(lastArg) ? lastArg : {}),
-            ...this
-          },
-          args
-        );
-      };
-    }
-
-    if (this.options.checkForUpdates) {
-      updater.checkForUpdates().catch(() => {
-        // eslint-disable-next-line no-console
-        if (!this.options.silent) console.warn('[hypixel-api-reborn] Error whilst checking for updates!');
-      });
-    }
-    /**
-     * All cache entries
-     * @type {Map<string,object>}
-     */
-    this.cache = this.requests.cache;
-    clients.push(this);
-    rateLimit.init(this.getGameCounts(), this.options, this).then(() => this.emit('ready'));
-  }
-  /**
-   * Private function - make request
-   * @param {MethodOptions} options Options for request
-   * @param {string} url Endpoint URL to request
-   * @param {boolean} [useRateLimitManager=true] Use rate limit
-   * @returns {Promise<Object>} Response
-   * @private
-   */
-  async _makeRequest(options, url, useRateLimitManager = true) {
-    if (!url) return;
-    if ('/key' !== url && !options.noCacheCheck && (await this.requests.cache.has(url))) {
-      return Object.assign(await this.requests.cache.get(url), { raw: Boolean(options.raw) });
-    }
-    if (useRateLimitManager) await rateLimit.rateLimitManager();
-    this.emit('outgoingRequest', url, { ...options, headers: { ...options.headers, ...this.options.headers } });
-    const result = await this.requests.request.call(this.requests, url, {
-      ...options,
-      headers: { ...options.headers, ...this.options.headers }
-    });
-    // eslint-disable-next-line no-underscore-dangle
-    if (this.options.syncWithHeaders) rateLimit.sync(result._headers);
-    return result;
-  }
-  /**
-   * Emitted when rate limiter is ready. ( You don't have to wait for this event to emit UNLESS you are planning to do data scraping which means spamming requests )
-   * @event ready
-   * @name Client#ready
-   * @example
-   * // This example gets player's uuid.
-   * hypixel.once('ready',()=>{
-   *  hypixel.getPlayer('stavzdev')
-   *  .then(player => player.uuid)
-   *  .catch(console.log);
-   * })
-   */
-  /**
-   * Emitted when a request is going to be sent
-   * @event outgoingRequest
-   * @name Client#outgoingRequest
-   * @param {string} url URL
-   * @param {object} [options] Options, if any
-   */
-  /**
-   * Emitted when there is a warning.
-   * @event warn
-   * @name Client#warn
-   * @param {string} error Warning Message
-   */
-  /**
-   * Allows you to get statistics of player
-   * @method
-   * @name Client#getPlayer
-   * @param {string} query Player nickname or UUID
-   * @param {PlayerMethodOptions} [options={}] Method options
-   * @return {Promise<Player>}
-   * @example
-   * hypixel.getPlayer('StavZDev').then(player => {
-   *   console.log(player.level); // 141
-   *   console.log(player.rank); // 'MVP+'
-   * }).catch(e => {
-   *   console.log(e);
-   * })
-   * @example
-   * // Get player's guild along with player stats
-   * hypixel.getPlayer('Minikloon', { guild: true }).then(player => {
-   *   console.log(player.guild) // null if player isn't is guild
-   *   console.log(player.guild.name) // Mini Squid
-   *   console.log(player.guild.level) // 110
-   * }).catch(e => {
-   *   console.log(e);
-   * });
-   * @example
-   * // async/await
-   * const player = await hypixel.getPlayer('Minikloon').catch(console.log);
-   * // If player doesn't exist, or if an error occurred ( check console )
-   * console.log(player); // null
-   * // Check if player exists
-   * if(player) console.log(player.uuid); // 20934ef9488c465180a78f861586b4cf
-   */
-  /**
-   * Allows you to get statistics of hypixel guild
-   * @method
-   * @name Client#getGuild
-   * @param {'id'|'name'|'player'} searchParameter Search for guild by id, name or player (if player is in guild)
-   * @param {string} query Guild ID, Guild name or player uuid/nickname
-   * @param {MethodOptions} [options={}] Method options
-   * @return {Promise<Guild>}
-   * @example
-   * hypixel.getGuild('name', 'The Foundation').then(guild => {
-   *   console.log(guild.level); // 111
-   *   console.log(guild.id); // '52e5719284ae51ed0c716c69'
-   * }).catch(e => {
-   *   console.log(e);
-   * })
-   * @example
-   * // async/await
-   * const guild = await hypixel.getGuild('name', 'The Foundation').catch(console.log);
-   * console.log(guild.level); // 111
-   * console.log(guild.id); // '52e5719284ae51ed0c716c69'
-   */
-  /**
-   * Allows you to get statistics of watchdog, the server anticheat
-   * @method
-   * @name Client#getWatchdogStats
-   * @param {MethodOptions} [options={}] Method options
-   * @return {Promise<WatchdogStats>}
-   * @example
-   * hypixel.getWatchdogStats().then(watchdog => {
-   *   console.log(watchdog.byWatchdogTotal); // 5931897
-   * }).catch(e => {
-   *   console.log(e);
-   * })
-   * @example
-   * // async/await
-   * const watchdog = await hypixel.getWatchdogStats().catch(console.log);
-   * console.log(watchdog.byWatchdogTotal); // 5931897
-   */
-  /**
-   * Allows you to get all active boosters
-   * @method
-   * @name Client#getBoosters
-   * @param {MethodOptions} [options={}] Method options
-   * @return {Promise<Array<Booster>>}
-   * @example
-   * hypixel.getBoosters().then(boosters => {
-   *   console.log(boosters[0].purchaser); // '978ddb705a8e43618e41749178c020b0'
-   * }).catch(e => {
-   *   console.log(e);
-   * })
-   * @example
-   * // async/await
-   * const boosters = await hypixel.getBoosters().catch(console.log);
-   * console.log(boosters[0].purchaser); // '978ddb705a8e43618e41749178c020b0'
-   */
-  /**
-   * Allows you to get all skyblock profiles of player
-   * @method
-   * @name Client#getSkyblockProfiles
-   * @param {string} query Player nickname or UUID
-   * @param {SkyblockMethodOptions} [options={}] Method options
-   * @return {Promise<Array<SkyblockProfile>>}
-   * @example
-   * hypixel.getSkyblockProfiles('StavZDev').then(profiles => {
-   *   console.log(profiles[0].members[0].uuid); // '52d9a36f66ce4cdf9a56ad9724ae9fb4'
-   * }).catch(e => {
-   *   console.log(e);
-   * })
-   * @example
-   * const profiles = await hypixel.getSkyblockProfiles('StavZDev').catch(console.log);
-   * console.log(profiles[0].members[0].uuid); // '52d9a36f66ce4cdf9a56ad9724ae9fb4'
-   */
-  /**
-   * Allows you to get a player's skyblock member data from all their profiles
-   * @method
-   * @name Client#getSkyblockMember
-   * @param {string} query Player nickname or UUID
-   * @param {SkyblockMethodOptions} [options={}] Method options
-   * @return {Promise<Map<string,SkyblockMember>>}
-   * @example
-   * hypixel.getSkyblockMember('StavZDev').then(member => {
-   *   // 'Cucumber' - profile name
-   *   console.log(member.get('Cucumber').uuid); // '52d9a36f66ce4cdf9a56ad9724ae9fb4'
-   * }).catch(e => {
-   *   console.log(e);
-   * })
-   * @example
-   * const member = await hypixel.getSkyblockMember('StavZDev').catch(console.log);
-   * console.log(member.get('Cucumber').uuid); // '52d9a36f66ce4cdf9a56ad9724ae9fb4'
-   */
-  /**
-   * Allows you to get a player's skyblock member data from all their profiles
-   * @method
-   * @name Client#getSkyblockGarden
-   * @param {string} profileId Profile id of the garden you want
-   * @param {MethodOptions} [options={}] Method options
-   * @return {Promise<SkyblockGarden>}
-   * @example
-   * hypixel.getSkyblockMember('StavZDev').then(member => {
-   *   // 'Cucumber' - profile name
-   *   console.log(member.get('Cucumber').uuid); // '52d9a36f66ce4cdf9a56ad9724ae9fb4'
-   * }).catch(e => {
-   *   console.log(e);
-   * })
-   * @example
-   * const member = await hypixel.getSkyblockMember('StavZDev').catch(console.log);
-   * console.log(member.get('Cucumber').uuid); // '52d9a36f66ce4cdf9a56ad9724ae9fb4'
-   */
-  /**
-   * Allows you to get a player's skyblock profile museum
-   * @method
-   * @name Client#getSkyblockMuseum
-   * @param {string} query Player nickname or UUID
-   * @param {string} profileId Profile ID
-   * @return {Promise<SkyblockMuseum>}
-   */
-  /**
-   * Allows you to get the Hypixel API's Status and past Incidents, no key needed.
-   * @method
-   * @name Client#getAPIStatus
-   * @return {Promise<APIStatus>}
-   * @example
-   * hypixel.getAPIStatus().then(status => {
-   *   console.log(status.incidents[0].link); // 'https://status.hypixel.net/incidents/zdd5gppdtcc3'
-   * }).catch(e => {
-   *   console.log(e);
-   * })
-   */
-  /**
-   * Gets all leaderboards
-   * @method
-   * @name Client#getLeaderboards
-   * @param {MethodOptions} [options={}] Method options
-   * @return {Promise<{ ARENA: Leaderboard[], COPS_AND_CRIMS: Leaderboard[], WARLORDS: Leaderboard[], BLITZ_SURVIVAL_GAMES: Leaderboard[], UHC: Leaderboard[], WALLS: Leaderboard[], PROTOTYPE: Leaderboard[], PAINTBALL: Leaderboard[], SKYWARS: Leaderboard[], MURDER_MYSTERY: Leaderboard[], SMASH_HEROES: Leaderboard[], DUELS: Leaderboard[], SPEED_UHC: Leaderboard[], TNTGAMES: Leaderboard[], BEDWARS: Leaderboard[], TURBO_KART_RACERS: Leaderboard[], BUILD_BATTLE: Leaderboard[], ARCADE: Leaderboard[], SKYCLASH: Leaderboard[], QUAKECRAFT: Leaderboard[], CRAZY_WALLS: Leaderboard[], MEGA_WALLS: Leaderboard[], VAMPIREZ: Leaderboard[] }>}
-   * @example
-   * hypixel.getLeaderboards().then(leaderboards => {
-   *   console.log(leaderboards.ARENA[0].name); // 'Wins'
-   * }).catch(e => {
-   *   console.log(e);
-   * })
-   */
-  /**
-   * Sends a STATUS packet to hypixel and parses the return info (a 0x00 and 0x01 packet)
-   * @method
-   * @name Client#getServerInfo
-   * @param {number} [repeats=3] Sends x amount of ping requests and gets the average. Should be between 1 and 10
-   * @return {Promise<ServerInfo>}
-   * @example
-   * hypixel.getServerInfo(3).then(serverInfo =>{
-   *   console.log(serverInfo.ping); // 69
-   * }).catch(console.log)
-   */
-  /**
-   * Allows you to get recent games of a player
-   * @method
-   * @name Client#getRecentGames
-   * @param {string} query Player nickname or UUID
-   * @param {MethodOptions} [options={}] Method options
-   * @return {Promise<RecentGame[]>}
-   * @example
-   * hypixel.getRecentGames().then(recentGames =>{
-   *   console.log(recentGames[0].endedTimestamp); // 1609670588789
-   * })
-   * .catch(console.log);
-   */
-  /**
-   * Allows you to get the status of a player
-   * @method
-   * @name Client#getStatus
-   * @param {string} query Player nickname or UUID
-   * @param {MethodOptions} [options={}] Method options
-   * @return {Promise<Status>}
-   * @example
-   * hypixel.getStatus('Stavzdev').then(status =>{
-   *   console.log(status.online); // true
-   * })
-   * .catch(console.log);
-   */
-  /**
-   * Allows you to get skyblock auctions
-   * @method
-   * @name Client#getSkyblockAuctions
-   * @param {string|number|number[]} page - "*", a page number, or an array with the start and the end page number ( automatically sorted )
-   * @param {auctionsOptions} [options={}] Options
-   * @return {Promise<{info:AuctionInfo,Auctions:Auction[]}>}
-   */
-  /**
-   * Allows you to get player's skyblock auctions
-   * @method
-   * @name Client#getSkyblockAuctionsByPlayer
-   * @param {string} query - player nickname or uuid
-   * @param {boolean} [includeItemBytes=false] - include item bytes (optional)
-   * @param {MethodOptions} [options={}] Options
-   * @return {Promise<Auction[]>}
-   * @example
-   * hypixel.getSkyblockAuctionsByPlayer('hypixel').then(auctions =>{
-   *   console.log(auctions[0].auctionId); // b0491da3e81c43c88fd287ea3b3eacc0
-   * })
-   * .catch(console.log);
-   */
-  /**
-   * Allows you to get all ended auctions in around the last 60 seconds
-   * @method
-   * @name Client#getEndedSkyblockAuctions
-   * @param {boolean} [includeItemBytes=false] - include item bytes (optional)
-   * @param {MethodOptions} [options={}] Options
-   * @return {Promise<{info:AuctionInfo,auctions:PartialAuction[]}>}
-   * @example
-   * hypixel.getEndedSkyblockAuctions().then(ended =>{
-   *   console.log(ended.auctions[0].auctionId); // 0fe7fd132367474e86ff3022b4a84a13
-   * })
-   * .catch(console.log);
-   */
-  /**
-   * Allows you to get list of products
-   * @method
-   * @name Client#getSkyblockBazaar
-   * @param {MethodOptions} [options={}] Options
-   * @return {Promise<Product[]>}
-   * @example
-   * hypixel.getSkyblockBazaar().then(products =>{
-   *   console.log(products[0].productId); // INK_SACK:3
-   * })
-   * .catch(console.log);
-   */
-  /**
-   * Allows you to get bingo data
-   * @method
-   * @name Client#getSkyblockBingo
-   * @param {MethodOptions} [options={}] Options
-   * @return {Promise<BingoData>}
-   */
-  /**
-   * Allows you to get bingo data of a player
-   * @method
-   * @name Client#getSkyblockBingoByPlayer
-   * @param {string} query UUID / IGN of player
-   * @param {PlayerBingoOptions} [options={}] Options
-   * @return {Promise<PlayerBingo>}
-   */
-  /**
-   * Allows you to get SB government
-   * @method
-   * @name Client#getSkyblockGovernment
-   * @param {MethodOptions} [options={}] Options
-   * @return {Promise<GovernmentData>}
-   */
-  /**
-   * Allows you to get SB government
-   * @method
-   * @name Client#getSkyblockFireSale
-   * @param {MethodOptions} [options={}] Options
-   * @return {Promise<FireSale[]>}
-   */
-  /**
-   * Get a array of active houses
-   * @method
-   * @name Client#getActiveHouses
-   * @param {MethodOptions} [options={}] Options
-   * @return {Promise<House[]>}
-   */
-  /**
-   * Get a array of houses for a user
-   * @method
-   * @name Client#getPlayerHouses
-   * @param {string} query UUID / IGN of player
-   * @param {MethodOptions} [options={}] Options
-   * @return {Promise<House[]>}
-   */
-  /**
-   * Get a house
-   * @method
-   * @name Client#getHouse
-   * @param {string} query House UUID
-   * @param {MethodOptions} [options={}] Options
-   * @return {Promise<House>}
-   */
-  /**
-   * Allows you to get skyblock news
-   * @method
-   * @name Client#getSkyblockNews
-   * @param {MethodOptions} [options={}] Options
-   * @return {Promise<SkyblockNews[]>}
-   * @example
-   * hypixel.getSkyblockNews().then((news) => {
-   *   console.log(news[0].link); // https://hypixel.net/threads/3749492/
-   * })
-   * .catch(console.log)
-   */
-  /**
-   * Allows you to get player count along with the player count of each public game
-   * @method
-   * @name Client#getGameCounts
-   * @param {MethodOptions} [options={}] Options
-   * @return {Promise<GameCounts>}
-   * @example
-   * hypixel.getGameCounts().then((gameCounts) => {
-   *   console.log(gameCounts.mainLobby.players);
-   * })
-   * .catch(console.log)
-   */
-  /**
-   * Delete x (by default all) cache entries
-   * @param {?number} amount Amount of cache to delete
-   * @return {Promise<void|boolean[]>}
-   */
-  sweepCache(amount) {
-    return this.requests.sweepCache(amount);
-  }
-}
-/**
- * @typedef {object} ClientOptions
- * @prop {boolean} [cache=true] Enable/Disable request caching.
- * @prop {number} [hypixelCacheTime=60] Amount of time in seconds to cache the hypixel api requests.
- * @prop {number} [mojangCacheTime=600] Amount of time in seconds to cache the mojang api requests.
- * @prop {CacheHandler} [cacheHandler] Custom Cache Handler
- * @prop {'AUTO'|'HARD'|'NONE'} [rateLimit='AUTO'] Rate limit mode.
- * @prop {boolean} [syncWithHeaders=false] Sync with headers rate limit information. Usually not necessary nor recommended ( because of latency )
- * @prop {number} [keyLimit=60] Key limit of your key.
- * @prop {number} [cacheSize=-1] The amount how many results will be cached. (`-1` for infinity)
- * @prop {boolean} [silent=false] Don't automatically put warnings into console.
- * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request.
- * @prop {boolean} [checkForUpdates=true] Enable/Disable check for new version of hypixel-api-reborn.
- * @prop {boolean|string} [useThirdPartyAPI=false] Enable/Disable Mojang Third Party API
- */
-// eslint-disable-next-line no-unused-vars
-const defaultCache = require('./Private/defaultCache.js');
-/**
- * @typedef {defaultCache} Cache
- */
-/**
- * @typedef {Cache} CacheHandler
- */
-/**
- * @typedef {object} MethodOptions
- * @property {boolean} [raw=false] Raw data
- * @property {boolean} [noCacheCheck=false] Disable/Enable cache checking
- * @property {boolean} [noCaching=false] Disable/Enable writing to cache
- * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request. Overrides the headers globally provided.
- */
-/**
- * @typedef {object} PlayerMethodOptions
- * @property {boolean} [raw=false] Raw data
- * @property {boolean} [noCacheCheck=false] Disable/Enable cache checking
- * @property {boolean} [noCaching=false] Disable/Enable writing to cache
- * @property {boolean} [guild=false] Disable/Enable request for player's guild
- * @property {boolean} [recentGames=false] Disable/Enable request for player's recent game
- * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request. Overrides the headers globally provided.
- */
-/**
- * @typedef {object} SkyblockMethodOptions
- * @property {boolean} [raw=false] Raw data
- * @property {boolean} [noCacheCheck=false] Disable/Enable cache checking
- * @property {boolean} [noCaching=false] Disable/Enable writing to cache
- * @property {?boolean} [fetchPlayer=false] Disable/Enable player profile request for each member
- * @property {?boolean} [getMuseum=false] Disable/Enable player museum request for each member
- * @property {?boolean} [getGarden=false] Disable/Enable player garden request for each member
- * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request. Overrides the headers globally provided.
- */
-/**
- * @typedef {object} auctionsOptions
- * @property {boolean} [noCacheCheck=false] Disable/Enable cache checking
- * @property {boolean} [noCaching=false] Disable/Enable writing to cache
- * @property {boolean} [noInfo=false] If true, result doesn't show Auction Info
- * @property {boolean} [noAuctions=false] If true, result doesn't show auctions
- * @property {boolean} [raw=false] If true, result will not contain parsed auctions, but will present them as it is received. This can speed up performance in some cases.
- * @property {number} [retries=3] Number of times to retry fetching a page before abandoning
- * @property {number} [cooldown=100] Cooldown between each fetch, only works if race is unset or false;
- * @property {boolean} [race=false] Issues simultaneous requests to the API, instead of requesting then parsing one by one. Can largely increase speed at the cost of hogging bandwidth and memory
- * @property {boolean} [includeItemBytes=false] Whether to include item bytes in the result
- * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request. Overrides the headers globally provided.
- */
-/**
- * @typedef {object} PlayerBingoOptions
- * @property {boolean} [raw=false] Raw data
- * @property {boolean} [noCacheCheck=false] Disable/Enable cache checking
- * @property {boolean} [noCaching=false] Disable/Enable writing to cache
- * @property {boolean} [fetchBingoData=false] Fetches bingo data to give more information
- * @prop {object} [headers={}] Extra Headers ( like User-Agent ) to add to request. Overrides the headers globally provided.
- */
-module.exports = Client;