Added JSDoc to ESLint (#3529)

* Added JSDoc to eslint rules Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com> * Fixed JSDoc eslint errors Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com> * Update the check-linters workflow to Node.js 20 --------- Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com> Co-authored-by: Louis Lam <louislam@users.noreply.github.com>
2025-08-09 04:40:56 +08:00 · 2023-08-11 09:46:41 +02:00
parent da4f4e3d76
commit 8a92054c2b
153 changed files with 1505 additions and 574 deletions
--- a/server/model/api_key.js
+++ b/server/model/api_key.js
@@ -19,7 +19,7 @@ class APIKey extends BeanModel {

    /**
     * Returns an object that ready to parse to JSON
-     * @returns {Object}
+     * @returns {object} Object ready to parse
     */
    toJSON() {
        return {
@@ -37,7 +37,7 @@ class APIKey extends BeanModel {
    /**
     * Returns an object that ready to parse to JSON with sensitive fields
     * removed
-     * @returns {Object}
+     * @returns {object} Object ready to parse
     */
    toPublicJSON() {
        return {
@@ -53,9 +53,9 @@ class APIKey extends BeanModel {

    /**
     * Create a new API Key and store it in the database
-     * @param {Object} key Object sent by client
+     * @param {object} key Object sent by client
     * @param {int} userID ID of socket user
-     * @returns {Promise<bean>}
+     * @returns {Promise<bean>} API key
     */
    static async save(key, userID) {
        let bean;
--- a/server/model/docker_host.js
+++ b/server/model/docker_host.js
@@ -3,7 +3,7 @@ const { BeanModel } = require("redbean-node/dist/bean-model");
 class DockerHost extends BeanModel {
    /**
     * Returns an object that ready to parse to JSON
-     * @returns {Object}
+     * @returns {object} Object ready to parse
     */
    toJSON() {
        return {
--- a/server/model/group.js
+++ b/server/model/group.js
@@ -4,10 +4,12 @@ const { R } = require("redbean-node");
 class Group extends BeanModel {

    /**
-     * Return an object that ready to parse to JSON for public
-     * Only show necessary data to public
-     * @param {boolean} [showTags=false] Should the JSON include monitor tags
-     * @returns {Object}
+     * Return an object that ready to parse to JSON for public Only show
+     * necessary data to public
+     * @param {boolean} showTags Should the JSON include monitor tags
+     * @param {boolean} certExpiry Should JSON include info about
+     * certificate expiry?
+     * @returns {object} Object ready to parse
     */
    async toPublicJSON(showTags = false, certExpiry = false) {
        let monitorBeanList = await this.getMonitorList();
@@ -27,7 +29,7 @@ class Group extends BeanModel {

    /**
     * Get all monitors
-     * @returns {Bean[]}
+     * @returns {Bean[]} List of monitors
     */
    async getMonitorList() {
        return R.convertToBeans("monitor", await R.getAll(`
--- a/server/model/heartbeat.js
+++ b/server/model/heartbeat.js
@@ -12,7 +12,7 @@ class Heartbeat extends BeanModel {
    /**
     * Return an object that ready to parse to JSON for public
     * Only show necessary data to public
-     * @returns {Object}
+     * @returns {object} Object ready to parse
     */
    toPublicJSON() {
        return {
@@ -25,7 +25,7 @@ class Heartbeat extends BeanModel {

    /**
     * Return an object that ready to parse to JSON
-     * @returns {Object}
+     * @returns {object} Object ready to parse
     */
    toJSON() {
        return {
--- a/server/model/incident.js
+++ b/server/model/incident.js
@@ -5,7 +5,7 @@ class Incident extends BeanModel {
    /**
     * Return an object that ready to parse to JSON for public
     * Only show necessary data to public
-     * @returns {Object}
+     * @returns {object} Object ready to parse
     */
    toPublicJSON() {
        return {
--- a/server/model/maintenance.js
+++ b/server/model/maintenance.js
@@ -11,7 +11,7 @@ class Maintenance extends BeanModel {
    /**
     * Return an object that ready to parse to JSON for public
     * Only show necessary data to public
-     * @returns {Object}
+     * @returns {object} Object ready to parse
     */
    async toPublicJSON() {

@@ -98,7 +98,7 @@ class Maintenance extends BeanModel {
    /**
     * Return an object that ready to parse to JSON
     * @param {string} timezone If not specified, the timeRange will be in UTC
-     * @returns {Object}
+     * @returns {object} Object ready to parse
     */
    async toJSON(timezone = null) {
        return this.toPublicJSON(timezone);
@@ -142,7 +142,7 @@ class Maintenance extends BeanModel {
    /**
     * Convert data from socket to bean
     * @param {Bean} bean Bean to fill in
-     * @param {Object} obj Data to fill bean with
+     * @param {object} obj Data to fill bean with
     * @returns {Bean} Filled bean
     */
    static async jsonToBean(bean, obj) {
@@ -188,7 +188,7 @@ class Maintenance extends BeanModel {

    /**
     * Throw error if cron is invalid
-     * @param cron
+     * @param {string|Date} cron Pattern or date
     * @returns {Promise<void>}
     */
    static async validateCron(cron) {
@@ -198,6 +198,8 @@ class Maintenance extends BeanModel {

    /**
     * Run the cron
+     * @param {boolean} throwError Should an error be thrown on failure
+     * @returns {Promise<void>}
     */
    async run(throwError = false) {
        if (this.beanMeta.job) {
@@ -290,6 +292,10 @@ class Maintenance extends BeanModel {
        }
    }

+    /**
+     * Get timeslots where maintenance is running
+     * @returns {object|null} Maintenance time slot
+     */
    getRunningTimeslot() {
        let start = dayjs(this.beanMeta.job.nextRun(dayjs().add(-this.duration, "second").toDate()));
        let end = start.add(this.duration, "second");
@@ -305,6 +311,10 @@ class Maintenance extends BeanModel {
        }
    }

+    /**
+     * Stop the maintenance
+     * @returns {void}
+     */
    stop() {
        if (this.beanMeta.job) {
            this.beanMeta.job.stop();
@@ -312,10 +322,18 @@ class Maintenance extends BeanModel {
        }
    }

+    /**
+     * Is this maintenance currently active
+     * @returns {boolean} The maintenance is active?
+     */
    async isUnderMaintenance() {
        return (await this.getStatus()) === "under-maintenance";
    }

+    /**
+     * Get the timezone of the maintenance
+     * @returns {string} timezone
+     */
    async getTimezone() {
        if (!this.timezone || this.timezone === "SAME_AS_SERVER") {
            return await UptimeKumaServer.getInstance().getTimezone();
@@ -323,10 +341,18 @@ class Maintenance extends BeanModel {
        return this.timezone;
    }

+    /**
+     * Get offset for timezone
+     * @returns {string} offset
+     */
    async getTimezoneOffset() {
        return dayjs.tz(dayjs(), await this.getTimezone()).format("Z");
    }

+    /**
+     * Get the current status of the maintenance
+     * @returns {string} Current status
+     */
    async getStatus() {
        if (!this.active) {
            return "inactive";
--- a/server/model/monitor.js
+++ b/server/model/monitor.js
@@ -34,9 +34,12 @@ const Database = require("../database");
 class Monitor extends BeanModel {

    /**
-     * Return an object that ready to parse to JSON for public
-     * Only show necessary data to public
-     * @returns {Object}
+     * Return an object that ready to parse to JSON for public Only show
+     * necessary data to public
+     * @param {boolean} showTags Include tags in JSON
+     * @param {boolean} certExpiry Include certificate expiry info in
+     * JSON
+     * @returns {object} Object ready to parse
     */
    async toPublicJSON(showTags = false, certExpiry = false) {
        let obj = {
@@ -65,7 +68,9 @@ class Monitor extends BeanModel {

    /**
     * Return an object that ready to parse to JSON
-     * @returns {Object}
+     * @param {boolean} includeSensitiveData Include sensitive data in
+     * JSON
+     * @returns {object} Object ready to parse
     */
    async toJSON(includeSensitiveData = true) {

@@ -183,9 +188,9 @@ class Monitor extends BeanModel {
    }

    /**
-	 * Checks if the monitor is active based on itself and its parents
-	 * @returns {Promise<Boolean>}
-	 */
+     * Checks if the monitor is active based on itself and its parents
+     * @returns {Promise<boolean>} Is the monitor active?
+     */
    async isActive() {
        const parentActive = await Monitor.isParentActive(this.id);

@@ -194,7 +199,8 @@ class Monitor extends BeanModel {

    /**
     * Get all tags applied to this monitor
-     * @returns {Promise<LooseObject<any>[]>}
+     * @returns {Promise<LooseObject<any>[]>} List of tags on the
+     * monitor
     */
    async getTags() {
        return await R.getAll("SELECT mt.*, tag.name, tag.color FROM monitor_tag mt JOIN tag ON mt.tag_id = tag.id WHERE mt.monitor_id = ? ORDER BY tag.name", [ this.id ]);
@@ -203,7 +209,8 @@ class Monitor extends BeanModel {
    /**
     * Gets certificate expiry for this monitor
     * @param {number} monitorID ID of monitor to send
-     * @returns {Promise<LooseObject<any>>}
+     * @returns {Promise<LooseObject<any>>} Certificate expiry info for
+     * monitor
     */
    async getCertExpiry(monitorID) {
        let tlsInfoBean = await R.findOne("monitor_tls_info", "monitor_id = ?", [
@@ -228,7 +235,9 @@ class Monitor extends BeanModel {
    /**
     * Encode user and password to Base64 encoding
     * for HTTP "basic" auth, as per RFC-7617
-     * @returns {string}
+     * @param {string} user Username to encode
+     * @param {string} pass Password to encode
+     * @returns {string} Encoded username:password
     */
    encodeBase64(user, pass) {
        return Buffer.from(user + ":" + pass).toString("base64");
@@ -236,7 +245,7 @@ class Monitor extends BeanModel {

    /**
     * Is the TLS expiry notification enabled?
-     * @returns {boolean}
+     * @returns {boolean} Enabled?
     */
    isEnabledExpiryNotification() {
        return Boolean(this.expiryNotification);
@@ -244,7 +253,7 @@ class Monitor extends BeanModel {

    /**
     * Parse to boolean
-     * @returns {boolean}
+     * @returns {boolean} Should TLS errors be ignored?
     */
    getIgnoreTls() {
        return Boolean(this.ignoreTls);
@@ -252,7 +261,7 @@ class Monitor extends BeanModel {

    /**
     * Parse to boolean
-     * @returns {boolean}
+     * @returns {boolean} Is the monitor in upside down mode?
     */
    isUpsideDown() {
        return Boolean(this.upsideDown);
@@ -260,7 +269,7 @@ class Monitor extends BeanModel {

    /**
     * Parse to boolean
-     * @returns {boolean}
+     * @returns {boolean} Invert keyword match?
     */
    isInvertKeyword() {
        return Boolean(this.invertKeyword);
@@ -268,7 +277,7 @@ class Monitor extends BeanModel {

    /**
     * Parse to boolean
-     * @returns {boolean}
+     * @returns {boolean} Enable TLS for gRPC?
     */
    getGrpcEnableTls() {
        return Boolean(this.grpcEnableTls);
@@ -276,7 +285,7 @@ class Monitor extends BeanModel {

    /**
     * Get accepted status codes
-     * @returns {Object}
+     * @returns {object} Accepted status codes
     */
    getAcceptedStatuscodes() {
        return JSON.parse(this.accepted_statuscodes_json);
@@ -289,6 +298,7 @@ class Monitor extends BeanModel {
    /**
     * Start monitor
     * @param {Server} io Socket server instance
+     * @returns {void}
     */
    start(io) {
        let previousBeat = null;
@@ -980,7 +990,10 @@ class Monitor extends BeanModel {

        };

-        /** Get a heartbeat and handle errors */
+        /**
+         * Get a heartbeat and handle errors7
+         * @returns {void}
+         */
        const safeBeat = async () => {
            try {
                await beat();
@@ -1008,10 +1021,10 @@ class Monitor extends BeanModel {

    /**
     * Make a request using axios
-     * @param {Object} options Options for Axios
+     * @param {object} options Options for Axios
     * @param {boolean} finalCall Should this be the final call i.e
-     * don't retry on faliure
-     * @returns {Object} Axios response
+     * don't retry on failure
+     * @returns {object} Axios response
     */
    async makeAxiosRequest(options, finalCall = false) {
        try {
@@ -1046,7 +1059,10 @@ class Monitor extends BeanModel {
        }
    }

-    /** Stop monitor */
+    /**
+     * Stop monitor
+     * @returns {void}
+     */
    stop() {
        clearTimeout(this.heartbeatInterval);
        this.isStop = true;
@@ -1056,7 +1072,7 @@ class Monitor extends BeanModel {

    /**
     * Get prometheus instance
-     * @returns {Prometheus|undefined}
+     * @returns {Prometheus|undefined} Current prometheus instance
     */
    getPrometheus() {
        return this.prometheus;
@@ -1066,7 +1082,7 @@ class Monitor extends BeanModel {
     * Helper Method:
     * returns URL object for further usage
     * returns null if url is invalid
-     * @returns {(null|URL)}
+     * @returns {(null|URL)} Monitor URL
     */
    getUrl() {
        try {
@@ -1078,8 +1094,8 @@ class Monitor extends BeanModel {

    /**
     * Store TLS info to database
-     * @param checkCertificateResult
-     * @returns {Promise<Object>}
+     * @param {object} checkCertificateResult Certificate to update
+     * @returns {Promise<object>} Updated certificate
     */
    async updateTlsInfo(checkCertificateResult) {
        let tlsInfoBean = await R.findOne("monitor_tls_info", "monitor_id = ?", [
@@ -1126,6 +1142,7 @@ class Monitor extends BeanModel {
     * @param {Server} io Socket server instance
     * @param {number} monitorID ID of monitor to send
     * @param {number} userID ID of user to send to
+     * @returns {void}
     */
    static async sendStats(io, monitorID, userID) {
        const hasClients = getTotalClientInRoom(io, userID) > 0;
@@ -1143,6 +1160,10 @@ class Monitor extends BeanModel {
    /**
     * Send the average ping to user
     * @param {number} duration Hours
+     * @param {Server} io Socket instance to send data to
+     * @param {number} monitorID ID of monitor to read
+     * @param {number} userID ID of user to send data to
+     * @returns {void}
     */
    static async sendAvgPing(duration, io, monitorID, userID) {
        const timeLogger = new TimeLogger();
@@ -1168,6 +1189,7 @@ class Monitor extends BeanModel {
     * @param {Server} io Socket server instance
     * @param {number} monitorID ID of monitor to send
     * @param {number} userID ID of user to send to
+     * @returns {void}
     */
    static async sendCertInfo(io, monitorID, userID) {
        let tlsInfo = await R.findOne("monitor_tls_info", "monitor_id = ?", [
@@ -1184,6 +1206,8 @@ class Monitor extends BeanModel {
     * https://www.uptrends.com/support/kb/reporting/calculation-of-uptime-and-downtime
     * @param {number} duration Hours
     * @param {number} monitorID ID of monitor to calculate
+     * @param {boolean} forceNoCache Should the uptime be recalculated?
+     * @returns {number} Uptime of monitor
     */
    static async calcUptime(duration, monitorID, forceNoCache = false) {

@@ -1264,6 +1288,7 @@ class Monitor extends BeanModel {
     * @param {Server} io Socket server instance
     * @param {number} monitorID ID of monitor to send
     * @param {number} userID ID of user to send to
+     * @returns {void}
     */
    static async sendUptime(duration, io, monitorID, userID) {
        const uptime = await this.calcUptime(duration, monitorID);
@@ -1338,6 +1363,7 @@ class Monitor extends BeanModel {
     * @param {boolean} isFirstBeat Is this beat the first of this monitor?
     * @param {Monitor} monitor The monitor to send a notificaton about
     * @param {Bean} bean Status information about monitor
+     * @returns {void}
     */
    static async sendNotification(isFirstBeat, monitor, bean) {
        if (!isFirstBeat || bean.status === DOWN) {
@@ -1378,7 +1404,7 @@ class Monitor extends BeanModel {
    /**
     * Get list of notification providers for a given monitor
     * @param {Monitor} monitor Monitor to get notification providers for
-     * @returns {Promise<LooseObject<any>[]>}
+     * @returns {Promise<LooseObject<any>[]>} List of notifications
     */
    static async getNotificationList(monitor) {
        let notificationList = await R.getAll("SELECT notification.* FROM notification, monitor_notification WHERE monitor_id = ? AND monitor_notification.notification_id = notification.id ", [
@@ -1389,7 +1415,8 @@ class Monitor extends BeanModel {

    /**
     * checks certificate chain for expiring certificates
-     * @param {Object} tlsInfoObject Information about certificate
+     * @param {object} tlsInfoObject Information about certificate
+     * @returns {void}
     */
    async checkCertExpiryNotifications(tlsInfoObject) {
        if (tlsInfoObject && tlsInfoObject.certInfo && tlsInfoObject.certInfo.daysRemaining) {
@@ -1476,7 +1503,7 @@ class Monitor extends BeanModel {
    /**
     * Get the status of the previous heartbeat
     * @param {number} monitorID ID of monitor to check
-     * @returns {Promise<LooseObject<any>>}
+     * @returns {Promise<LooseObject<any>>} Previous heartbeat
     */
    static async getPreviousHeartbeat(monitorID) {
        return await R.getRow(`
@@ -1490,7 +1517,7 @@ class Monitor extends BeanModel {
    /**
     * Check if monitor is under maintenance
     * @param {number} monitorID ID of monitor to check
-     * @returns {Promise<boolean>}
+     * @returns {Promise<boolean>} Is the monitor under maintenance
     */
    static async isUnderMaintenance(monitorID) {
        const maintenanceIDList = await R.getCol(`
@@ -1513,7 +1540,11 @@ class Monitor extends BeanModel {
        return false;
    }

-    /** Make sure monitor interval is between bounds */
+    /**
+     * Make sure monitor interval is between bounds
+     * @returns {void}
+     * @throws Interval is outside of range
+     */
    validate() {
        if (this.interval > MAX_INTERVAL_SECOND) {
            throw new Error(`Interval cannot be more than ${MAX_INTERVAL_SECOND} seconds`);
@@ -1526,7 +1557,7 @@ class Monitor extends BeanModel {
    /**
     * Gets Parent of the monitor
     * @param {number} monitorID ID of monitor to get
-     * @returns {Promise<LooseObject<any>>}
+     * @returns {Promise<LooseObject<any>>} Parent
     */
    static async getParent(monitorID) {
        return await R.getRow(`
@@ -1542,7 +1573,7 @@ class Monitor extends BeanModel {
    /**
     * Gets all Children of the monitor
     * @param {number} monitorID ID of monitor to get
-     * @returns {Promise<LooseObject<any>>}
+     * @returns {Promise<LooseObject<any>>} Children
     */
    static async getChildren(monitorID) {
        return await R.getAll(`
@@ -1555,7 +1586,7 @@ class Monitor extends BeanModel {

    /**
     * Gets Full Path-Name (Groups and Name)
-     * @returns {Promise<String>}
+     * @returns {Promise<string>} Full path name of this monitor
     */
    async getPathName() {
        let path = this.name;
@@ -1575,8 +1606,8 @@ class Monitor extends BeanModel {

    /**
     * Gets recursive all child ids
-	 * @param {number} monitorID ID of the monitor to get
-     * @returns {Promise<Array>}
+     * @param {number} monitorID ID of the monitor to get
+     * @returns {Promise<Array>} IDs of all children
     */
    static async getAllChildrenIDs(monitorID) {
        const childs = await Monitor.getChildren(monitorID);
@@ -1607,10 +1638,10 @@ class Monitor extends BeanModel {
    }

    /**
-	 * Checks recursive if parent (ancestors) are active
-	 * @param {number} monitorID ID of the monitor to get
-	 * @returns {Promise<Boolean>}
-	 */
+     * Checks recursive if parent (ancestors) are active
+     * @param {number} monitorID ID of the monitor to get
+     * @returns {Promise<boolean>} Is the parent monitor active?
+     */
    static async isParentActive(monitorID) {
        const parent = await Monitor.getParent(monitorID);

--- a/server/model/proxy.js
+++ b/server/model/proxy.js
@@ -3,7 +3,7 @@ const { BeanModel } = require("redbean-node/dist/bean-model");
 class Proxy extends BeanModel {
    /**
     * Return an object that ready to parse to JSON
-     * @returns {Object}
+     * @returns {object} Object ready to parse
     */
    toJSON() {
        return {
--- a/server/model/status_page.js
+++ b/server/model/status_page.js
@@ -14,10 +14,11 @@ class StatusPage extends BeanModel {
    static domainMappingList = { };

    /**
-     *
-     * @param {Response} response
-     * @param {string} indexHTML
-     * @param {string} slug
+     * Handle responses to status page
+     * @param {Response} response Response object
+     * @param {string} indexHTML HTML to render
+     * @param {string} slug Status page slug
+     * @returns {void}
     */
    static async handleStatusPageResponse(response, indexHTML, slug) {
        let statusPage = await R.findOne("status_page", " slug = ? ", [
@@ -33,8 +34,9 @@ class StatusPage extends BeanModel {

    /**
     * SSR for status pages
-     * @param {string} indexHTML
-     * @param {StatusPage} statusPage
+     * @param {string} indexHTML HTML page to render
+     * @param {StatusPage} statusPage Status page populate HTML with
+     * @returns {void}
     */
    static async renderHTML(indexHTML, statusPage) {
        const $ = cheerio.load(indexHTML);
@@ -87,7 +89,8 @@ class StatusPage extends BeanModel {

    /**
     * Get all status page data in one call
-     * @param {StatusPage} statusPage
+     * @param {StatusPage} statusPage Status page to get data for
+     * @returns {object} Status page data
     */
    static async getStatusPageData(statusPage) {
        const config = await statusPage.toPublicJSON();
@@ -142,7 +145,7 @@ class StatusPage extends BeanModel {
     * Send status page list to client
     * @param {Server} io io Socket server instance
     * @param {Socket} socket Socket.io instance
-     * @returns {Promise<Bean[]>}
+     * @returns {Promise<Bean[]>} Status page list
     */
    static async sendStatusPageList(io, socket) {
        let result = {};
@@ -159,7 +162,7 @@ class StatusPage extends BeanModel {

    /**
     * Update list of domain names
-     * @param {string[]} domainNameList
+     * @param {string[]} domainNameList List of status page domains
     * @returns {Promise<void>}
     */
    async updateDomainNameList(domainNameList) {
@@ -203,7 +206,7 @@ class StatusPage extends BeanModel {

    /**
     * Get list of domain names
-     * @returns {Object[]}
+     * @returns {object[]} List of status page domains
     */
    getDomainNameList() {
        let domainList = [];
@@ -219,7 +222,7 @@ class StatusPage extends BeanModel {

    /**
     * Return an object that ready to parse to JSON
-     * @returns {Object}
+     * @returns {object} Object ready to parse
     */
    async toJSON() {
        return {
@@ -243,7 +246,7 @@ class StatusPage extends BeanModel {
    /**
     * Return an object that ready to parse to JSON for public
     * Only show necessary data to public
-     * @returns {Object}
+     * @returns {object} Object ready to parse
     */
    async toPublicJSON() {
        return {
@@ -264,7 +267,8 @@ class StatusPage extends BeanModel {

    /**
     * Convert slug to status page ID
-     * @param {string} slug
+     * @param {string} slug Status page slug
+     * @returns {Promise<number>} ID of status page
     */
    static async slugToID(slug) {
        return await R.getCell("SELECT id FROM status_page WHERE slug = ? ", [
@@ -274,7 +278,7 @@ class StatusPage extends BeanModel {

    /**
     * Get path to the icon for the page
-     * @returns {string}
+     * @returns {string} Path
     */
    getIcon() {
        if (!this.icon) {
@@ -287,7 +291,7 @@ class StatusPage extends BeanModel {
    /**
     * Get list of maintenances
     * @param {number} statusPageId ID of status page to get maintenance for
-     * @returns {Object} Object representing maintenances sanitized for public
+     * @returns {object} Object representing maintenances sanitized for public
     */
    static async getMaintenanceList(statusPageId) {
        try {
--- a/server/model/tag.js
+++ b/server/model/tag.js
@@ -4,7 +4,7 @@ class Tag extends BeanModel {

    /**
     * Return an object that ready to parse to JSON
-     * @returns {Object}
+     * @returns {object} Object ready to parse
     */
    toJSON() {
        return {
--- a/server/model/user.js
+++ b/server/model/user.js
@@ -7,7 +7,7 @@ class User extends BeanModel {
     * Reset user password
     * Fix #1510, as in the context reset-password.js, there is no auto model mapping. Call this static function instead.
     * @param {number} userID ID of user to update
-     * @param {string} newPassword
+     * @param {string} newPassword Users new password
     * @returns {Promise<void>}
     */
    static async resetPassword(userID, newPassword) {
@@ -19,7 +19,7 @@ class User extends BeanModel {

    /**
     * Reset this users password
-     * @param {string} newPassword
+     * @param {string} newPassword Users new password
     * @returns {Promise<void>}
     */
    async resetPassword(newPassword) {