diff --git a/server/model/user.js b/server/model/user.js index d68f189ce..2dd3c51ed 100644 --- a/server/model/user.js +++ b/server/model/user.js @@ -31,9 +31,9 @@ class User extends BeanModel { /** * Create a new JWT for a user - * @param {User} user - * @param {string} jwtSecret - * @return {string} + * @param {User} user The User to create a JsonWebToken for + * @param {string} jwtSecret The key used to sign the JsonWebToken + * @returns {string} the JsonWebToken as a string */ static createJWT(user, jwtSecret) { return jwt.sign({ diff --git a/server/server.js b/server/server.js index c53755a6c..2b9bed170 100644 --- a/server/server.js +++ b/server/server.js @@ -81,7 +81,7 @@ const Monitor = require("./model/monitor"); const User = require("./model/user"); log.debug("server", "Importing Settings"); -const { getSettings, setSettings, setting, initJWTSecret, checkLogin, startUnitTest, FBSD, doubleCheckPassword, startE2eTests, shake256, SHAKE256_LENGTH, allowDevAllOrigin, +const { getSettings, setSettings, setting, initJWTSecret, checkLogin, FBSD, doubleCheckPassword, startE2eTests, shake256, SHAKE256_LENGTH, allowDevAllOrigin, } = require("./util-server"); log.debug("server", "Importing Notification"); diff --git a/server/util-server.js b/server/util-server.js index 06c77eb4e..5f47561c0 100644 --- a/server/util-server.js +++ b/server/util-server.js @@ -1066,10 +1066,9 @@ module.exports.grpcQuery = async (options) => { module.exports.SHAKE256_LENGTH = 16; /** - * - * @param {string} data - * @param {number} len - * @return {string} + * @param {string} data The data to be hashed + * @param {number} len Output length of the hash + * @returns {string} The hashed data in hex format */ module.exports.shake256 = (data, len) => { if (!data) {