github-repos/node-steamcommunity
1
0
Fork 0
mirror of https://github.com/DoctorMcKay/node-steamcommunity.git synced 2026-08-22 14:43:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add JsDoc

Browse Source
This commit is contained in:
3urobeat
2023-05-29 19:29:24 +02:00
parent e23fa02c91
commit 440b2f9ba9
1 changed files with 11 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
classes/CSteamSharedfile.js
View File

@@ -107,7 +107,7 @@ SteamCommunity.prototype.getSteamSharedfile = function(sharedFileId, callback) {
// Find numRatings if this is a guide as they use a different voting system // Find numRatings if this is a guide as they use a different voting system
let numRatings = $(".ratingSection > .numRatings").text().replace(" ratings", "") let numRatings = $(".ratingSection > .numRatings").text().replace(" ratings", "");
sharedfile.guideNumRatings = Number(numRatings) || null; // Set to null if not a guide or if the guide does not have enough ratings to show a value sharedfile.guideNumRatings = Number(numRatings) || null; // Set to null if not a guide or if the guide does not have enough ratings to show a value
@@ -151,22 +151,20 @@ SteamCommunity.prototype.getSteamSharedfile = function(sharedFileId, callback) {
}, "steamcommunity"); }, "steamcommunity");
}; };
/**
* Constructor - Creates a new Sharedfile object
* @class
* @param {SteamCommunity} community
* @param {{ id: string, type: ESharedfileType, appID: number, owner: SteamID|null, fileSize: string|null, postDate: number, resolution: string|null, uniqueVisitorsCount: number, favoritesCount: number, upvoteCount: number|null, guideNumRatings: Number|null, isUpvoted: boolean, isDownvoted: boolean }} data
*/
function CSteamSharedfile(community, data) { function CSteamSharedfile(community, data) {
/**
* @type {SteamCommunity}
*/
this._community = community; this._community = community;
// Clone all the data we recieved // Clone all the data we recieved
Object.assign(this, data); // TODO: This is cleaner but might break IntelliSense. I'm leaving the block below to be reactivated if necessary Object.assign(this, data);
/* this.id = data.id;
this.type = data.type;
this.appID = data.appID;
this.owner = data.owner;
this.fileSize = data.fileSize;
this.postDate = data.postDate;
this.resolution = data.resolution;
this.uniqueVisitorsCount = data.uniqueVisitorsCount;
this.favoritesCount = data.favoritesCount;
this.upvoteCount = data.upvoteCount; */
} }
/** /**