Properly marked exported classes to fix JSDoc
This commit is contained in:
parent
7d31cc9e8a
commit
514b00a714
67 changed files with 23032 additions and 29404 deletions
|
|
@ -24,7 +24,7 @@ const playlistHandler = require('./media/playlistHandler')
|
|||
/**
|
||||
* Class representing a single active channel
|
||||
*/
|
||||
module.exports = class{
|
||||
class activeChannel{
|
||||
|
||||
/**
|
||||
* Instantiates an activeChannel object
|
||||
|
|
@ -150,4 +150,6 @@ module.exports = class{
|
|||
//Broadcast that sumbitch
|
||||
this.server.io.in(this.name).emit('chanEmotes', emoteList);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = activeChannel;
|
||||
|
|
@ -30,7 +30,7 @@ const chatHandler = require('./chatHandler');
|
|||
/**
|
||||
* Class containing global server-side channel connection management logic
|
||||
*/
|
||||
module.exports = class{
|
||||
class channelManager{
|
||||
/**
|
||||
* Instantiates object containing global server-side channel conection management logic
|
||||
* @param {Server} io - Socket.io server instanced passed down from server.js
|
||||
|
|
@ -301,4 +301,6 @@ module.exports = class{
|
|||
//Broadcast that sumbitch
|
||||
this.io.sockets.emit('siteEmotes', emoteList);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = channelManager;
|
||||
|
|
@ -28,7 +28,7 @@ const {userModel} = require('../../schemas/user/userSchema');
|
|||
/**
|
||||
* Class containing global server-side chat relay logic
|
||||
*/
|
||||
module.exports = class{
|
||||
class chatHandler{
|
||||
/**
|
||||
* Instantiates a chatHandler object
|
||||
* @param {channelManager} server - Parent Server Object
|
||||
|
|
@ -330,4 +330,6 @@ module.exports = class{
|
|||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = chatHandler;
|
||||
|
|
@ -26,7 +26,7 @@ const channelModel = require('../../schemas/channel/channelSchema');
|
|||
/**
|
||||
* Class containing global server-side chat/command pre-processing logic
|
||||
*/
|
||||
module.exports = class commandPreprocessor{
|
||||
class commandPreprocessor{
|
||||
/**
|
||||
* Instantiates a commandPreprocessor object
|
||||
* @param {channelManager} server - Parent Server Object
|
||||
|
|
@ -427,4 +427,6 @@ class commandProcessor{
|
|||
//throw send flag
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = commandPreprocessor;
|
||||
|
|
@ -25,7 +25,7 @@ const { userModel } = require('../../schemas/user/userSchema');
|
|||
/**
|
||||
* Class representing a single user connected to a channel
|
||||
*/
|
||||
module.exports = class{
|
||||
class connectedUser{
|
||||
/**
|
||||
* Instantiates a connectedUser object
|
||||
* @param {Mongoose.Document} userDB - User document to re-hydrate user from
|
||||
|
|
@ -288,4 +288,6 @@ module.exports = class{
|
|||
this.channel.broadcastUserList();
|
||||
this.sendClientMetadata();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = connectedUser;
|
||||
|
|
@ -17,7 +17,7 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.*/
|
|||
/**
|
||||
* Object representing a piece of media
|
||||
*/
|
||||
module.exports = class{
|
||||
class media{
|
||||
/**
|
||||
* Creates a new media object from scraped information
|
||||
* @param {String} title - Chosen title of media
|
||||
|
|
@ -37,4 +37,6 @@ module.exports = class{
|
|||
this.duration = duration;
|
||||
this.rawLink = rawLink;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = media;
|
||||
|
|
@ -27,7 +27,7 @@ const { userModel } = require('../../../schemas/user/userSchema');
|
|||
/**
|
||||
* Class containing playlist management logic for a single channel
|
||||
*/
|
||||
module.exports = class{
|
||||
class playlistHandler{
|
||||
/**
|
||||
* Instantiates a new object to handle playlist management for a single channel
|
||||
* @param {channelManager} server - Parent server object
|
||||
|
|
@ -1134,4 +1134,6 @@ module.exports = class{
|
|||
return loggerUtils.socketExceptionHandler(socket, err);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = playlistHandler;
|
||||
|
|
@ -26,7 +26,7 @@ const channelModel = require('../../../schemas/channel/channelSchema');
|
|||
/**
|
||||
* Object represneting a single channel's media queue
|
||||
*/
|
||||
module.exports = class{
|
||||
class queue{
|
||||
/**
|
||||
* Instantiates a new media queue for a given channel
|
||||
* @param {channelManager} server - Parent server object
|
||||
|
|
@ -1749,4 +1749,6 @@ module.exports = class{
|
|||
loggerUtils.localExceptionHandler(err);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = queue;
|
||||
|
|
@ -21,7 +21,7 @@ const media = require('./media');
|
|||
* Class extending media which represents a queued piece of media
|
||||
* @extends media
|
||||
*/
|
||||
module.exports = class extends media{
|
||||
class queuedMedia extends media{
|
||||
/**
|
||||
* Creates a new queued media object
|
||||
* @param {Number} startTime - JS Epoch representing start time
|
||||
|
|
@ -119,4 +119,6 @@ module.exports = class extends media{
|
|||
return this.startTime + (this.earlyEnd * 1000);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = queuedMedia;
|
||||
|
|
@ -23,7 +23,7 @@ const statSchema = require('../../schemas/statSchema');
|
|||
/**
|
||||
* Class containing global server-side tokebot logic
|
||||
*/
|
||||
module.exports = class tokebot{
|
||||
class tokebot{
|
||||
/**
|
||||
* Instantiates a tokebot object
|
||||
* @param {channelManager} server - Parent Server Object
|
||||
|
|
@ -228,3 +228,5 @@ module.exports = class tokebot{
|
|||
}
|
||||
|
||||
}
|
||||
|
||||
module.exports = tokebot;
|
||||
Loading…
Add table
Add a link
Reference in a new issue