version 1.1.2, updated JSDoc

Author: DS Software

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "scf-api",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "An SCF API Client for NodeJS",
   "main": "index.js",
   "type": "module",

package.json

@@ -32,20 +32,20 @@ export default class GTW {
     }
 
     /**
-     * @typedef {Object} PlayerEntry
+     * @typedef {Object} GTWPlayer
      * @property {string} discord_id
      * @property {number} total
 
-     * @typedef {Object} Leaderboard
-     * @property {PlayerEntry[]} weekly
-     * @property {PlayerEntry[]} overall
+     * @typedef {Object} GTWLeaderboard
+     * @property {GTWPlayer[]} weekly
+     * @property {GTWPlayer[]} overall
 
-     * @typedef {Object} GetTopResponse
-     * @property {Leaderboard} score
-     * @property {Leaderboard} rounds
+     * @typedef {Object} GTWTop
+     * @property {GTWLeaderboard} score
+     * @property {GTWLeaderboard} rounds
      * 
      * Returns Guess The Word leaderboards.
-     * @returns {Promise<GetTopResponse>}
+     * @returns {Promise<GTWTop>}
      */
     async getTop() {
         let response = await this.#client.sendAPIRequest(this.#section, "getTop", "GET", []);

src/sections/gtw.js

@@ -71,13 +71,13 @@ export default class Inactive {
     }
 
     /**
-     * @typedef {Object} PlayerEntry
+     * @typedef {Object} InactivePlayer
      * @property {string} uuid
      * @property {number} requested
      * @property {number} expired
      * 
      * Returns the list of all inactive players.
-     * @returns {Promise<PlayerEntry[]>}
+     * @returns {Promise<InactivePlayer[]>}
      */
     async list() {
         let response = await this.#client.sendAPIRequest(this.#section, "list", "GET", []);

src/sections/inactive.js

@@ -111,24 +111,24 @@ export default class Minigames {
     }
 
     /**
-     * @typedef {Object} Coins
+     * @typedef {Object} MinigameCoins
      * @property {number} purse
      * @property {number} bank
      * @property {number} total
      * 
-     * @typedef {Object} Cooldowns
+     * @typedef {Object} MinigameCooldowns
      * @property {string} work
      * @property {string} crime
      * @property {string} beg
      * @property {string} social
      *
-     * @typedef {Object} PlayerEntry
+     * @typedef {Object} MinigamePlayer
      * @property {string} discord_id
-     * @property {Coins} coins
-     * @property {Cooldowns} cooldowns
+     * @property {MinigameCoins} coins
+     * @property {MinigameCooldowns} cooldowns
      * 
      * Returns top 10 minigame players, sorted by networth.
-     * @returns {Promise<PlayerEntry[]>}
+     * @returns {Promise<MinigamePlayer[]>}
      */
     async getTop() {
         let response = await this.#client.sendAPIRequest(this.#section, "getTop", "GET", []);
@@ -140,7 +140,7 @@ export default class Minigames {
      * 
      * Returns the minigame profile for a Discord ID.
      * @param {string} discord_id
-     * @returns {Promise<PlayerEntry>}
+     * @returns {Promise<MinigamePlayer>}
      */
     async getProfile(discord_id) {
         let response = await this.#client.sendAPIRequest(this.#section, "getProfile", "GET", [

src/sections/minigames.js

@@ -13,12 +13,12 @@ export default class Score {
     }
 
     /**
-     * @typedef {Object} PlaceEntry
+     * @typedef {Object} ScorePlaceEntry
      * @property {number} place
      * @property {number} score
      * @property {string} nick
      *
-     * @typedef {Object} PlayerEntry
+     * @typedef {Object} PlayerScore
      * @property {string} uuid
      * @property {number} score
      * @property {string} nick
@@ -28,7 +28,7 @@ export default class Score {
      * Returns the score and the place of a user in the guild of the token this week.
      * @param {string} uuid
      * @param {boolean} overall
-     * @returns {Promise<PlaceEntry>}
+     * @returns {Promise<ScorePlaceEntry>}
      */
     async getCutoff(uuid, overall = false) {
         let response = await this.#client.sendAPIRequest(this.#section, "getCutoff", "GET", [
@@ -55,7 +55,7 @@ export default class Score {
      * Returns the score and the place of a user in the guild of the token in the past 7 days.
      * @param {string} uuid
      * @param {boolean} overall
-     * @returns {Promise<PlaceEntry>}
+     * @returns {Promise<ScorePlaceEntry>}
      */
     async getRolling(uuid, overall = false) {
         let response = await this.#client.sendAPIRequest(this.#section, "getRolling", "GET", [
@@ -107,7 +107,7 @@ export default class Score {
     /**
      * Returns the top players in a guild based on their score.
      * @param {string|null} guild_id
-     * @returns {Promise<{total: number, list: PlayerEntry[]}>}
+     * @returns {Promise<{total: number, list: PlayerScore[]}>}
      */
     async getTop(guild_id = null) {
         let args = [];