Added jsdoc for the node part of etherpad. (#5983)

This commit is contained in:
SamTV12345 2023-10-17 12:49:56 +02:00 committed by GitHub
parent 53d1e8a160
commit ff1b929eb2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 284 additions and 71 deletions

View file

@ -35,8 +35,9 @@ const components = {};
let io;
/**
* adds a component
/** adds a component
* @param {string} moduleName
* @param {Module} module
*/
exports.addComponent = (moduleName, module) => {
if (module == null) return exports.deleteComponent(moduleName);
@ -44,10 +45,15 @@ exports.addComponent = (moduleName, module) => {
module.setSocketIO(io);
};
/**
* removes a component
* @param {Module} moduleName
*/
exports.deleteComponent = (moduleName) => { delete components[moduleName]; };
/**
* sets the socket.io and adds event functions for routing
* @param {Object} _io the socket.io instance
*/
exports.setSocketIO = (_io) => {
io = _io;