Merge pull request #226 from mkreiser/fix-docs

Fix NFLGame JSDoc
mkreiser · Sep 2, 2023 · c6d4ee9 · c6d4ee9
2 parents 4cae8ab + b602958
commit c6d4ee9
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/nfl-game/nfl-game.js b/src/nfl-game/nfl-game.js
@@ -37,6 +37,8 @@ class NFLGame extends BaseObject {
    * @property {Date} startTime The date and time when the game starts in Eastern Time.
    * @property {number} quarter The quarter the game is in.
    * @property {string} clock The current game clock formatted as MM:SS.
+   * @property {string} odds The odds for the game formatted as "TEAM_ABBREV LINE". NOTE: These
+   *   may only display for the current week.
    * @property {string} broadcaster Who is broadcasting the game on TV.
    *
    * @property {string} gameStatus Whether or not the game has not started, is in progress, or has