Add some documentation and type information

server/boardData.js

@@ -32,10 +32,13 @@ var fs = require('./fs_promises.js')
 
 /**
  * Represents a board.
+ * @class
  * @constructor
+ * @param {string} name
  */
 var BoardData = function (name) {
 	this.name = name;
+	/** @type {{[name: string]: {[object_id:string]: any}}} */
 	this.board = {};
 	this.file = path.join(config.HISTORY_DIR, "board-" + encodeURIComponent(name) + ".json");
 	this.lastSaveDate = Date.now();
@@ -119,13 +122,6 @@ BoardData.prototype.getAll = function (id) {
 	return results;
 };
 
-/**
- * 
- */
-BoardData.prototype.addUser = function addUser(userId) {
-
-}
-
 /**
  * This callback is displayed as part of the BoardData class.
  * Describes a function that processes data that comes from the board
@@ -224,7 +220,7 @@ BoardData.prototype.validate = function validate(item, parent) {
 }
 
 /** Load the data in the board from a file.
- * @param {string} file - Path to the file where the board data will be read.
+ * @param {string} name - name of the board
 */
 BoardData.load = async function loadBoard(name) {
 	var boardData = new BoardData(name), data;
@@ -254,6 +250,10 @@ BoardData.load = async function loadBoard(name) {
 	return boardData;
 };
 
+/**
+ * Given a board file name, return a name to use for temporary data saving. 
+ * @param {string} baseName 
+ */
 function backupFileName(baseName) {
 	var date = new Date().toISOString().replace(/:/g, '');
 	return baseName + '.' + date + '.bak';

server/log.js

@@ -1,3 +1,8 @@
+/**
+ * Add a message to the logs
+ * @param {string} type 
+ * @param {any} infos 
+ */
 function log(type, infos) {
     var msg = new Date().toISOString() + '\t' + type;
     if (infos) msg += '\t' + JSON.stringify(infos);

server/server.js

@@ -47,6 +47,10 @@ function serveError(request, response) {
 	}
 }
 
+/**
+ * Write a request to the logs
+ * @param {import("http").IncomingMessage} request 
+ */
 function logRequest(request) {
 	log('connection', {
 		ip: request.connection.remoteAddress,
@@ -58,6 +62,9 @@ function logRequest(request) {
 	});
 }
 
+/**
+ * @type {import('http').RequestListener}
+ */
 function handler(request, response) {
 	try {
 		handleRequest(request, response);
@@ -71,11 +78,19 @@ function handler(request, response) {
 const boardTemplate = new templating.BoardTemplate(path.join(config.WEBROOT, 'board.html'));
 const indexTemplate = new templating.Template(path.join(config.WEBROOT, 'index.html'));
 
+/**
+ * Throws an error if the given board name is not allowed
+ * @param {string} boardName 
+ * @throws {Error}
+ */
 function validateBoardName(boardName) {
 	if (/^[\w%\-_~()]*$/.test(boardName)) return boardName;
 	throw new Error("Illegal board name: " + boardName);
 }
 
+/**
+ * @type {import('http').RequestListener}
+ */
 function handleRequest(request, response) {
 	var parsedUrl = url.parse(request.url, true);
 	var parts = parsedUrl.pathname.split('/');

server/sockets.js

@@ -8,6 +8,14 @@ var iolib = require('socket.io')
 */
 var boards = {};
 
+/**
+ * Prevents a function from throwing errors.
+ * If the inner function throws, the outer function just returns undefined
+ * and logs the error.
+ * @template A
+ * @param {A} fn 
+ * @returns {A}
+ */
 function noFail(fn) {
 	return function noFailWrapped(arg) {
 		try {
@@ -43,6 +51,10 @@ function getBoard(name) {
  */
 function socketConnection(socket) {
 
+	/**
+	 * Function to call when an user joins a board
+	 * @param {string} name 
+	 */
 	async function joinBoard(name) {
 		// Default to the public board
 		if (!name) name = "anonymous";