indents, more getPlayer examples

Author: StavZ

src/Client.js

@@ -51,14 +51,28 @@ class Client {
    * @param {PlayerMethodOptions} [options={}] Method options
    * @return {Promise<Player>}
    * @example
-   * // { guild: true } - fetch player's guild
-   * hypixel.getPlayer('StavZDev', { guild: true }).then(player => {
+   * hypixel.getPlayer('StavZDev').then(player => {
    *   console.log(player.level); // 141
    *   console.log(player.rank); // 'MVP+'
-   *   console.log(player.guild); // null (player is not in guild)
    * }).catch(e => {
    *   console.log(e);
    * })
+   * @example
+   * // Get player's guild along with player stats
+   * hypixel.getPlayer('Minikloon').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
+   * console.log(player); // null
+   *
+   * console.log(player.uuid); // 20934ef9488c465180a78f861586b4cf
    */
   /**
    * Allows you to get statistics of hypixel guild

src/structures/Player.js

@@ -102,7 +102,8 @@ class Player {
      */
     this.prefixColor = this.rank === 'MVP++' ? (data.monthlyRankColor ? new Color(data.monthlyRankColor) : new Color('GOLD')) : null;
     /**
-     * Player's guild. Guild option must be `true`
+     * Player's guild. Guild option must be `true`. <br>
+     * Example: {@link Client#getPlayer}
      * @type {Guild}
      */
     this.guild = data.guild ? data.guild : null;

src/structures/SkyBlock/SkyblockMember.js

@@ -25,54 +25,54 @@ class SkyblockMember {
      */
     this.player = data.m.player || null;
     /**
-         * Skyblock member's profile name
-         * @type {string}
-         */
+     * Skyblock member's profile name
+     * @type {string}
+     */
     this.profileName = data.profileName;
     /**
-             * Timestamp when player first joined SkyBlock
-             * @type {number}
-             */
+     * Timestamp when player first joined SkyBlock
+     * @type {number}
+     */
     this.firstJoinTimestamp = data.m.first_join;
     /**
-             * Timestamp when player first joined SkyBlock as Date
-             * @type {Date}
-             */
+     * Timestamp when player first joined SkyBlock as Date
+     * @type {Date}
+     */
     this.firstJoinAt = new Date(data.m.first_join);
     /**
-             * Timestamp when player first joined the SkyBlock Hub
-             * @type {number}
-             */
+     * Timestamp when player first joined the SkyBlock Hub
+     * @type {number}
+     */
     this.firstJoinHubTimestamp = data.m.first_join_hub;
     /**
-             * Timestamp when player first joined the SkyBlock Hub as Date
-             * @type {Date}
-             */
+     * Timestamp when player first joined the SkyBlock Hub as Date
+     * @type {Date}
+     */
     this.firstJoinHubAt = new Date(data.m.first_join_hub);
     /**
-             * Last save timestamp
-             * @type {number}
-             */
+     * Last save timestamp
+     * @type {number}
+     */
     this.lastSave = data.m.last_save;
     /**
-             * Last save timestamp as Date
-             * @type {Date}
-             */
+     * Last save timestamp as Date
+     * @type {Date}
+     */
     this.lastSaveAt = new Date(data.m.last_save);
     /**
-         * Last death timestamp as Date
-         * @type {Date}
-         */
+     * Last death timestamp as Date
+     * @type {Date}
+     */
     this.lastDeathAt = new Date(skyblock_year_0 + data.m.last_death * 1000);
     /**
-         * Last save timestamp
-         * @type {number}
-         */
+     * Last save timestamp
+     * @type {number}
+     */
     this.lastDeath = data.m.last_death;
     /**
-         * Equipped armor
-         * @return {Promise<SkyblockMemberArmor>}
-         */
+     * Equipped armor
+     * @return {Promise<SkyblockMemberArmor>}
+     */
     this.getArmor = async () => {
       const base64 = data.m.inv_armor;
       const decoded = await decode(base64.data);
@@ -85,39 +85,39 @@ class SkyblockMember {
       return armor;
     };
     /**
-             * Collected fairy souls
-             * @type {number}
-             */
+     * Collected fairy souls
+     * @type {number}
+     */
     this.fairySouls = data.m.fairy_souls_collected || 0;
     /**
-             * Amount of fairy soul exchanges
-             * @type {number}
-             */
+     * Amount of fairy soul exchanges
+     * @type {number}
+     */
     this.fairyExchanges = data.m.fairyExchanges || 0;
     /**
-             * Skyblock member skills
-             * @type {SkyblockMemberSkills}
-             */
+     * Skyblock member skills
+     * @type {SkyblockMemberSkills}
+     */
     this.skills = getSkills(data.m);
     /**
-             * Skyblock member slayer
-             * @type {SkyblockMemberSlayer|null}
-             */
+     * Skyblock member slayer
+     * @type {SkyblockMemberSlayer|null}
+     */
     this.slayer = getSlayer(data.m);
     /**
-             * Skyblock member dungeons
-             * @type {SkyblockMemberDungeons|null}
-             */
+     * Skyblock member dungeons
+     * @type {SkyblockMemberDungeons|null}
+     */
     this.dungeons = getDungeons(data.m);
     /**
-             * Skyblock member collections
-             * @type {object}
-             */
+     * Skyblock member collections
+     * @type {object}
+     */
     this.collections = data.m.collection ? data.m.collection : null;
     /**
-             * Skyblock member enderchest
-             * @return {Promise<SkyblockInventoryItem[]>}
-             */
+     * Skyblock member enderchest
+     * @return {Promise<SkyblockInventoryItem[]>}
+     */
     this.getEnderChest = async () => {
       const chest = data.m.ender_chest_contents;
       if (!chest) return [];
@@ -138,9 +138,9 @@ class SkyblockMember {
       }
     };
     /**
-             * Skyblock member inventory
-             * @return {Promise<SkyblockInventoryItem[]>}
-             */
+     * Skyblock member inventory
+     * @return {Promise<SkyblockInventoryItem[]>}
+     */
     this.getInventory = async () => {
       let inventory = data.m.inv_contents;
       if (!inventory) return [];
@@ -160,32 +160,32 @@ class SkyblockMember {
       }
     };
     /**
-         * Skyblock coins in purse
-         * @type {number}
-         */
+     * Skyblock coins in purse
+     * @type {number}
+     */
     this.purse = data.m.purse || 0;
     /**
-         * Skyblock member stats
-         * @type {SkyblockMemberStats}
-         */
+     * Skyblock member stats
+     * @type {SkyblockMemberStats}
+     */
     this.stats = data.m.stats ? single(data.m.stats) : null;
     /**
-         * Skyblock pets
-         * @type {SkyblockPet[]}
-         */
+     * Skyblock pets
+     * @type {SkyblockPet[]}
+     */
     this.pets = data.m.pets ? data.m.pets.map((pet) => new SkyblockPet(pet)) : [];
   }
   /**
-     * Skyblock Member pet score
-     * @return {number}
-     */
+   * Skyblock Member pet score
+   * @return {number}
+   */
   getPetScore () {
     return this.pets.reduce((acc, cur) => acc + (cur.petScore || 0), 0);
   }
   /**
-     * UUID
-     * @return {string}
-     */
+   * UUID
+   * @return {string}
+   */
   toString () {
     return this.uuid;
   }