jsdoc, typings for getGameCounts

Author: StavZ

src/Client.js

@@ -284,7 +284,18 @@ class Client {
    * })
    * .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

src/structures/GameCounts.js

@@ -8,10 +8,6 @@ class GameCounts {
    * @param {object} data
    */
   constructor (data) {
-    /**
-     * Current player count
-     * @type {number}
-     */
     /**
      * Player count in Main lobby
      * @name GameCounts#mainLobby
@@ -132,6 +128,10 @@ class GameCounts {
      * @name GameCounts#queue
      * @type {object}
      */
+    /**
+     * Current player count
+     * @type {number}
+     */
     this.playerCount = data.playerCount;
     for (const game in data.games) {
       if (Object.prototype.hasOwnProperty.call(data.games, game)) {

typings/index.d.ts

@@ -228,6 +228,9 @@ declare module 'hypixel-api-reborn' {
          * @description Allows you to get list of products
          */
         getSkyblockBazaar(options?: methodOptions): Promise<Product[]>;
+        /**
+         * @description Allows you to get skyblock news
+         */
         getSkyblockNews(options?: methodOptions): Promise<SkyblockNews>;
         /**
          * @description Allows you to get player's network status
@@ -250,6 +253,10 @@ declare module 'hypixel-api-reborn' {
          * @description Allows you to get recent games of a player
          */
         getRecentGames(options?: methodOptions): Promise<RecentGame[]>;
+        /**
+         * @description Allows you to get player count along with the player count of each public game
+         */
+        getGameCounts(options?: methodOptions): Promise<GameCounts>;
         /**
          * @param ip - Valid IP/Hostname address
          * @description Pings the minecraft server of hypixel by default