Added JSDoc for Class Members of src/app/channel/*
This commit is contained in:
parent
1aa836ba48
commit
f34ad4829c
110 changed files with 6072 additions and 317 deletions
|
|
@ -62,23 +62,55 @@ class connectedUser{
|
|||
* @param {Socket} socket - Socket associated with the users connection
|
||||
*/
|
||||
constructor(userDB, chanRank, channel, socket){
|
||||
/**
|
||||
* User ID Number
|
||||
*/
|
||||
this.id = userDB.id;
|
||||
|
||||
/**
|
||||
* User Name
|
||||
*/
|
||||
this.user = userDB.user;
|
||||
|
||||
/**
|
||||
* User Rank
|
||||
*/
|
||||
this.rank = userDB.rank;
|
||||
|
||||
/**
|
||||
* User High-Level
|
||||
*/
|
||||
this.highLevel = userDB.highLevel;
|
||||
|
||||
//Check to make sure users flair entry from DB is good
|
||||
if(userDB.flair != null){
|
||||
//Use flair from DB
|
||||
//Set flair from DB
|
||||
/**
|
||||
* User Flair
|
||||
*/
|
||||
this.flair = userDB.flair.name;
|
||||
//Otherwise
|
||||
}else{
|
||||
//Gracefully default to classic
|
||||
/**
|
||||
* User Flair
|
||||
*/
|
||||
this.flair = 'classic';
|
||||
}
|
||||
|
||||
/**
|
||||
* User Channel-Rank
|
||||
*/
|
||||
this.chanRank = chanRank;
|
||||
|
||||
/**
|
||||
* Connected Channel
|
||||
*/
|
||||
this.channel = channel;
|
||||
|
||||
/**
|
||||
* List of active sockets to current channel
|
||||
*/
|
||||
this.sockets = [socket.id];
|
||||
}
|
||||
|
||||
|
|
@ -334,7 +366,7 @@ module.exports = connectedUser;</code></pre>
|
|||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Fri Sep 05 2025 08:36:32 GMT-0400 (Eastern Daylight Time)
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sat Sep 06 2025 00:30:24 GMT-0400 (Eastern Daylight Time)
|
||||
</footer>
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue