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
|
|
@ -60,14 +60,39 @@ class activeChannel{
|
|||
* @param {Mongoose.Document} chanDB - chanDB to rehydrate buffer from
|
||||
*/
|
||||
constructor(server, chanDB){
|
||||
/**
|
||||
* Parent Server Object
|
||||
*/
|
||||
this.server = server;
|
||||
|
||||
/**
|
||||
* Current Channel Name
|
||||
*/
|
||||
this.name = chanDB.name;
|
||||
|
||||
/**
|
||||
* List of channel-wide toke commands
|
||||
*/
|
||||
this.tokeCommands = chanDB.tokeCommands;
|
||||
//Keeping these in a map was originally a vestige but it's more preformant than an array or object so :P
|
||||
|
||||
/**
|
||||
* List of connected users
|
||||
*/
|
||||
this.userList = new Map();
|
||||
|
||||
/**
|
||||
* Child Queue Object
|
||||
*/
|
||||
this.queue = new queue(server, chanDB, this);
|
||||
|
||||
/**
|
||||
* Child Playlist Handler Object
|
||||
*/
|
||||
this.playlistHandler = new playlistHandler(server, chanDB, this);
|
||||
//Define the chat buffer
|
||||
|
||||
/**
|
||||
* Child Chat Buffer Object
|
||||
*/
|
||||
this.chatBuffer = new chatBuffer(server, chanDB, this);
|
||||
}
|
||||
|
||||
|
|
@ -196,7 +221,7 @@ module.exports = activeChannel;</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