document game data #687

This commit is contained in:
Amish Shah
2016-09-11 18:23:53 +01:00
parent 3dab19a3bc
commit d365eb95e2
2 changed files with 10 additions and 2 deletions

File diff suppressed because one or more lines are too long

View File

@@ -80,9 +80,17 @@ class User {
*/
this.status = data.status || this.status || 'offline';
/**
* Represents data about a Game
* @property {string} name the name of the game being played.
* @property {string} [url] the URL of the stream, if the game is being streamed.
* @property {number} [type] if being streamed, this is `1`.
* @typedef {object} Game
*/
/**
* The game that the user is playing, `null` if they aren't playing a game.
* @type {string}
* @type {Game}
*/
this.game = data.game;
}