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
|
|
@ -55,26 +55,48 @@ class chatBuffer{
|
|||
* @param {activeChannel} channel - Parent Channel Object
|
||||
*/
|
||||
constructor(server, chanDB, channel){
|
||||
//Grab parent server and chan objects
|
||||
/**
|
||||
* Parent Server Object
|
||||
*/
|
||||
this.server = server;
|
||||
|
||||
/**
|
||||
* Parent CHannel Object
|
||||
*/
|
||||
this.channel = channel;
|
||||
|
||||
//If we have no chanDB.chatBuffer
|
||||
if(chanDB == null || chanDB.chatBuffer == null){
|
||||
//Create RAM-based buffer array
|
||||
/**
|
||||
* RAM-Based buffer containing array of previous chats
|
||||
*/
|
||||
this.buffer = [];
|
||||
//Otherwise
|
||||
}else{
|
||||
//Pull buffer from DB
|
||||
/**
|
||||
* RAM-Based buffer containing array of previous chats
|
||||
*/
|
||||
this.buffer = chanDB.chatBuffer;
|
||||
}
|
||||
|
||||
//Create variables to hold timers for deciding when to write RAM buffer to DB
|
||||
//Goes off 'this.inactivityDelay' seconds after the last chat was sent, assuming it isn't interrupted by new chats
|
||||
/**
|
||||
* Inactivity Timer, goes off after x seconds of chat inactivity
|
||||
*/
|
||||
this.inactivityTimer = null;
|
||||
|
||||
/**
|
||||
* Inactivity Timer Delay
|
||||
*/
|
||||
this.inactivityDelay = 10;
|
||||
//Goes off 'this.busyDelay' minutes after the first chat message in the current volley of messages. Get's cancelled before being called if this.inactivityTimer goes off.
|
||||
|
||||
/**
|
||||
* Goes off after x minutes of solid chatroom activity (no inactivityTimer call in x minutes)
|
||||
*/
|
||||
this.busyTimer = null;
|
||||
|
||||
/**
|
||||
* Busy Timer Delay
|
||||
*/
|
||||
this.busyDelay = 5;
|
||||
}
|
||||
|
||||
|
|
@ -178,7 +200,7 @@ module.exports = chatBuffer;</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