ric/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-12-04 12:14:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

chore: add jsdocs for missing functions

Browse source
This commit is contained in:
Gero Gerke 2023-01-10 10:47:24 +01:00
parent 1b5ea7d44e
commit 98d8598052
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
server/model/monitor.js
View file

@ -26,6 +26,10 @@ const { UptimeCacheList } = require("../uptime-cache-list");
*/ */
class Monitor extends BeanModel { class Monitor extends BeanModel {
/**
* Formats the status code to a human readable form
* @returns {string} a human readable string that corresponds to the status code
*/
statusToKey(status) { statusToKey(status) {
switch (status) { switch (status) {
case 0: return "down"; case 0: return "down";
@ -39,10 +43,10 @@ class Monitor extends BeanModel {
/** /**
* Return an object that ready to parse to JSON for public * Return an object that ready to parse to JSON for public
* Only show necessary data to public * Only show necessary data to public
* @param {boolean} [includeStatus = false] Should the JSON include the status * @param {boolean} [showStatus = false] Should the JSON show the status
* @returns {Object} * @returns {Object}
*/ */
async toPublicJSON(showTags = false, includeStatus = false) { async toPublicJSON(showTags = false, showStatus = false) {
let obj = { let obj = {
id: this.id, id: this.id,
name: this.name, name: this.name,
@ -58,7 +62,7 @@ class Monitor extends BeanModel {
obj.tags = await this.getTags(); obj.tags = await this.getTags();
} }
if (includeStatus) { if (showStatus) {
const heartbeat = await Monitor.getPreviousHeartbeat(this.id); const heartbeat = await Monitor.getPreviousHeartbeat(this.id);
obj.status = this.statusToKey(heartbeat.status); obj.status = this.statusToKey(heartbeat.status);
} }